Skip to main content

Orders status data

How to get status data

You might want to get updated information on ongoing routes. You could do that by checking the orders-api and routes-api.

Getting live data from orders

You could use the GET /orders/:id endpoint to get updated information on the order.

Some items like status can be read directly from the resource block. Information on planned delivery and pickup windows can be read from the related.activities block.

Example

{
"08b943e6-32ec-4abd-833e-039620d89943": {
"type": "pickup",
"type_alias": null,
"time": [
"2025-09-19T08:12:00.000Z",
"2025-09-19T08:13:00.000Z"
],
"status": "CREATED",
"status_at": null,
"status_description": null,
"logs": [],
"id": "08b943e6-32ec-4abd-833e-039620d89943",
"created_at": "2025-09-19 02:01:27.664062+00",
"modified_at": null,
"deleted_at": null,
"created_by": "3554d2bb-9546-4ddd-b520-dac44e168744",
"modified_by": null,
"deleted_by": null,
"tags": [],
"attributes": {},
"job": "7989ebd9-fc7e-45b5-8c4e-e55da818ed54",
"task_id": "b8284e31-8cc2-4bb7-a0fd-696e2b3668a5",
"location_id": "bbf882ae-6a43-419e-8a1c-210c545f19be"
}
}