Tracking API
Show shipment status to your customers inside your own website or app, without sending them elsewhere. There are two ways to do it.
Option 1: Query
Your system sends the tracking number and receives the current shipment status and its movement history. Good for a "Track your order" page in your store.
Option 2: Webhooks
Instead of your system checking again and again, we send the update to an address you choose as soon as the shipment status changes. Good for sending your customer an automatic message when the shipment goes out for delivery or is delivered.
Shipment statuses
These are the statuses the query returns and the webhook sends:
| Status | Meaning |
|---|---|
| Awaiting labels | The shipment is booked, and its waybill hasn't been issued yet. |
| Awaiting pickup or branch drop-off | The waybill is ready, and we're waiting to collect the shipment from the sender or for it to be dropped at a branch. |
| In transit | We've received the shipment and it's on its way to the destination. |
| Customs hold | The international shipment is held at customs to complete procedures. |
| Out for delivery | The shipment is with the courier on its way to the receiver. |
| Delivered | The shipment reached the receiver. |
| Delivery failed | We couldn't deliver the shipment on this attempt. |
| Returning | The shipment is on its way back to the sender. |
| Returned | The shipment is back with the sender. |
| Damaged | Damage has been recorded on the shipment. |
| Lost | The shipment has been recorded as lost. |
Access
The tracking API is part of the BaridX API and is enabled for business accounts.
To track a single shipment without any integration, use the tracking page.