Shipments
An order can be split into more shipments for one of the following reasons:
The order contains line items from more than one stock location.
The order contains line items belonging to more than one shipping category.
The combination of stock locations and shipping categories determines the number of shipments. Each shipment gets fulfilled separately.
A shipment object is returned as part of the response body of each successful create, list, retrieve, or update API call.
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._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._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._purchase |
| Send this attribute if you want to purchase this shipment with the selected rate. |
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). |
relationships.stock_location |
| The stock location from which the shipment is managed. |
relationships.shipping_address |
| The customer shipping address. |
relationships.shipping_method |
| The shipping method selected by the customer. |
relationships.shipment_line_items |
| The order line items assigned to 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.parcels |
| The parcels associated to the shipment. |
relationships.attachments |
| The attachments associated to the shipment. |
meta.mode |
| The resource environment (can be one of |
