| Note |
|---|
Important information: Due to API throttling there is a limit of 100 API requests per minute for our tracking API. We recommend using our tracking webhook or CSV file sent via FTP. |
On this page:
| Table of Contents | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Note |
|---|
Requires Authentication
|
8.4.2 Parameters Required
The body of the message should be sent as JSON array.
A JSON list of consignment numbers.
This method will accept consignment numbers (this is the value you receive in the “Connote” parameter in the Consignment Creation API response) as an array
8.4.
...
3 Example Request
| Info |
|---|
Endpoints |
...
| Info |
|---|
In Status API Request the Response will return only following Activity Result. |
8.4.
...
4 Response Data Definition
Parameter | Description |
|---|---|
ConsignmentNo | The Unique consignment number queried |
Status | Current status of shipment |
Picked | Date and Time picked from sender. Local time at pickup address. Blank when not picked yet |
Delivered | Date and Time delivered to receiver. Local time at delivery address. Blank when not delivered yet. |
Tracking | Tracking URL |
Reference1 | This is customer reference field. It will pass the same value from DeliveryReference (CustomerRef) field of consignment creation API. |
Events | An array of line level events for all pieces in the shipment |
8.4.
...
5 Events Array
Parameter | Description |
|---|---|
EventDT | Date and Time of event. Local to region where it occurred |
Code | Final mile Carrier codes, in many cases you may find this value as NULL. |
OmniCode | OmniParcel tracking event code. Integration partners must use this code to map tracking event. Please check below full list of tracking event codes file. |
Description | Event description |
Location | Locality of where event took place |
Part | Shipment item identifier. E.g Label Number |
...