An order can be configured to ship from a single stock location (i.e. primary). In this scenario the number of shipments is minimized by creating one or more stock transfers from the stock location where the items are available to the primary one. Shipping categories are still honored, by creating different shipments. Stock transfers can also be created outside of the order scope, in such case they have no relationships with shipments and line items.
A stock transfer object is returned as part of the response body of each successful list, retrieve, create or update API call.
Field | Type | Description |
type |
|
|
id |
| The stock transfer unique identifier |
links.self |
| The stock transfer endpoint URL |
attributes.sku_code |
| The code of the associated sku. |
attributes.status |
| The stock transfer status, one of 'draft', 'upcoming', 'picking', 'in_transit', 'completed', or 'cancelled' |
attributes.quantity |
| The stock quantity to be transferred from the origin stock location to destination one |
attributes.completed_at |
| Time at which the stock transfer was completed. |
attributes.cancelled_at |
| Time at which the stock transfer was cancelled. |
attributes._upcoming |
| Send this attribute if you want to mark this stock transfer as upcoming. |
attributes._picking |
| Send this attribute if you want to start picking this stock transfer. |
attributes._in_transit |
| Send this attribute if you want to mark this stock transfer as in transit. |
attributes._complete |
| Send this attribute if you want to complete this stock transfer. |
attributes._cancel |
| Send this attribute if you want to cancel this stock transfer. |
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.sku |
| The associated sku. |
relationships.origin_stock_location |
| The origin stock location. |
relationships.destination_stock_location |
| The destination stock location. |
relationships.shipment |
| The associated shipment. |
relationships.line_item |
| The associated line_item. |
meta.mode |
| The resource environment (can be one of |