Skip to main content
​
string<date-time>
required
The datetime the shipment was created.Example: 2023-12-01T05:00:00.401Z
​
string<date-time> | null
required
The estimated delivery date for this shipment. Null if the carrier has not provided an estimate.Example: 2023-12-01T05:00:00.401Z
​
string
required
The unique identifier for the shipment.Example: ship_xxxxxxxxxxxxx
​
object | null
required
The payment associated with this shipment. Null if the payment has been deleted or is inaccessible.
​
string | null
required
The shipping service level used for this shipment. Null if the carrier does not specify a service tier.Example: Priority
​
ShipmentStatuses
required
The current delivery status of this shipment.Available options: unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error
​
ShipmentSubstatuses | null
required
A more granular status providing additional detail about the shipment’s current state. Null if no substatus applies.Available options: address_correction, arrived_at_destination, arrived_at_facility, arrived_at_pickup_location, awaiting_information, substatus_cancelled, damaged, delayed, delivery_exception, departed_facility, departed_origin_facility, expired, substatus_failure, held, substatus_in_transit, label_created, lost, missorted, substatus_out_for_delivery, received_at_destination_facility, received_at_origin_facility, refused, return, status_update, transferred_to_destination_carrier, transit_exception, substatus_unknown, weather_delay
​
string
required
The carrier-assigned tracking number used to look up shipment progress.Example: 9400111899223456789012
​
string<date-time>
required
The datetime the shipment was last updated.Example: 2023-12-01T05:00:00.401Z