8.0 Tracking Webhook / CSV / API
- Mette Evjenth
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:
8.1 Tracking Event Status codes
Please click on below file to download the list of OmniParcel tracking event status codes (OP-codes)
8.2 Tracking webhook
The purpose of this guide is to explain how OmniParcel can send tracking updates to an integrated system via an API Webhook.
To help secure your Application endpoint, OmniParcel can use basic authentication and pass a username and password in the header
Requires Authentication
Customer to provide Username and Password for OmniParcel to use in webhook
Protocol
HTTP/HTTPS (Preferred)
Headers
Username:<value>
Password:<value>
8.2.1 Tracking Webhook Process Flow
8.2.2 Parameters
Parameter | Type | Description |
|---|---|---|
ConsignmentNo | String | Consignment number |
Status | String | Current Consignment Status |
Picked | Datetime | Date time consignment was manifested to Seko |
Delivered | Datetime | Delivered datetime of consignment |
Tracking | String | Consignment tracking URL |
Events | Object Array | See Events Information |
8.2.3 Event Information
Parameter | Type | Description |
|---|---|---|
Code | String | Stage of Event |
EventDT | String | Date and Time of event. Local to region where it occurred |
OmniCode | String | OmniParcel Tracking Code. Full List of tracking codes can be provided |
Description | String | Description of Tracking Event from Carrier |
Location | String | Location of Event |
Part | Integer | If consignment has multiple packages, this is the package number |
8.2.4 Example Request body
[
{
"ConsignmentNo":"1245",
"Status":"Tracking number allocated & order ready",
"Picked":"",
"Delivered":"",
"Tracking":"http://track.omniparcel.com/1245",
"Events":[
{
"EventDT":"2018-28-28T17:22:43",
"Code":null,
"OmniCode":"OP-1",
"Description":"Tracking number allocated & order ready",
"Location":"IL",
"Part":"1"
}
]
},
{
"ConsignmentNo":"ABC124578",
"Status":"Scanned out of Auckland TO Napier",
"Picked":"2018-07-23 140426",
"Delivered":"",
"Tracking":"http://track.omniparcel.com/ ABC124578",
"Events":[
{
"EventDT":"2018-30-23T05:30:22",
"Code":null,
"OmniCode":"OP-43",
"Description":"Customs cleared",
"Location":"NZ",
"Part":"1"
},
{
"EventDT":"2018-30-23T05:30:18",
"Code":"PUP",
"OmniCode":"OP-7",
"Description":"Picked up",
"Location":"Auckland",
"Part":"1"
},
{
"EventDT":"2018-04-23T14:04:26",
"Code":"OUT",
"OmniCode":"OP-51",
"Description":"Scanned out of Auckland TO Napier",
"Location":"",
"Part":"1"
}
]
}
]
8.3 CSV / FTP Tracking
8.3.1 Sample tracking file
Click on below file to download our FTP tracking sample file:
8.4 Tracking API
8.4.1 Shipment Status
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
Request
Header
access_key: [access_key_for_site_account]
Content-Type: application/json; charset=utf-8
Body
["WFY9001843"]
Response
A JSON object array of order and save status.
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 |