Sign in
Trackers

Add a package tracker

This API creates or retrieves (if existent) a tracking status object containing the details and events of a shipping in progress.

post/v1/trackers

Query parameters

hubstring
pending_pickupboolean

Add this flag to add the tracker whether the tracking info exist or not.When the package is eventually picked up, the tracker with capture real time updates.

Request body

tracking_numberstring required

The package tracking number

carrier_name'allied_express' | 'allied_express_local' | 'amazon_shipping' | 'aramex' | 'asendia_us' | 'australiapost' | 'boxknight' | 'bpost' | 'canadapost' | 'canpar' | 'chronopost' | 'colissimo' | 'dhl_express' | 'dhl_parcel_de' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'fedex_ws' | 'generic' | 'geodis' | 'hay_post' | 'laposte' | 'locate2u' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'seko' | 'sendle' | 'tge' | 'tnt' | 'ups' | 'usps' | 'usps_international' | 'usps_wt' | 'usps_wt_international' | 'zoom2u' required

The tracking carrier

account_numberstring nullable

The shipper account number

referencestring nullable

The shipment reference

metadataobject

The carrier user metadata.

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.