Tracking data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model

idstring
Unique identifier for this tracking object
created_atdate
The date that this tracking object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
The last date that this tracking object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
shipment_idstring
Reference to the shipment
tracking_numberstring
Tracking number for the shipment
status enum
Valid values:
"PENDING"
"PROCESSING"
"IN_TRANSIT"
"DELIVERED"
"EXCEPTION"
Current status of the shipment
events array
Array of tracking events
estimated_deliverydate
Estimated delivery date
actual_delivery_atdate
Actual delivery timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
status_descriptionstring
Human-readable status
carrier_idstring
Reference to the carrier
carrier_status_codestring
Carrier's status code
carrier_status_descriptionstring
Carrier's status description
Are we missing anything? Let us know
Was this page helpful?