The shipment object
A comprehensive list of the shipment resource's attributes and relationships
A shipment object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/shipments
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The shipment unique identifier |
links.self |
| The shipment endpoint URL |
attributes.number |
| Unique identifier for the shipment |
attributes.status |
| The shipment status, one of 'draft', 'upcoming', 'cancelled', 'on_hold', 'picking', 'packing', 'ready_to_ship', or 'shipped' |
attributes.currency_code |
| The international 3-letter currency code as defined by the ISO 4217 standard, automatically inherited from the associated order. |
attributes.cost_amount_cents |
| The cost of this shipment from the selected carrier account, in cents. |
attributes.cost_amount_float |
| The cost of this shipment from the selected carrier account, float. |
attributes.formatted_cost_amount |
| The cost of this shipment from the selected carrier account, formatted. |
attributes.skus_count |
| The total number of SKUs in the shipment's line items. This can be useful to display a preview of the shipment content. |
attributes._upcoming |
| Send this attribute if you want to mark this shipment as upcoming. |
attributes._on_hold |
| Send this attribute if you want to put this shipment on hold. |
attributes._picking |
| Send this attribute if you want to start picking this shipment. |
attributes._packing |
| Send this attribute if you want to start packing this shipment. |
attributes._ready_to_ship |
| Send this attribute if you want to mark this shipment as ready to ship. |
attributes._ship |
| Send this attribute if you want to mark this shipment as shipped. |
attributes._reserve_stock |
| Send this attribute if you want to automatically reserve the stock for each of the associated stock line item. Can be done only when fulfillment is in progress. |
attributes._release_stock |
| Send this attribute if you want to automatically destroy the stock reservations for each of the associated stock line item. Can be done only when fulfillment is in progress. |
attributes._decrement_stock |
| Send this attribute if you want to automatically decrement and release the stock for each of the associated stock line item. Can be done only when fulfillment is in progress. |
attributes._get_rates |
| Send this attribute if you want get the shipping rates from the associated carrier accounts. |
attributes.selected_rate_id |
| The selected purchase rate from the available shipping rates. |
attributes.rates |
| The available shipping rates. |
attributes._purchase |
| Send this attribute if you want to purchase this shipment with the selected rate. |
attributes.purchase_error_code |
| The shipping rate purchase error code, if any. |
attributes.purchase_error_message |
| The shipping rate purchase error message, if any. |
attributes.get_rates_errors |
| Any errors collected when fetching shipping rates. |
attributes.get_rates_started_at |
| Time at which the getting of the shipping rates started. |
attributes.get_rates_completed_at |
| Time at which the getting of the shipping rates completed. |
attributes.purchase_started_at |
| Time at which the purchasing of the shipping rate started. |
attributes.purchase_completed_at |
| Time at which the purchasing of the shipping rate completed. |
attributes.purchase_failed_at |
| Time at which the purchasing of the shipping rate failed. |
attributes.on_hold_at |
| Time at which the shipment was put on hold. |
attributes.picking_at |
| Time at which the shipment was picking. |
attributes.packing_at |
| Time at which the shipment was packing. |
attributes.ready_to_ship_at |
| Time at which the shipment was ready to ship. |
attributes.shipped_at |
| Time at which the shipment was shipped. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
relationships.order |
| The associated order. |
relationships.shipping_category |
| The shipping category of the associated line items (SKUs). Can be updated only when fulfillment is in progress. |
relationships.inventory_stock_location |
| The inventory stock location from which the shipment is managed. Can be updated only when fulfillment is in progress. |
relationships.stock_location |
| The stock location associated to the inventory. |
relationships.origin_address |
| The associated stock location address. |
relationships.shipping_address |
| The customer shipping address. Can be updated only when fulfillment is in progress. |
relationships.shipping_method |
| The shipping method selected by the customer. |
relationships.delivery_lead_time |
| The delivery lead time for the shipment. Equals the one associated with the shipping method selected by the customer. |
relationships.stock_line_items |
| The associated stock line items. |
relationships.stock_transfers |
| The associated stock transfers. |
relationships.line_items |
| The line items included in the shipment. |
relationships.available_shipping_methods |
| The available shipping methods for the shipment. Useful to present the customer with a list of choices during the checkout. Only enabled shipping methods are included in the list. |
relationships.carrier_accounts |
| The carrier accounts available for the order's market. |
relationships.parcels |
| The associated parcels. |
relationships.attachments |
| The associated attachments. |
relationships.events |
| The associated events. |
relationships.tags |
| The associated tags. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated