Skip to main content
GET
Retrieve tracking information for a parcel

Authorizations

Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Path Parameters

tracking_number
string
required

Parcel tracking number The tracking number of a parcel

Required string length: 1 - 255

Response

OK

This object contains the parcel and its associated tracking numbers

announced_at
string<date-time>
required

The timestamp of when the parcel was announced to the carrier (label was created)

created_at
string<date-time>
required

The timestamp of when the parcel was created in the system

details
Parcel Detail Response · object
required
Example:
events
Parcel Event Response · object[]
required
from_address
Parcel Tracking Address · object
required

Parcel Tracking Address object

source_id
string
required

An external identifier that clients can provide to link the parcel with the corresponding record in their own system

to_address
Parcel Tracking Address · object
required

Parcel Tracking Address object

tracking_numbers
Tracking Number Response · object[]
required
updated_at
string<date-time>
required

The timestamp of when the parcel was last updated in the system. Only altered by updates on announced_at, contract, and source_id

parcel_items
Parcel Item with Source ID Object · object[]

List of items / products that the parcel contains

ship_with
Ship With Shipping Option Code Object · object

Ship using a shipping option code. The shipping option code is required.

Example: