Versions Compared

Version Old Version 6 New Version Current
Changes made by

Rex Enage (Unlicensed)

Zulfy Adi Harianto

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Resource URL

Cluster

URL

Australia

https://api.bbamastro.com

...

/shipment/shipment/{shipmentId}/tracking

US

https://api-us.bbamastro.com/shipment/shipment/{shipmentId}/tracking

Parameters

Type

Name

Name

Data type

Description

Schema

shipmentId

Path

String

trackingNumber

optional

Tracking Number

string

Shipment identifier

Responses

HTTP Code

Description

Schema

200

OK

GetTrackingInformationResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

...

Response Payload

...

Field

Type

...

TrackingEvent

Name

Schema

depot

optional

string

location

optional

string

locationDetails

optional

LocationDetails

message

optional

string

status

optional

string

timestamp

optional

string (date-time)

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

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.