Order Tracking API Integration
Whether you're syncing order statuses with your internal tools or building a client-facing dashboard, this guide will walk you through everything you need to know to get started with our Order Tracking API—step by step.
1. What You Can Do With This API
-
Track orders in real-time — Instantly retrieve the latest status of any order, from processing to delivery.
-
Update shipping and arrival estimates — Keep your clients and team informed with accurate delivery timelines.
-
Generate tracking pages for shipments — Create a shareable tracking number page so stakeholders can monitor delivery progress.
2. How to Set Up the API
there’s no setup required on your end.
The API is already configured and activated for your account, so you can start using it right away.
3. How to use the API. with your shipments
To start tracking your shipments using the API, simply provide two key pieces of information:
-
Carrier Name – Select the shipping carrier handling the delivery.
-
Tracking Number – Enter the tracking number provided by the supplier or carrier.
- Click “Fetch Shipment Live Update”
This will fetch the latest status from the carrier.
Once these are entered, the API will fetch live tracking updates and automatically link them to the corresponding shipment.
If the shipment exists, its status will now be automatically updated with real-time tracking info—including the estimated arrival date—right inside your project.
4. Understand Tracking Statuses
As your shipments progress, the API will return real-time status updates that help you monitor each stage of the delivery. These statuses include:
-
Yet to be Shipped – Order has been placed but not handed off to the carrier yet
-
Ready to Ship – Shipment is packed and awaiting carrier pickup
-
Shipped – Carrier has received the package
-
In Transit – Package is en route to its destination
-
Expected to Arrive – Carrier has provided an estimated delivery date
-
Delivered – Shipment has arrived at its destination
-
Partially Received – Only some items in the shipment have been delivered
-
Delayed – Delivery is behind schedule
-
Failed Delivery – Attempted delivery was unsuccessful
-
Returned – Shipment is being returned to sender
-
Unfulfilled – Shipment was not fulfilled by the supplier or warehouse
Each status update includes a timestamp and, when available, location information to give you detailed visibility.
💡 Tip: These status milestones can be used to notify clients or update dashboards, helping everyone stay in the loop at every stage of the process.
Need Help?
-
Reach out to our support team for integration questions.