Order Status
Our API allows you to retrieve the latest delivery updates of your orders.
Overview
These requests allow you to get order status information and an image of your order status page widget with a single HTTPS request.
You can retrieve the current status of an order using set parameters (for example: order number, tracking number, and carrier) through these APIs and get a visual representation of your order status page to display on customer-facing platforms.
Get Order Status Updates
You can retrieve the latest status updates for an order (for example: to display on your order status page) using the v4/track/orders/info endpoint.
Retrieves order status information (trackings, checkpoints, and reporting info), typically for customer-facing use cases like an order status page.
Orders can be looked up using one of the following primary identifier sets.
Primary lookup methods:
Order Number: Requires
order_numberandaccount. Optionally,client(Client Key).External Order ID: Requires
external_order_idandaccount.External Reference: Requires
external_referenceandaccount. Note: uniqueness of external references is not ensured by the system.Tracking Number: Requires
tracking_numberandcourier. Optionally,accountCustomer Number: Requires
customer_numberandaccount.Recipient Email: Requires
recipient_emailandaccount.
All lookups can also include these optional parameters:
postal_code: Recipient's postal code.recipient_email: Recipient's email (for secondary verification/filtering).lang: Language for the response content.s: HMAC signature for secure access.live_refersh: Boolean to force a live data refresh from carriers.
Account of order (if lookup by order number)
Client key of order (if lookup by client key)
Courier of order (if lookup by courier/tracking number)
Customer number of order (if lookup by customer number)
External ID of order (if lookup by external ID)
External reference of tracking (if lookup by external reference)
Language of order status information (falls back to trackings language and 'en' as last choice)
enPerform an inline (live) refresh to the carrier API if applicable.
Order number to lookup (if lookup by order number)
Recipient email of order (if no API token is provided, determines level of information access in accordance with your account setup)
Recipient postal code of order (if no API token is provided, determines level of information access in accordance with your account setup)
Security hash of tracking (if no API token is provided, determines level of information access in accordance with your account setup)
Only return tracking data that matches the provided tracking number and courier
falseID of tracking (if lookup by tracking ID)
Tracking number of order (if lookup by courier/tracking number)
GET /v4/track/orders/info/ HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"order_number": "text",
"client_key": "text",
"order_date": "2025-10-12T10:59:49.175Z",
"recipient_name": "text",
"recipient_email": "text",
"destination_country_iso3": "text",
"trackings": [
{
"tracking_number": "text",
"courier_info": {
"courier": "text",
"courier_name": "text",
"courier_tracking_url": "text",
"courier_reroute_url": "text",
"last_mile_courier": "text",
"last_mile_courier_name": "text"
},
"last_delivery_status": {
"step": 1,
"status_code": "text",
"status_text": "",
"status_details": "",
"lifecycle_status": "Pending",
"delivery_extra_info": "text",
"exception_type": "text",
"event_timestamp": "2025-10-12T10:59:49.175Z",
"next_action": "text",
"icon_hint": "text"
},
"delivery_location": "text",
"is_delayed": false,
"is_exception": false,
"is_return": false,
"action_box": {
"type": "pickup-location",
"label": "text",
"label_communication": "text",
"label_caption": "text",
"address": "text",
"opening_hours": [
{
"day": "mon",
"open": "10:59:49",
"close": "10:59:49"
}
],
"raw": {
"earliest_date": "2025-10-12",
"latest_date": "2025-10-12",
"has_time": true,
"earliest_time": "text",
"latest_time": "text"
}
},
"recipient_name": "text",
"recipient_email": "text",
"destination_country_iso3": "text",
"recipient_postal_code": "text",
"identifiers_consignment": "text",
"shipping_address": {
"first_name": "text",
"last_name": "text",
"company_name": "text",
"address_line": "text",
"address_line_extra": "text",
"postal_code": "text",
"city": "text",
"country_iso3": "text",
"region_code": "text",
"phone": "text"
},
"articles": [
{
"version": "v1",
"line_item_id": "text",
"product_id": "text",
"sku": "text",
"order_item_id": "text",
"article_name": "text",
"article_category": "text",
"article_store_url": "text",
"article_image_url": "text",
"article_brand": "text",
"size": "text",
"color": "text",
"width": 1,
"height": 1,
"length": 1,
"length_unit": "cm",
"weight": 1,
"weight_unit": "g",
"unit_price": "text",
"quantity": 1,
"amount_invoiced": "text",
"origin_country_iso3": "text",
"is_bulky": false,
"tags": [
"text"
],
"additional_attributes": [
{
"key": "text",
"value": null
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"additional_attributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"announced_delivery_date": "2025-10-12",
"announced_delivery_date_min": "2025-10-12",
"pod_identifier": "text",
"pod_signature": "text",
"pod_date": "2025-10-12",
"timezone": "text",
"reporting_info": {
"is_forgotten": true,
"is_delayed": true,
"has_failed_attempt": true,
"is_delayed_dispatch": true,
"is_returned": true,
"is_customer_promise_exceeded": true,
"trending_late_probability": 1,
"trending_late_status": "normal",
"contacted_with_messages": [
"text"
],
"exception_messages": [
"text"
],
"in_transit_date": "2025-10-12T10:59:49.175Z",
"pickup_date": "2025-10-12T10:59:49.175Z",
"courier_dropoff_date": "2025-10-12T10:59:49.175Z",
"delivery_date": "2025-10-12T10:59:49.175Z",
"returned_date": "2025-10-12T10:59:49.175Z"
},
"supports_live_refresh": true,
"checkpoints": [
{
"step": 1,
"courier": "text",
"status_code": "text",
"event_timestamp": "2025-10-12T10:59:49.175Z",
"status_text": "text",
"status_details": "text",
"is_hidden": true,
"location": "text",
"delivery_location_type": "ParcelShop",
"delivery_extra_info": "text",
"estimated_delivery_date": {
"start_date": "2025-10-12",
"end_date": "2025-10-12",
"start_time": "10:59:49",
"end_time": "10:59:49"
},
"exception_type": "text",
"next_action": "text"
}
]
}
]
}Get Order Status Widget
You can retrieve the order status page widget as an image for displaying order status information using the v4/track/orders/info-widget endpoint.
Retrieves order status widget as image
Account of order (if lookup by order number)
Client key of order (if lookup by client key)
Courier of order (if lookup by courier/tracking number)
Customer number of order (if lookup by customer number)
External ID of order (if lookup by external ID)
External reference of tracking (if lookup by external reference)
Language of order status information (falls back to trackings language and 'en' as last choice)
enPerform an inline (live) refresh to the carrier API if applicable.
Order number to lookup (if lookup by order number)
Recipient email of order (if no API token is provided, determines level of information access in accordance with your account setup)
Recipient postal code of order (if no API token is provided, determines level of information access in accordance with your account setup)
Security hash of tracking (if no API token is provided, determines level of information access in accordance with your account setup)
Only return tracking data that matches the provided tracking number and courier
falseID of tracking (if lookup by tracking ID)
Tracking number of order (if lookup by courier/tracking number)
GET /v4/track/orders/info-widget/ HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
binaryLast updated
Was this helpful?