Get carrier tracking information. This endpoint can be accessed without authentication

Resource URL

Cluster	URL

Cluster	URL
Australia	https://api.bbamastro.com/shipment/shipment/{shipmentId}/tracking
US	https://api-us.bbamastro.com /shipment/shipment/{shipmentId}/tracking

Parameters

Name	Data type	Description

Name	Data type	Description
shipmentId	String	Shipment identifier

Responses

HTTP Code	Description	Schema

HTTP Code	Description	Schema
200	OK	GetTrackingInformationResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Response Payload

Field		Type	Description

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

{
    "carrierId": "couriers-please",
    "serviceId": "P2A",
    "trackingUrl": "https://www.couriersplease.com.au/tools-track/CPB5VWZ00001748",
    "customTrackingUrl": null,
    "carrierTrackingNumber": null,
    "trackingDisabled": false,
    "trackingEvents": []
}

Please refer to the Additional Reference section for more information on BBA Integration API objects.

API Integration

GET /{shipmentId}/tracking

Resource URL

Parameters

Responses

Response Payload

Response Payload Sample

Related content