HyperTrack

HyperTrack Orders API

The Orders API from HyperTrack — 32 operation(s) for orders.

GitHub OpenAPI
Business capability
Last-Mile Delivery Operations Management BC-2420.40

Operations 41

GET /orders/ Get Orders
POST /orders/ Batch and Sequence Orders
POST /orders/track Track Orders
GET /orders/plans Get Plans
GET /orders/plans/ Get Plans
POST /orders/export Create an order export job
GET /orders/routes/ Get Routes
POST /orders/routes/ Create Route
GET /orders/estimate Estimate Route
GET /orders/{order_handle} Get Order Timeline
PATCH /orders/{order_handle} Update Order
GET /orders/plans/{plan_id} Get Plan
GET /orders/export/{job_id} Get export job status
GET /orders/tasks-definitions Get Tasks Definitions List
POST /orders/tasks-definitions Create Tasks Definition
GET /orders/{order_handle}/tasks List Order Tasks
POST /orders/{order_handle}/tasks Create Order Tasks
POST /orders/{order_handle}/events Add Custom Order Events
POST /orders/{order_handle}/cancel Cancel Order
POST /orders/{order_handle}/enable Enable Order
GET /orders/routes/{route_handle} Get Order by Route Handle
PATCH /orders/routes/{route_handle} Update Route
POST /orders/{order_handle}/disable Disable Order
GET /orders/{order_handle}/webhooks Get Order Webhooks
POST /orders/{order_handle}/complete Complete Order
POST /orders/{order_handle}/reassign Reassign Order
POST /orders/plans/{plan_id}/trigger Trigger Planning for a Plan
POST /orders/{order_handle}/reschedule Reschedule Order
POST /orders/routes/{route_handle}/add Add Order
POST /orders/routes/{route_handle}/remove Remove Order
POST /orders/routes/{route_handle}/complete Complete Route
POST /orders/routes/{route_handle}/reassign Reassign Route
POST /orders/routes/{route_handle}/optimise Optimise Orders Sequence
PATCH /orders/{order_handle}/tasks/{task_id} Update Order Task
DELETE /orders/{order_handle}/tasks/{task_id} Delete Order Task
GET /orders/{order_handle}/candidate_workers Get Candidate Workers
POST /orders/routes/{route_handle}/resequence Resequence Orders
GET /orders/estimated-routes/{estimated_route_id} Get estimated route polyline
GET /orders/tasks-definitions/{task_definition_id} Get Tasks Definition
PATCH /orders/tasks-definitions/{task_definition_id} Update Tasks Definition
DELETE /orders/tasks-definitions/{task_definition_id} Delete Tasks Definition

Documentation

📖
Documentation
https://hypertrack.com/docs/introduction
📖
APIReference
https://hypertrack.com/reference/get-orders
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/authentication/hypertrack-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/openapi/hypertrack-orders-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/errors/hypertrack-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/data-model/hypertrack-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/conventions/hypertrack-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/conventions/hypertrack-conventions.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/asyncapi/hypertrack-events-webhooks.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/mcp/hypertrack-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/hypertrack-orders-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hypertrack-orders-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HyperTrack Orders API
  version: '1.0'
  description: HyperTrack API Reference — Orders, Workers, Places, Routes, and more.
  contact:
    name: HyperTrack support
    url: https://hypertrack.com/contact
    email: help@hypertrack.com
servers:
- url: https://v3.api.hypertrack.com
tags:
- name: Orders
paths:
  /orders/:
    get:
      parameters:
      - in: query
        name: worker_handle
        description: Unique customer provided identifier of the worker to used retrieve orders associated with the specified worker
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: place_handle
        description: Unique customer provided identifier of the place to be used retrieve orders associated with the specified place
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: search_term
        description: String representing the search term. Search will be done on order_handle, ops_group_handle, worker_handle and metadata fields.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: ops_group_handle
        description: Unique Handle of Ops Group to fetch orders for
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: order_metadata_filter
        description: JSON encoded string for order metadata to filter orders by
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: risk_status
        description: Filter for risk status of order
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: region_filter
        description: JSON object containing `city`, `state`, or `country` used to filter orders
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: status
        description: String representation of Order status to fetch orders for. It can be comma separated list, each item in list can be one of `completed`, `cancelled`, `rescheduled`, `disabled`, `ongoing`, `unplanned`, `assigned`, `planned`. eg. `?status=completed,cancelled` or `?status=completed` to filter for one status
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: device_id
        description: Filter for orders associated with this device id.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: destination_geohash
        description: Geohash of the area where order destination must lie.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: plan_mode
        description: Mode of planning to be used to filter orders
        schema:
          enum:
          - on_demand
          - scheduled
          - manual
          - pool
        required: false
      - in: query
        name: plan_id
        description: Filter for orders in this plan id.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: route_handle
        description: Unique Handle of the route to fetch orders for
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: track_mode
        description: Tracking mode to filter orders by. See [pre_shift](https://hypertrack.com/docs/shift-tracking#pre-shift-tracking), [on_shift](https://hypertrack.com/docs/shift-tracking#on-shift-tracking) documentation. `full_shift` includes both pre-shift and on-shift tracking. Note that `on_time` and `flex` are deprecated modes.
        schema:
          enum:
          - on_time
          - flex
          - pre_shift
          - on_shift
          - full_shift
        required: false
      - in: query
        name: device_switch_mode
        description: Device switch mode to filter orders by.
        schema:
          enum:
          - manual
          - login
          - closest_to_destination
        required: false
      - in: query
        name: created_at_date
        description: Date (YYYY-MM-DD) used as a filter to retrieve orders that are created on a given date.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: created_at_from
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that created within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: created_at_to
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that created within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: planned_at_date
        description: Date (YYYY-MM-DD) used as a filter to retrieve orders that are planned on a given date.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: planned_at_from
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders planned within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: planned_at_to
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders planned within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: scheduled_at_date
        description: Date (YYYY-MM-DD) used as a filter to retrieve orders that are scheduled on a given date.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: scheduled_at_date_without_tz
        description: Date (YYYY-MM-DD) used as a filter to retrieve orders that are scheduled on a given date irrespective of timezone.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: completed_at_date_without_tz
        description: Date (YYYY-MM-DD) used as a filter to retrieve orders that are completed on a given date irrespective of timezone.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: scheduled_at_from
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders which have scheduled_at within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: scheduled_at_to
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that which have scheduled_at within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: scheduled_at_without_tz_from
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders of that day in all timezone.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: scheduled_at_without_tz_to
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders of that day in all timezone.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: cancelled_at_date
        description: Date (YYYY-MM-DD) used as a filter to retrieve orders that are cancelled on a given date.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: cancelled_at_from
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that cancelled within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: cancelled_at_to
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that cancelled within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: completed_at_date
        description: Date (YYYY-MM-DD) used as a filter to retrieve orders that are completed on a given date.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: completed_at_from
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that completed within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: completed_at_to
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that completed within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: rescheduled_marked_at_date
        description: Date (YYYY-MM-DD) used as a filter to retrieve orders that are rescheduled on a given date.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: rescheduled_marked_at_from
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders that rescheduled within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: rescheduled_marked_at_to
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders that rescheduled within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: route_started_at_date
        description: Date (YYYY-MM-DD) used as a filter to retrieve orders for which route started on a given date.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: route_started_at_from
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders for which route started within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: route_started_at_to
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders for which route started within a timeframe.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: completed_at_without_tz_from
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve orders of that day for all timezone for completed orders.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: completed_at_without_tz_to
        description: Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve orders of that day for all timezone for completed orders.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: created_at_without_tz_from
        description: Start Date (YYYY-MM-DD ) of the window to retrieve orders from that day for all timezone for created orders.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: created_at_without_tz_to
        description: End Date (YYYY-MM-DD ) of the window to retrieve orders till that day for all timezone for created orders.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: created_at_date_without_tz
        description: Date (YYYY-MM-DD) used as a filter to retrieve orders that are created on a given date irrespective of timezone.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: driver_handle
        description: Unique customer provided identifier of the driver to used retrieve orders associated with the specified driver
        schema:
          type:
          - string
          - 'null'
          deprecated: true
        required: false
      - in: query
        name: sort_direction
        description: String indicating the preferred sorting type
        schema:
          enum:
          - desc
          - asc
        required: false
      - in: query
        name: fulfillment_attempt
        description: Filter for fulfillment attempt number
        schema:
          type:
          - integer
          - 'null'
        required: false
      - in: query
        name: aggregate
        description: Flag to fetch order's aggregated data.
        schema:
          type:
          - boolean
          - 'null'
        required: false
      - in: query
        name: limit
        description: Limit to number of results in response
        schema:
          type:
          - integer
          - 'null'
        required: false
      - in: query
        name: pagination_token
        description: Encoded value provided by our API to retrieve the next page of orders
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: send_outage
        description: Boolean to send the outage in aggregation
        schema:
          type:
          - boolean
          - 'null'
        required: false
      - in: query
        name: tracking_status
        description: Parameter to filter for tracked and untracked orders
        schema:
          type:
          - string
          - 'null'
          enum:
          - tracked
          - untracked
        required: false
      - in: query
        name: filter_outage_category
        description: List of outage category as comma separated strings used for filtering associated orders within time range
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: worker_profile_filter
        description: JSON encoded string metadata associated with the worker to filter orders
        schema:
          type:
          - string
          - 'null'
          format: Encoded JSON
        required: false
      - in: query
        name: worker_inside_destination
        description: Boolean flag to filter orders based on whether the worker is inside the destination or not.
        schema:
          type:
          - boolean
          - 'null'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrdersResponse'
              examples:
                Filtered on date, ops_group_handle and status:
                  summary: Filtered on date, ops_group_handle and status
                  value:
                    orders:
                    - order_handle: order-1
                      fulfillment_attempt: 0
                      status: completed
                      destination:
                        geometry:
                          type: Point
                          coordinates:
                          - -121.9007247
                          - 37.3811932
                        address: 1028 E Brokaw Rd, San Jose, CA 95131
                        radius: 100
                      ops_group_handle: store-SF
                      track_mode: on_time
                      plan_mode: manual
                      scheduled_at: 2023-10-31 04:00:00+00:00
                      type: drop
                      type_index: 0
                      expected_service_time: 0
                      capacity_used: 1
                      metadata:
                        customerID: '12654'
                      region:
                        country: United States
                        city: San Jose
                        state: California
                      product_type:
                      - frozen
                      - fragile
                      completed_at: 2023-10-31 23:13:21.287000+00:00
                      device_id: 52193948-1A79-14GF-AB81-2FB0A59536S3
                      worker_handle: james@ht.com
                      created_at: 2023-10-30 23:41:47.489000+00:00
                      assigned_at: 2023-10-31 23:13:03.712000+00:00
                      route_handle: a3f6e79c-c830-4766-8a3d-9eeaa5099ce2
                Filtered on date, worker and status:
                  summary: Filtered on date, worker and status
                  value:
                    orders:
                    - order_handle: order-1
                      fulfillment_attempt: 0
                      status: completed
                      destination:
                        geometry:
                          type: Point
                          coordinates:
                          - -121.9007247
                          - 37.3811932
                        address: 1028 E Brokaw Rd, San Jose, CA 95131
                        radius: 100
                      ops_group_handle: store-SF
                      track_mode: on_time
                      plan_mode: manual
                      scheduled_at: 2023-10-31 04:00:00+00:00
                      type: drop
                      type_index: 0
                      expected_service_time: 0
                      capacity_used: 1
                      metadata:
                        customerID: '12654'
                      region:
                        country: United States
                        city: San Jose
                        state: California
                      product_type:
                      - frozen
                      - fragile
                      completed_at: 2023-10-31 23:13:21.287000+00:00
                      device_id: 52193948-1A79-14GF-AB81-2FB0A59536S3
                      worker_handle: james@ht.com
                      created_at: 2023-10-30 23:41:47.489000+00:00
                      assigned_at: 2023-10-31 23:13:03.712000+00:00
                      route_handle: a3f6e79c-c830-4766-8a3d-9eeaa5099ce2
                Filtered on date and status:
                  summary: Filtered on date and status
                  value:
                    orders:
                    - order_handle: order-1
                      fulfillment_attempt: 0
                      status: cancelled
                      destination:
                        geometry:
                          type: Point
                          coordinates:
                          - -121.8871193
                          - 37.390611
                        address: 1709 Automation Pkwy, San Jose, CA 95101
                        radius: 100
                      ops_group_handle: store-SF
                      track_mode: on_time
                      plan_mode: scheduled
                      scheduled_at: 2023-10-31 02:00:00+00:00
                      type: pick
                      type_index: 0
                      expected_service_time: 0
                      capacity_used: 1
                      metadata:
                        customerID: '12654'
                      region:
                        country: United States
                        city: San Jose
                        state: California
                      product_type:
                      - frozen
                      - fragile
                      cancelled_at: 2023-10-31 23:13:13.926000+00:00
                      device_id: 52393948-1A79-47CC-AB81-2FB0A59536D1
                      worker_handle: james@ht.com
                      created_at: 2023-10-30 23:42:28.655000+00:00
                      assigned_at: 2023-10-31 23:13:03.617000+00:00
                      route_handle: a3f6e79c-c830-4766-8a3d-9eeaa5099ce2
                      plan_id: a7a9c72e-bf31-44f5-8a59-c4fffb5fb9d4
                    - order_handle: order-2
                      fulfillment_attempt: 0
                      status: cancelled
                      destination:
                        geometry:
                          type: Point
                          coordinates:
                          - -121.8871193
                          - 37.390611
                        address: 1709 Automation Pkwy, San Jose, CA 95101
                        radius: 100
                      ops_group_handle: store-SF
                      track_mode: on_time
                      plan_mode: manual
                      scheduled_at: 2023-10-31 02:00:00+00:00
                      type: pick
                      type_index: 0
                      expected_service_time: 0
                      capacity_used: 1
                      metadata:
                        customerID: '12654'
                      region:
                        country: United States
                        city: San Jose
                        state: California
                      product_type:
                      - frozen
                      - fragile
                      cancelled_at: 2023-10-31 00:13:01.073000+00:00
                      created_at: 2023-10-30 23:41:47.489000+00:00
                      route_handle: afb94d64-2702-4efa-b938-d1facfd7832c
                    - order_handle: order-4
                      fulfillment_attempt: 0
                      status: cancelled
                      destination:
                        geometry:
                          type: Point
                          coordinates:
                          - -121.8970798
                          - 37.3838274
                        address: 1710 Old Oakland Rd, San Jose, CA 95131
                      ops_group_handle: store-SF
                      track_mode: on_time
                      plan_mode: manual
                      scheduled_after: 2023-10-31 02:00:00+00:00
                      scheduled_at: 2023-10-31 04:00:00+00:00
                      type: drop
                      type_index: 0
                      expected_service_time: 0
                      capacity_used: 1
                      metadata:
                        customerId: '1442'
                        name: Jordan
                      region:
                        country: United States
                        city: San Jose
                        state: California
                      product_type:
                      - frozen
                      - fragile
                      - valuable
                      cancelled_at: 2023-10-31 00:12:56.688000+00:00
                      created_at: 2023-10-30 22:22:54.071000+00:00
                      route_handle: afb94d64-2702-4efa-b938-d1facfd7832c
                Unplanned orders with planning failure reason:
                  summary: Unplanned orders with planning failure reason
                  value:
                    orders:
                    - order_handle: order-5
                      fulfillment_attempt: 0
                      status: unplanned
                      destination:
                        geometry:
                          type: Point
                          coordinates:
                          - -121.8970798
                          - 37.3838274
                        address: 1710 Old Oakland Rd, San Jose, CA 95131
                        radius: 100
                      ops_group_handle: store-SF
                      plan_mode: scheduled
                      plan_id: a7a9c72e-bf31-44f5-8a59-c4fffb5fb9d4
                      scheduled_after: 2023-10-31 02:00:00+00:00
                      scheduled_at: 2023-10-31 04:00:00+00:00
                      type: drop
                      expected_service_time: 0
                      capacity_used: 1
                      created_at: 2023-10-30 22:22:54.071000+00:00
                      planning_failure_reason: The optimizer dropped this order to satisfy planning constraints for the overall plan.
          description: Successful response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Authentication error
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: Validation error
      tags:
      - Orders
      summary: Get Orders
      description: '### Planning failure reasons


        When an order is left unplanned by automated planning, `planning_failure_reason` may contain one of these values:


        - `No Worker was available for this plan.`

        - `No Worker schedule overlaps with this order''s time window.`

        - `This order is outside the available Worker working hours.`

        - `Worker location is unavailable, so travel time could not be evaluated.`

        - `Worker start location is unavailable for the configured route start setting.`

        - `No Worker supports the required product type for this order.`

        - `Route was being modified concurrently and this order needs to be re-planned.`

        - `The optimizer dropped this order to satisfy planning constraints for the overall plan.`

        - `The optimizer could not find a feasible plan for the provided constraints.`

        - `Travel time calculation failed for this planning attempt.`

        - `Ops group configuration is incomplete for automated planning.`

        - `Assigning this order would exceed route or Worker capacity.`

        - `No Worker can reach this order before scheduled_at.`

        - `Assigning this order would delay an already planned downstream order.`

        - `Assigning this order would exceed the Worker''s shift end time.`

        - `Existing assigned route conflicts with the Worker schedule, so this order could not be inserted into the plan.`

        - `Existing assigned route exceeds the Worker''s shift, so this order could not be inserted into the plan.`

        - `Existing assigned route has conflicting appointment windows, so this order could not be inserted into the plan.`

        - `Existing assigned route exceeds route or Worker capacity, so this order could not be inserted into the plan.`

        - `Existing assigned route exceeds the configured maximum route distance, so this order could not be inserted into the plan.`

        - `Existing assigned routes were preserved, so this order could not be inserted into the plan.`

        - `Assigning this order would exceed the configured maximum route distance.`

        - `The optimizer reached its planning limit before it could assign this order.`

        - `Automated planning could not assign this order with the provided constraints.`'
      security:
      - BasicAuth: []
      - TokenAuth: []
    post:
      parameters: []
      responses:
        '201':
          description: One of OrderListResponse or PlanResponse
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/RouteDetail'
                - $ref: '#/components/schemas/PlanResponse'
                - $ref: '#/components/schemas/OrderListResponse'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Authentication error
        '409':
          description: Conflict - Planning request already executing for one of the orders
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: Validation error
      tags:
      - Orders
      summary: Batch and Sequence Orders
      description: Post a sequence of orders to be planned either manually or automatically by HyperTrack. For automatic planning, please contact the HyperTrack team to get set up.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchOrdersRequest'
            examples:
              Orders for manual planning without worker_handle:
                summary: Create orders for to be planned manually.
                value:
                  plan_mode: manual
                  ops_group_handle: store-SF
                  orders:
                  - order_handle: order-1
                    scheduled_at: 2023-10-31 02:00:00+00:00
                    product_type:
                    - frozen
                    - fragile
                    type: pick
                    metadata:
                      customerID: '12654'
                    destination:
                      address: 1709 Automation Pkwy, San Jose, CA 95101
                      geometry:
                        type: Point
                        coordinates:
                        - -121.8871193
                        - 37.390611
                      radius: 100
                  - order_handle: order-2
                    scheduled_at: 2023-10-31 04:00:00+00:00
                    product_type:
                    - frozen
                    - fragile
                    type: drop
                    metadata:
                      customerID: '12654'
                    destination:
                      address: 1028 E Brokaw Rd, San Jose, CA 95131
                      geometry:
                        type: Point
                        coordinates:
                        - -121.9007247
                        - 37.3811932
                      radius: 100
              Orders for manual planning with worker_handle:
                summary: Create orders for to be planned manually when worker handle has been provided.
                value:
                  plan_mode: manual
                  ops_group_handle: store-SF
                  worker_handle: test_driver
                  orders:
                  - order_handle: order-1
                    scheduled_at: 2023-10-31 02:00:00+00:00
                    product_type:
                    - frozen
                    - fragile
                    type: pick
                    metadata:
                      customerID: '12654'
                    destination:
                      address: 1709 Automation Pkwy, San Jose, CA 95101
                      geometry:
                        type: Point
                        coordinates:
                        - -121.8871193
                        - 37.390611
                      radius: 100
                  - order_handle: order-2
                    scheduled_at: 2023-10-31 04:00:00+00:00
                    product_type:
                    - frozen
                    - fragile
                    type: drop
                    metadata:
                      customerID: '12654'
                    destination:
                      address: 1028 E Brokaw Rd, San Jose, CA 95131
                      geometry:
                        type: Point
                        coordinates:
                        - -121.9007247
                        - 37.3811932
                      radius: 100
              Orders for on demand planning without worker_handle:
                summary: Create orders for to be planned manually.
                value:
                  plan_mode: on_demand
                  ops_group_handle: store-SF
                  orders:
                  - order_handle: order-1
                    scheduled_at: 2023-10-31 02:00:00+00:00
                    product_type:
                    - frozen
                    - fragile
                    type: pick
                    metadata:
                      customerID: '12654'
                    destination:
                      address: 1709 Automation Pkwy, San Jose, CA 95101
                      geometry:
                        type: Point
                        coordinates:
                        - -121.8871193
                        - 37.3

# --- truncated at 32 KB (762 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/openapi/hypertrack-orders-api-openapi.yml