Get tracking log (v1) · GXBiQ API docs

Returns the tracking history of one shipment.

GET/api/{version}/TrackingLog

Authorised with the client-secret header - your tracking API key - rather than a bearer token, so the endpoint can be called straight from a customer-facing tracking page. The client-id header identifies the account whose shipments may be looked up. Neither header is part of the request body, so they do not appear under Parameters below; send both on every call.

The response carries the carrier handling the shipment, a link to the carrier's own tracking page, the events recorded for the parcel and any service alerts published for the destination country.

For integration testing, SAMPLEGB00001 returns a full GB delivery history from canned data without touching the database. Any other tracking number beginning with SAMPLE is also treated as a sample and returns no events.

Query parameters

TrackingNumberstring
The carrier tracking number allocated to the parcel - the trackingSubNumber returned when the shipment was created.

Headers

AuthorizationstringRequired
JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Responses

200OKarray of object
Success
6 item fields
- carrierTrackingUrlstring · nullable
  Link to the carrier's own tracking page for this parcel.
- carrierNamestring · nullable
  Carrier handling the shipment.
- countryIsostring · nullable
  2 character ISO code of the destination country.
- countryNamestring · nullable
  Name of the destination country.
- trackingLogsarray of object · nullable
  Events recorded for the parcel, oldest first. Empty when the carrier has not reported anything yet.
  7 item fields
  - mainStatusstring · nullable
    Top level status of the parcel at this event.
  - subStatusstring · nullable
    The more specific status within MainStatus.
  - descriptionstring · nullable
    What happened, as reported by the carrier.
  - datestring · nullable
    Date the event was recorded by the carrier.
  - dateTimestring · nullable
    Date and time the event was recorded by the carrier.
  - locationstring · nullable
    Where the event happened. Empty when the carrier reports no location.
  - additionalInfostring · nullable
    Any extra detail the carrier supplied with the event. Often empty.
- serviceAlertsarray of object · nullable
  Disruptions published for the destination country in the last six months. Empty when there are none.
  3 item fields
  - isoCodestring · nullable
    2 character ISO code of the country the alert applies to.
  - eventDatestring · nullable
    Date the alert was raised.
  - informationstring · nullable
    What the alert says.
400Bad Requestobject
Bad Request
1 fields
- statusCodeinteger (int32)
401Unauthorizedobject
Unauthorized
1 fields
- statusCodeinteger (int32)
404Not Foundobject
Not Found
1 fields
- statusCodeinteger (int32)