Purpose
The purpose of this document is to explain how OmniRPS can send tracking updates to an integrated system via an API Webhook.
REST API
OmniRPS uses REST API for data transmission. REST (REpresentational State Transfer) API is a simple stateless architecture that runs over the internet. RESTful applications use HTTPS requests to create, read, update or delete data.
JSON
OmniRPS uses JSON due to its simplicity and human readable data format. JSON (JavaScript Object Notation) is a way to store information in an organized, easy-to-access manner.
Authentication
To help secure your Application endpoint, OmniRPS can use basic authentication and pass a username and password in the header.
You will need to provide a Username and Password for OmniRPS to use in webhook.
This is not mandatory.
Tracking Webhook Process Flow
Webhook Specification
Protocol: HTTP/HTTPS (Preferred)
Method: POST
Headers:
Username:<value>
Password:<value>
Parameters
Parameter | Type | Description |
|---|---|---|
ConsignmentNo | String | Consignment number |
OmniRPSTrackingNo | String | OmniRPS system Tracking No |
OrderNo | String | Order No |
MAWB | String | MAWB No |
ExportedConsignmentNo | String | Exported Consignment No |
ShipDate | Datetime | Ship Date |
DeliveryDate | Datetime | Delivery Date |
SourceLocation | String | Source Location of event e.g. Return Created event will be customer location |
DestinationLocation | String | Destination Location of event e.g. Return Created event will be first mile delivery location |
Code | String | Status Code |
Status | String | Status Description |
Carrier | String | Carrier |
EventDT | Datetime | Local Date and Time of Even |
List of Codes
Code | Description |
|---|---|
RC | Return Created |
RT | Return in Transit |
RDTPF | Return Delivered to Processing Facility |
RP | Return Processed |
RE | Return Exported |
RDBTC | Return Delivered Back To Customer |
RR | Return Rejected during processing |
Example Request
Request
https://yourwebsite.com/yourendpoint
Headers
Username:<value>
Password:<value>
[
{
"ConsignmentNo":"",
"OmniRPSTrackingNo":"BE00000146",
"OrderNo":"201905270449",
"MAWB":"",
"ExportedConsignmentNo":"",
"ShipDate":"2019-05-26 23:20:05",
"DeliveryDate":"",
"SourceLocation":"Auckland, New Zealand-NZ",
"DestinationLocation":"Auckland, New Zealand-NZ",
"Code":"RDTPF",
"Status":"Return Delivered to Processing Facility",
"Carrier":"",
"EventDT":"2019-05-27 11:20:05"
},
{
"ConsignmentNo":"",
"OmniRPSTrackingNo":"BE00000146",
Page | 5
"OrderNo":"201905270449",
"MAWB":"",
"ExportedConsignmentNo":"",
"ShipDate":"",
"DeliveryDate":"",
"SourceLocation":"Auckland, New Zealand-NZ",
"DestinationLocation":"Auckland, New Zealand-NZ",
"Code":"RP",
"Status":"Return Processed",
"Carrier":"",
"EventDT":"2019-05-27 11:20:05"
}
]
Response
OmniRPS will require a response 200 OK response back. If we do not receive the response we will assume the tracking events are not delivered. We will retry twice After 60 minutes. If we are still not receiving a 200 OK response, we will retry after 24 hours and 48 hours. If we are still not receiving a 200 OK response, we will disable your webhook after third attempt at 48 hours.
If your webhook is disabled, please email our support team on support@omniparcel.com to have it enabled once it is back online.