Description
| Transporters are used to push tracking information. |
Path
| HTTP Verb | URL |
|---|---|
| Post | /services/integration/carrier/trackingEvents |
Request Parameter
| # | Field | Mandatory/Optional | length | Description |
|---|---|---|---|---|
| 1 | trackingNo | M | 40 | Tracking number |
| 2 | eventTime | M | Date | Time when the event happens |
| 3 | eventCode | M | 8 | Event code |
| 4 | activity | O | 256 | Description of the event |
| 5 | location | O | 60 | Location |
| 6 | timeZone | O | Fix format. "GMT+1:00" or "GMT+1" | time zone. If null, defaults to 'GMT+8:00' |
Response Parameter
| # | Field | Type | Mandatory/Optional | Description |
| 1 | status | Enumeration | M | Success/Failure |
| 2 | errors | Arrays | O | Response errors. Please refer to the following code and message. |
| 3 | data | Objects | O | Operational Data |
| 4 | warnings | String | O | Warning message |
Error Message
code | message |
520005 | trackingNo is empty, please check |
520006 | eventTime is empty, please check |
520007 | eventCode is empty, please check |
| 520008 | timezone value is invalid |
Request message
Request
[
{
"trackingNo": "BRF0000013011420",
"eventTime": "2022-12-21T08:01:02",
"eventCode": "SCN",
"activity": "Item despatched to Transshipment hub",
"location": "SHANGHAI",
"timeZone": "GMT+1:00"
}
]
Response message
Response
{
"status": "Success",
"errors": [
{
"code": 0,
"message": ""
}
],
"data": null,
"warnings": null
}