Get Routes
Retrieve routes based on the filter parameters provided
Retrieve routes based on the filter parameters provided
In: header
Query Parameters
Filter for routes completed on specified date (YYYY-MM-DD)
Filter for routes completed after specified timestamp (YYYY-MM-DD HH:mm:ss)
Filter for routes completed before specified timestamp (YYYY-MM-DD HH:mm:ss)
Filter for routes created on specified date (YYYY-MM-DD)
Filter for routes created after specified timestamp (YYYY-MM-DD HH:mm:ss)
Filter for routes created before specified timestamp (YYYY-MM-DD HH:mm:ss)
Unique customer provided identifier of the worker to used retrieve routes associated with the specified worker
Unique customer provided identifier of the driver to used retrieve routes associated with the specified driver
Filter for routes on specified ops group handle or list of comma separated handles
Filter for routes on specified plan mode (manual -> routes created manually, scheduled -> routes created automatically)
Filter for routes planned on specified date (YYYY-MM-DD).
Filter for routes planned after specified timestamp (YYYY-MM-DD HH:mm:ss)
Filter for routes planned before specified timestamp (YYYY-MM-DD HH:mm:ss)
JSON object containing city, state, or country used to filter routes
JSON object representing route metadata to be used to filter routes
Sort route responses by asc or desc on the created_at timestamp
Date (YYYY-MM-DD) used as a filter to retrieve routes that need to start by the given date
Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve routes that need to start within a timeframe
Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve routes that need to start within a timeframe
Date (YYYY-MM-DD) used as a filter to retrieve routes that started on a given date
Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve routes that started within a timeframe
Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve routes that started within a timeframe
Timestamp (YYYY-MM-DD HH:mm:ss) of the start of window to retrieve routes that scheduled start within a timeframe
Timestamp (YYYY-MM-DD HH:mm:ss) of the end of window to retrieve routes that scheduled start within a timeframe
Filter for routes that are planned, assigned, tracking, or completed, to filter for multiple statuses, pass them as comma separated values
Filter for routes that are on_time, flex, on_shift, pre_shift or full_shift
Encoded value provided by our API to retrieve the next page of routes
String representing the search term. Search will be done on route_handle, ops_group_handle, worker_handle and metadata fields.
Max results to fetch
Filter for routes with a device_switch_mode
Filter by plan id
Filter by device id
JSON object representing device metadata to be used to filter routes
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/orders/routes/"{ "routes": [ { "route_handle": "afb94d64-2702-4efa-b938-d1facfd7832e", "status": "completed", "version": 1, "embed_url": null, "orders": [ { "order_handle": "order-1", "status": "cancelled", "type": "drop", "type_index": 0, "estimate": { "distance": 73863, "duration": 3614, "start_by": "2023-10-31T02:59:46.000Z" }, "cancelled_at": "2023-10-31T00:12:56.688Z", "expected_service_time": 0 }, { "order_handle": "order-2", "status": "cancelled", "type": "pick", "type_index": 0, "estimate": { "distance": 75766, "duration": 3732, "start_by": "2023-10-31T00:57:48.000Z" }, "cancelled_at": "2023-10-31T00:13:01.073Z", "expected_service_time": 0 } ], "ops_group_handle": "store-SF", "started_at": "2023-10-31T00:57:48.000Z", "created_at": "2023-10-31T00:12:22.767Z", "region": { "country": "United States", "city": "San Jose", "state": "California" }, "completed_at": "2023-10-31T00:13:01.255Z", "plan_mode": "manual", "plan_id": "a7a9c72e-bf31-44f5-8a59-c4fffb5fb9d4" }, { "route_handle": "a3f6e79c-c830-4766-8a3d-9eeaa5099ce1", "status": "completed", "version": 1, "embed_url": "https://embed.hypertrack.com/trips/a3f6e79c-c830-4766-8a3d-9eeaa5099ce2?publishable_key=a5pvd2PekFvSSuZrwivgJS_Ssd6irX1n9qRBIn9nl3PTK-5y3BO56rolpGuzhp1pIoH4TiDyqWIq8IEkOJCqeg", "orders": [ { "order_handle": "order-3", "status": "cancelled", "type": "pick", "type_index": 0, "estimate": { "distance": 75766, "duration": 3732, "start_by": "2023-10-31T00:57:48.000Z" }, "cancelled_at": "2023-10-31T23:13:13.926Z", "expected_service_time": 0 }, { "order_handle": "order-4", "status": "completed", "type": "drop", "type_index": 0, "estimate": { "distance": 73514, "duration": 3571, "start_by": "2023-10-31T03:00:29.000Z" }, "completed_at": "2023-10-31T23:13:21.287Z", "expected_service_time": 0 } ], "ops_group_handle": "store-SF", "started_at": "2023-10-31T03:00:29.000Z", "assigned_at": "2023-10-31T23:13:03.788Z", "created_at": "2023-10-31T23:12:55.529Z", "device_id": "52223948-1A79-47CC-AB81-2FB0A59536D2", "worker_handle": "james@ht.com", "region": { "country": "United States", "city": "San Jose", "state": "California" }, "completed_at": "2023-10-31T23:13:21.647Z", "plan_mode": "manual" } ]}{ "detail": {}, "message": "string"}{ "detail": { "<location>": { "<field_name>": [ "string" ] } }, "message": "string"}