Track an order
GET/api/orders/:id/tracking
Live tracking of an order created by Pay. {id} is the order (delivery) ID — deliveryId from Pay, or delivery.id from Get a quote — not the quotation ID.
Until the order can be tracked, the answer is still HTTP 200 but only { state } (OrderTrackingPending): check for state before reading it as tracking. Results are cached for 5 seconds, so polling faster gains nothing.
Signature only; a user session is not accepted. The sender account is named in X-Sender-Account-Id, which is outside the signature: it must belong to the organization of the API key. Missing header: 401 unauthenticated. Malformed, unknown or another organization's account: 403 forbidden (the same answer for all three).
Request
Responses
- 200
- 401
- 403
- 404
- 500
Tracking, or { state } while the order cannot be tracked yet.
Signature missing or invalid (Unauthorized), or X-Sender-Account-Id missing (unauthenticated).
forbidden: the order is not this sender's, or was not created from a quote; or X-Sender-Account-Id is malformed, unknown or belongs to another organization.
not_found: no such order, including a malformed id.
tracking_failed: internal error, including a carrier error.