Track API user guide
An overview of the Track API package.
Track environments
All URLs and examples in this Track documentation refer to the Live environment, also known as the Production environment.
The Track live environment exists as a user interface at https://app.sorted.com/ and API requests use the base url of https://react-api.sorted.com/.
API headers in Track
To call any of Track’s APIs, you’ll need an API key. You can create one from the Settings > API Keys tab in the Track UI.
For more information on getting a Track API key, see the Setting up API keys section of the Settings page.
To use your API key, include it in an x-api-key header when making an API request. We also recommend that you include JSON Content-Type and Accept headers too, as Track only works with JSON data.
Track endpoints
Track offers the following API endpoints:
| Endpoint | Purpose |
|---|---|
| Register Shipments | Register shipments for tracking |
| Get Shipment by Shipment ID | Retrieve shipment details by Track Shipment ID |
| Get Shipments | Retrieve shipment details by tracking or custom reference |
| Update Shipment | Update shipment details |
| Delete Shipment | Delete a shipment |
| Get Tracking Events by Shipment ID | Retrieve all shipment tracking events for a specified shipment |
| Get Event | Retrieve events by Track Event ID |
| Get Shipment Events | Retrieve events by date range, references and carrier |
| Get Shipment Events by Shipment ID | Retrieve event details by Track Shipment ID |
| Get Shipment States History | Retrieve a shipment’s shipment state history |
API functions
- Registering Shipments - Explains how to use the Register Shipments endpoint and the SFTP bulk upload service to add shipments to Track.
- Retrieving Shipment and Event Data - Explains how to get data from the Shipment, Tracking, and Events APIs.
- Updating Shipments - Explains how to use the Update Shipment API to update and existing shipment’s details.
- Error Codes - Explains the various error codes that Track can return.
- Calculated Events - Explains how Track calculates events, and how those events affect shipments.
Next steps
Here are some related user guides: