Get carrier tracking information. This endpoint can be accessed without authentication
Resource URL
https://api.bbamastro.com
...
/carrier/tracking🔗
Parameters
Name |
|---|
Data type | Description |
|---|
Schema
trackingNumber |
String | Tracking Number |
Responses
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
Definitions
mykey
Type: apiKey
Name: Authorization
In: HEADER
GetTrackingInformationResponse
...
Name
...
Schema
...
carrierId
optional
...
string
...
carrierTrackingNumber
optional
...
string
...
customTrackingUrl
optional
...
string
...
serviceId
optional
...
string
...
status
optional
...
string
...
trackingDisabled
optional
...
boolean
...
trackingEvents
optional
...
<TrackingEvent> array
...
trackingNumber
optional
...
string
...
trackingURL
optional
...
string
TrackingEvent
...
Name
...
Schema
...
depot
optional
...
string
...
location
optional
...
string
...
locationDetails
optional
...
LocationDetails
...
message
optional
...
string
...
status
optional
...
string
...
timestamp
optional
...
Request sample
https://api.bbamastro.com/carrier/tracking/HBH000000111106
Note: HBH000000111106 is a tracking number
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 | |
status | String | Tracking status | |
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": "tnt",
"serviceId": "717B",
"trackingUrl": "https://tntexpress.com.au/interaction/trackntrace.aspx?trackingNumber=%s",
"customTrackingUrl": null,
"trackingNumber": null,
"carrierTrackingNumber": null,
"status": "Delivered",
"trackingDisabled": false,
"trackingEvents": [
{
"location": "Highway Street,Alfords Point,2234,Australia",
"status": "Documentation Prepared",
"message": null,
"locationDetails": {
"lat": -33.9848,
"lng": 151.02142
},
"timestamp": "1970-01-01T00:00:00.000+0000",
"depot": null
},
{
"location": "Enfield,2136,New South Wales,Australia",
"status": "Collected",
"message": "Electronically Lodged",
"locationDetails": {
"lat": -33.9848,
"lng": 151.02142
},
"timestamp": "2020-12-02T09:43:09.000+0000",
"depot": null
},
{
"location": "Enfield,2136,New South Wales,Australia",
"status": "Collected",
"message": "Collected-Cust Premises (CIT)",
"locationDetails": {
"lat": -33.9848,
"lng": 151.02142
},
"timestamp": "2020-12-02T15:19:20.000+0000",
"depot": null
},
{
"location": "Enfield,2136,New South Wales,Australia",
"status": "Collected",
"message": "Received in Depot",
"locationDetails": {
"lat": -33.9848,
"lng": 151.02142
},
"timestamp": "2020-12-02T18:13:14.000+0000",
"depot": null
},
{
"location": "Enfield,2136,New South Wales,Australia",
"status": "Collected",
"message": "Received in Depot",
"locationDetails": {
"lat": -33.9848,
"lng": 151.02142
},
"timestamp": "2020-12-02T18:12:27.000+0000",
"depot": null
},
{
"location": null,
"status": "Collected",
"message": "Received in Depot",
"locationDetails": null,
"timestamp": "2020-12-03T06:49:14.000+0000",
"depot": null
},
{
"location": "Redbank,4301,Queensland,Australia",
"status": "Collected",
"message": "Received in Depot",
"locationDetails": {
"lat": -33.9848,
"lng": 151.02142
},
"timestamp": "2020-12-03T07:46:37.000+0000",
"depot": null
},
{
"location": "Redbank,4301,Queensland,Australia",
"status": "Collected",
"message": "Received in Depot",
"locationDetails": {
"lat": -33.9848,
"lng": 151.02142
},
"timestamp": "2020-12-03T16:45:30.000+0000",
"depot": null
},
{
"location": "Redbank,4301,Queensland,Australia",
"status": "Collected",
"message": "Received in Depot",
"locationDetails": {
"lat": -33.9848,
"lng": 151.02142
},
"timestamp": "2020-12-03T17:28:29.000+0000",
"depot": null
},
{
"location": "Warwick Dc,4370,Queensland,Australia",
"status": "ArrivedAtDestination",
"message": "Sighted in Depot",
"locationDetails": {
"lat": -28.2137979,
"lng": 152.0306591
},
"timestamp": "2020-12-04T07:14:11.000+0000",
"depot": null
},
{
"location": "Warwick Dc,4370,Queensland,Australia",
"status": "ArrivedAtDestination",
"message": "Sighted in Depot",
"locationDetails": {
"lat": -28.2137979,
"lng": 152.0306591
},
"timestamp": "2020-12-04T07:27:54.000+0000",
"depot": null
},
{
"location": "Warwick Dc,4370,Queensland,Australia",
"status": "ArrivedAtDestination",
"message": "Sighted in Depot",
"locationDetails": {
"lat": -28.2137979,
"lng": 152.0306591
},
"timestamp": "2020-12-04T09:15:31.000+0000",
"depot": null
},
{
"location": "Warwick Dc,4370,Queensland,Australia",
"status": "ArrivedAtDestination",
"message": "On Board For Delivery-Full",
"locationDetails": {
"lat": -28.2137979,
"lng": 152.0306591
},
"timestamp": "2020-12-04T09:29:52.000+0000",
"depot": null
},
{
"location": null,
"status": "Delivered",
"message": "Delivered in Full",
"locationDetails": null,
"timestamp": "2020-12-04T11:19:37.000+0000",
"depot": null
}
]
} |
| Info |
|---|
Please refer to the Additional Reference section for more information on BBA Integration API objects. |