Batch and Sequence Orders

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.

Authorization

AuthorizationBasic <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

ops_group_handle?|

Unique Handle of Ops Group to plan orders for

orders*array<>

List of Orders which are to be planned

plan_mode*string

scheduled mode allows customers to batch and sequence future orders into routes for worker based on their availability. This mode operates only on the upcoming routes (if exist), but does not re-plan ongoing routes.
manual mode allows customers to ingest orders into HT which are to be planned manually. If worker_handle is provided, hypertrack will create a new route for the specified worker with the posted orders in the provided sequence. In case worker_handle is not given, then hypertrack will ingest orders into system to facilitate further planning.
on_demand mode is to facilitate the use case where an order needs to be planned on top of an existing plan, here if worker_handle is provided, then the order will be assigned to that worker, either optimally adjusted into his/her existing route (if present) OR a new route is created for the worker. If worker_handle is not provided, then the order either gets adjusted to one of the available worker's route in the most optimal manner OR is added to a new route. In both scenarios, order planning makes sure Order SLAs are met. On demand mode works for future as well as live routes.

driver_handle?|

Deprecated

Driver handle to which order will be assigned to.

worker_handle?|

Worker handle to which order will be assigned to.

enable_sync_planning?|

Flag to enable synchronous planning when the plan mode is on_demand. For scheduled mode, planning is always performed asynchronously.

route_solver_matrix_strategy?unknown

Strategy to use for route solver. Options: osrm_full, als_full, hybrid_sparse

Response Body

`application/json`

curl -X POST "https://example.com/orders/" \  -H "Content-Type: application/json" \  -d '{    "plan_mode": "manual",    "ops_group_handle": "store-SF",    "orders": [      {        "order_handle": "order-1",        "scheduled_at": "2023-10-31T02:00:00.000Z",        "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-31T04:00:00.000Z",        "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        }      }    ]  }'

{  "route_handle": "string",  "status": "planned",  "version": 0,  "created_at": "string",  "embed_url": "string",  "orders": [    {      "order_handle": "string",      "status": "planned",      "destination": {        "geofence_id": "string",        "place_handle": "string",        "address": "string",        "geometry": {          "coordinates": [            0          ],          "type": "Point"        },        "place_id": "string",        "radius": 30      },      "fulfillment_attempt": 0,      "risk_status": true,      "ops_group_handle": "string",      "plan_mode": "on_demand",      "plan_id": "string",      "device_id": "string",      "driver_handle": "string",      "worker_handle": "string",      "place_handle": "string",      "created_at": "string",      "started_at": "string",      "assigned_at": "string",      "planned_at": "string",      "scheduled_at": "string",      "scheduled_after": "string",      "completed_at": "string",      "cancelled_at": "string",      "disabled_at": "string",      "enabled_at": "string",      "arrived_at": "string",      "exited_at": "string",      "metadata": {        "property1": null,        "property2": null      },      "risks": {        "property1": null,        "property2": null      },      "expected_service_time": 0,      "product_type": [        "string"      ],      "type": "pick",      "type_index": 0,      "capacity_used": 0,      "region": {        "country": "string",        "city": "string",        "state": "string"      },      "distance": 0,      "duration": 0,      "estimate": {        "start_at": "string",        "start_by": "string",        "arrive_at": "string",        "distance": 0,        "duration": 0,        "initial_arrive_at": "string",        "current_worker_location": {          "geometry": {            "type": "string",            "coordinates": [              null            ]          },          "bearing": 0,          "accuracy": 0,          "speed": 0,          "recorded_at": "string"        }      },      "share_url": "string",      "route_handle": "string",      "track_mode": "on_time",      "actual_service_time": 0,      "tracked_service_time": 0,      "tracking_rate": 0,      "time_to_first_event": 0,      "time_to_first_location": 0,      "created_by": {        "source": "string",        "timestamp": "string",        "ip-address": "string",        "device_id": "string",        "driver_handle": "string",        "user_id": "string",        "email": "string"      },      "outage_summary": [        {          "duration": 0,          "distance": 0,          "code": "string",          "label": "string",          "description": "string",          "category": "behavioural"        }      ],      "embed_url": "string",      "device_switch_mode": "manual",      "tasks": [        {          "label": "string",          "task_definition_id": "string",          "description": "string",          "metadata": {            "property1": null,            "property2": null          },          "priority": "none",          "task_id": "string",          "status": "string"        }      ],      "priority": "low",      "worker_profile": {        "property1": null,        "property2": null      },      "rescheduled_marked_at": "string",      "cancellation_source": {        "property1": null,        "property2": null      }    }  ],  "created_by": {    "source": "string",    "timestamp": "string",    "ip-address": "string",    "device_id": "string",    "driver_handle": "string",    "user_id": "string",    "email": "string"  },  "ops_group_handle": "default",  "track_mode": "on_time",  "plan_mode": "on_demand",  "started_at": "string",  "assigned_at": "string",  "planned_at": "string",  "completed_at": "string",  "device_id": "string",  "driver_handle": "string",  "worker_handle": "string",  "metadata": {    "property1": null,    "property2": null  },  "region": {    "country": "string",    "city": "string",    "state": "string"  },  "distance": 0,  "duration": 0,  "estimate": {    "start_by": "string",    "distance": 0,    "duration": 0,    "polyline": {      "type": "string",      "coordinates": [        [          null        ]      ]    },    "start_location": {      "type": "string",      "coordinates": [        null      ]    },    "end_location": {      "type": "string",      "coordinates": [        null      ]    }  },  "plan_id": "string",  "device_switch_mode": "manual",  "candidate_devices": [    "string"  ],  "completion_source": "string",  "scheduled_start_at": "string",  "polyline": {    "type": "string",    "coordinates": [      [        null      ]    ]  },  "start_location": {    "type": "string",    "coordinates": [      null    ]  },  "end_location": {    "type": "string",    "coordinates": [      null    ]  },  "tracking_rate": 0,  "time_to_first_event": 0,  "time_to_first_location": 0,  "completion_type": "end_at_last_order"}

{  "detail": {},  "message": "string"}

Empty

{  "detail": {    "<location>": {      "<field_name>": [        "string"      ]    }  },  "message": "string"}

Authorization

Request Body

Response Body

201application/json

401application/json

409

422application/json

`application/json`

`application/json`

`application/json`