...
Protocol: HTTP/HTTPS (Preferred)
Method: POST
Headers:
Username:<value>
Password:<value>
Parameters
Parameter | Type | Description | Populated for Events |
---|---|---|---|
ConsignmentNo | String | Consignment number | All |
OmniRPSTrackingNo | String OmniRPS | system Tracking NoUnique ID generated at the time of processing in OmniRPS | RP, RE, RDBTC |
OrderNo | String | Order No | All |
MAWB | String | MAWB Nonumber supplied from the airline if airfreight, else generic ID. | RE, RDBTC |
ExportedConsignmentNo | String Exported Consignment No | Outer Label consignment number created when consolidations are packed | RE, RDBTC |
ShipDate | Datetime Ship Date | UTC date and time of the event | All |
DeliveryDate | Datetime | Delivery Date | RDBTC |
SourceLocation | String | Source Location of event e.g. Return Created event will be customer location | All |
DestinationLocation | String | Destination Location of event e.g. Return Created event will be first mile delivery location | All |
Code | String | Status Code | All |
Status | String | Status Description | All |
Carrier | String | Carrier responsible for the event | RC, RT, DS, RDTPF, RDBTC |
EventDT | Datetime | Local Date date and Time of Eventime of the event | All |
List of Codes
Code | Description |
---|---|
RC | Return Created |
RT | Return in Transit |
RDTPF | Return Delivered to Processing Facility |
DS | Depot Scan: Return has been delivered to our returns hub within the processing facility |
RP | Return Processed |
RE | Return Exported |
RDBTC | Return Delivered Back To Customer. The customer in this case is the Retailer, this is where the final mile of consolidated returns are delivered to. |
RR | Return Rejected during processing |
...