...
| Table of Contents | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Tracking webhook
| Info |
|---|
The purpose of this guide is to explain how OmniParcel can send tracking updates to an integrated system via an API Webhook. |
| Note |
|---|
To help secure your Application endpoint, OmniParcel can use basic authentication and pass a username and password in the header Requires Authentication
Protocol
Headers
|
Tracking Webhook Process Flow
...
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 |
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 |
Example Request body
| Code Block |
|---|
[
{
"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"
}
]
}
] |
For detailed information about our tracking webhook, please see our tracking documentation here.
| Info |
|---|
Please provide below details to your account manager for your webhook to be configured Request https://yourwebsite.com/yourendpoint https://yourwebsite.extension/yourendpoint Headers Password:<value> |
...
Log into your Mangeto admin portal.
Navigate to System => Webservices => SOAP/XMP-RPC => Roles.
Create a new role as OmniParcel
Select Role Resources
Grant access to Sales and Directory as shown below.
Navigate to System => Webservices => SOAP/XMP-RPC => Users
Create a new user as below. You can change the values below to suit your needs. The API Key is the password.
Select User Role. Add user to the newly created OmniParcel role.
Change Setting System => Configuration => Services => Magento Core API.
To configure the app in OmniParcel, follow these steps above.