Get carrier tracking information. This endpoint can be accessed without authentication
Resource URL
Cluster | URL |
|---|---|
Australia |
...
Parameters
Name |
|---|
Data type | Description |
|---|
shipmentId |
Path
trackingNumber
optional
Tracking Number
String | Shipment identifier |
Responses
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
Response Payload
Field | Type | Description | |
|---|---|---|---|
carrierId | String | Carrier id | |
serviceId | String | Service id | |
trackingUrl | String | Tracking url | |
customTrackingUrl | String | Custom tracking url | |
trackingNumber | String | Tracking number | |
carrierTrackingNumber | String | Carrier tracking number | |
trackingDisabled | Boolean | Tracking disabled | |
trackingEvents | Object[] | Tracking events | |
location | String | Tracking event location | |
status | String | Tracking event status | |
message | String | Tracking event message | |
locationDetails.lat | Decimal | Location details latitude | |
locationDetails.lng | Decimal | Location details longitude | |
timestamp | Date Time | Tracking event timestamp | |
Response Payload Sample
| Code Block |
|---|
{
"carrierId": "couriers-please",
"serviceId": "P2A",
"trackingUrl": "https://www.couriersplease.com.au/tools-track/CPB5VWZ00001748",
"customTrackingUrl": null,
"carrierTrackingNumber": null,
"trackingDisabled": false,
"trackingEvents": []
} |
| Info |
|---|
Please refer to the Additional Reference section for more information on BBA Integration API objects. |