Represents the tracking status and event history of a shipment.
Properties
| Property | Type | Required | Description |
|---|
| TrackingNumber | string | Yes | Carrier tracking number. |
| Status | TrackingStatus | Yes | Current tracking status enum. |
| Events | List<TrackingEvent> | No | A list of historical tracking events. |
TrackingStatus Enum
| Value | Description |
|---|
Unknown | Status is unknown. |
DataReceived | Shipping information has been received by the system. |
InTransit | Shipment is currently in transit. |
Delivered | Shipment has been successfully delivered. |
DeliverFailed | Delivery attempt failed. |
TrackingEvent Object
| Property | Type | Required | Description |
|---|
| TimeLocal | DateTime | Yes | Event timestamp in local time(e.g. 2026-03-13T15:36:22). |
| TimeUtc | DateTime | No | Event timestamp in UTC(e.g. 2026-03-13T19:36:22Z). |
| TimezoneOffset | string | No | Local timezone offset (e.g. -04:00). |
| CarrierEventCode | string | No | Carrier-specific event code. |
| Description | string | No | Description of the tracking event. |
| Location | TrackingLocation | No | Geographical location where the event occurred. |
TrackingLocation Object
| Property | Type | Description |
|---|
| CountryCode | string | ISO 2-letter country code. |
| City | string | City name. |
| Province | string | State or province name / code. |
| Postcode | string | Postal code. |