Sign in
Trackers

Retrieves a package tracker

Retrieve a package tracker

get/v1/trackers/{id_or_tracking_number}

Path parameters

id_or_tracking_numberstring required

Response

idstring

A unique identifier

carrier_namestring required

The tracking carrier

carrier_idstring required

The tracking carrier configured identifier

tracking_numberstring required

The shipment tracking number

deliveredboolean

Specified whether the related shipment was delivered

test_modeboolean required

Specified whether the object was created with a carrier in test mode

status'pending' | 'unknown' | 'on_hold' | 'delivered' | 'in_transit' | 'delivery_delayed' | 'out_for_delivery' | 'ready_for_pickup' | 'delivery_failed'

The current tracking status

estimated_deliverystring

The delivery estimated date

metaobject nullable

provider specific metadata

object_typestring

Specifies the object type

metadataobject

User metadata for the tracker

delivery_image_urlstring uri nullable

The shipment invoice URL

signature_image_urlstring uri nullable

The shipment invoice URL

Changes

No recorded changes to this endpoint across all 1 revision of this API.