Receive real-time shipment status updates via webhook, or query tracking on demand.
There are three ways to follow a shipment:
| Option | How it works | Best for |
|---|---|---|
| Webhook (push) | We send every new status to your HTTPS endpoint in real time | Keeping your systems up to date automatically |
| Tracking endpoint (pull) | Call Get tracking information for an Order | Checking a single shipment on demand |
| Tracking page | Share a tracking link | Your end customers |
A complete list of all status codes and their descriptions is available in this Google Sheet.
Tracking endpoint
Get tracking information for an Order returns two lists:
trackingSteps— the main milestones:ACCEPTED,DISPOSITION,PICKED_UP,DISPATCHED,UNLOADED,ON_A_WAY_TO_CONSIGNEEandDELIVERED(UNLOADEDandON_A_WAY_TO_CONSIGNEEonly for groupage shipments), each with its status and timestamp.statusEventHistory— all individual status events with code, message, timestamp, estimated pickup and delivery windows and, after delivery, the name of the signer.
Setting up the webhook
- Set up an HTTPS endpoint that accepts
POSTrequests with a JSON body. - Send the following information to Patrick at [email protected]:
- the URL of your endpoint
- authentication details, if your endpoint requires them (optional)
- your customer number or another clear reference to your customer account (e.g. the registered e-mail address)
- We configure the webhook. From then on, every status update is sent to your endpoint immediately after it is generated.
Payload
{
"order": {
"reference": "string",
"id": "string",
"customerId": "string",
"customerOrderCode": "string"
},
"event": {
"id": "string",
"statusCode": "string",
"label": "string",
"originatedAt": "2025-05-02T12:00:00Z",
"emittedBy": "string",
"nameOfSigner": "string",
"message": "string",
"estimatedCollectionAtFrom": "2025-05-03T08:00:00Z",
"estimatedCollectionAtUntil": "2025-05-03T12:00:00Z",
"estimatedDeliveryAtFrom": "2025-05-05T08:00:00Z",
"estimatedDeliveryAtUntil": "2025-05-05T18:00:00Z"
},
"environment": "production"
}Main fields
| Field | Description |
|---|---|
order.reference | Cargoboard shipment number — the same as data.reference in the order response |
order.id | Cargoboard order ID |
order.customerOrderCode | Your own shipment reference, as sent with the order |
event.statusCode | Status code of the tracking event — see the status list linked above |
event.label | Description of the tracking event |
event.originatedAt | When the event occurred (ISO 8601) |
event.estimatedCollectionAtFrom / …Until | Estimated pickup time window |
event.estimatedDeliveryAtFrom / …Until | Estimated delivery time window |
environment | Environment that sent the event, e.g. production |

