The Shipment Object
id
Unique identifier for the shipment.
state
The current status of the shipment, must be one of: packed, shipped, delivered, canceled.
warehouse_id
The identifier of the warehouse fulfilling the shipment.
packed_at
UTC ISO8601 timestamp when the shipment was packed.
carrier
The name of the carrier handling the shipment, such as USPS, UPS, FedEx, etc.
tracking_number
The unique tracking number for the shipment, which must be provided when the shipment is updated to the shipped state.
tracking_url
The URL used to track the shipment on the carrier’s website. It should include the tracking_number as part of the query or path.
shipped_at
UTC ISO8601 timestamp when the shipment was shipped. This field is required when updating the shipment to the shipped state.
expected_to_deliver_at
UTC ISO8601 timestamp indicating when the shipment is expected to be delivered.
delivered_at
UTC ISO8601 timestamp when the shipment was delivered. This field is required when updating the shipment to the delivered state.
canceled_at
UTC ISO8601 timestamp when the shipment was canceled. This field is required when updating the shipment to the canceled state.