API Reference
Start typing to search…

Track Orders

post
https://v3.api.hypertrack.com/orders/track

This API allows the creation and immediate tracking of order fulfillment. If the route has been planned and exists in the HyperTrack system, then tracking can be initiated using the route_handle.

Body Params
string | null
Defaults to null

Unique Handle of route to be tracked. if provided other parameters are not required and will be ignored if provided

string | null
Defaults to null
deprecated

One of device_id or driver handle is mandatory

string | null
Defaults to null

One of device_id or worker handle is mandatory

string | null
Defaults to null

Unique Handle of Ops Group for which orders are to be tracked

string | null
Defaults to null

One of device_id or driver handle is mandatory

orders
array of objects | null
Defaults to null

List of Orders which are to be tracked. Required if route handle is not provided, i.e. new route will be created

orders
enum
required

Tracking mode of the order. Note that on_time and flex are deprecated modes.

Allowed:
route
object | null

Route that will be created to contain the orders to be tracked

integer | null
Defaults to null

Route version.

enum
Defaults to null

[BETA] Agent reconciliation mode. 'standalone' runs reconciliation based on data provided without HyperTrack tracking. 'tracked' enables normal HyperTrack tracking and forwards order data to Closeout Copilot asynchronously for reconciliation.

Allowed:
enum
Defaults to null

[BETA] Deprecated alias for agent_mode. Use agent_mode instead.

Allowed:
string | null
Defaults to null

[BETA] Worker phone number for closeout reconciliation. Only used when closeout_mode is 'standalone'.

enum
Defaults to login

Mode to control the active device for tracking orders. The following options are available:

  • login : Order tracking is based on the device the worker last logged into. When the worker logs into a new device, the orders automatically transfer to the new device. This is the default setting.
  • closest_to_destination : Order tracking is based on the device closest to the order's destination. The system monitors all of the worker's recent devices and selects the one nearest to the destination for tracking the order.
  • manual : Order tracking remains on the device that was active when the order was created.
Allowed:
Responses

Updated 7 months ago

Language
Credentials
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago