Tracking data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for this tracking object |
created_at | string (date-time) | No | The date that this tracking object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | The last date that this tracking object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
shipment_id | string | No | Reference to the shipment |
tracking_number | string | No | Tracking number for the shipment |
status | enum | No | Current status of the shipment Values: PENDING, PROCESSING, IN_TRANSIT, DELIVERED, EXCEPTION, CANCELLED, LABEL_CREATED, PICKED_UP, OUT_FOR_DELIVERY, DELIVERY_ATTEMPTED, RETURNED_TO_SENDER, HELD_AT_LOCATION, CUSTOMS_CLEARANCE, EXCEPTION_RESOLVED |
events | ShippingTrackingEvent[] | No | Array of tracking events |
events[].created_at | string (date-time) | No | The date that this tracking event object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
events[].description | string | No | Description of the tracking event |
events[].status | enum | No | Status at the time of this event Values: PENDING, PROCESSING, IN_TRANSIT, DELIVERED, EXCEPTION, CANCELLED, LABEL_CREATED, PICKED_UP, OUT_FOR_DELIVERY, DELIVERY_ATTEMPTED, RETURNED_TO_SENDER, HELD_AT_LOCATION, CUSTOMS_CLEARANCE, EXCEPTION_RESOLVED |
events[].event_code | string | No | Carrier-specific event code |
events[].carrier_status_code | string | No | Carrier's status code at this event |
events[].location_address | ShippingTrackingEvent_location_address | No | |
events[].location_address.address1 | string | No | |
events[].location_address.address2 | string | No | |
events[].location_address.city | string | No | |
events[].location_address.region | string | No | |
events[].location_address.region_code | string | No | |
events[].location_address.postal_code | string | No | |
events[].location_address.country | string | No | |
events[].location_address.country_code | string | No | ISO 2-digit country code |
events[].location_address.name | string | No | Recipientsender name |
events[].location_address.company_name | string | No | Company name (for commercial addresses) |
events[].location_address.telephone | string | No | Phone number (required by FedEx, UPS, DHL) |
events[].location_address.email | string | No | Email address (for delivery notifications) |
events[].location_address.is_residential | boolean | No | Alias for address_type === 'RESIDENTIAL' |
events[].location_address.is_validated | boolean | No | Whether address has been validated |
events[].location_address.delivery_instructions | string | No | Special delivery notes |
events[].location_id | string | No | Location ID; points to CommerceLocation (reference to ShippingLocation) |
events[].location_name | string | No | Location name |
events[].notes | string | No | Additional notes |
events[].signed_by | string | No | Who signed for delivery |
estimated_delivery | string (date-time) | No | Estimated delivery date |
actual_delivery_at | string (date-time) | No | Actual delivery timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
status_description | string | No | Human-readable status |
carrier_id | string | No | Reference to the carrier |
carrier_status_code | string | No | Carrier's status code |
carrier_status_description | string | No | Carrier's status description |
Are we missing anything? Let us know