Track a booking (legacy API shape)

GET

/api/v5/bookings/track/{id}

• Production

Returns tracking events for a booking ID, consignment number or courier tracking reference, keyed by the supplied reference in the legacy v4 tracking-API shape. Requires an API key.

Parameters

Path Parameters

id

required

string

Example

TD123

Booking ID, consignment number or courier tracking reference.

Responses

200

Tracking events keyed by the requested booking ID or reference

object

key

additional properties

Array<object>

object

date

required

Event timestamp as reported by the courier; null when unknown.

string

nullable

status

required

Courier status label for the event; null when unavailable.

string

nullable

description

required

Human-readable description of the tracking event; null when unavailable.

string

nullable

location

required

Location associated with the event; null when unavailable.

string

nullable

pod_url

required

Proof-of-delivery document URL; null when not available.

string

nullable

delivery_date

required

Delivery date for the shipment; null when not delivered or unknown.

string

nullable

track_status

required

Normalised tracking status code (e.g. picked_up, in_transit, delivered); null when unknown.

string

nullable

400

Invalid tracking reference

object

error

required

Human-readable error message describing why the request failed.

string

401

Missing or invalid API key

404

No booking matched the supplied reference (empty event list for the reference)

object

key

additional properties

Array<object>

object

date

required

Event timestamp as reported by the courier; null when unknown.

string

nullable

status

required

Courier status label for the event; null when unavailable.

string

nullable

description

required

Human-readable description of the tracking event; null when unavailable.

string

nullable

location

required

Location associated with the event; null when unavailable.

string

nullable

pod_url

required

Proof-of-delivery document URL; null when not available.

string

nullable

delivery_date

required

Delivery date for the shipment; null when not delivered or unknown.

string

nullable

track_status

required

Normalised tracking status code (e.g. picked_up, in_transit, delivered); null when unknown.

string

nullable