The stock transfer object
A comprehensive list of the stock transfer resource's attributes and relationships
A stock transfer object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/stock_transfers
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The stock transfer unique identifier |
links.self |
| The stock transfer endpoint URL |
attributes._cancel |
| Send this attribute if you want to cancel this stock transfer. |
attributes._complete |
| Send this attribute if you want to complete this stock transfer. |
attributes._in_transit |
| Send this attribute if you want to mark this stock transfer as in transit. |
attributes._on_hold |
| Send this attribute if you want to put this stock transfer on hold. |
attributes._picking |
| Send this attribute if you want to start picking this stock transfer. |
attributes._upcoming |
| Send this attribute if you want to mark this stock transfer as upcoming. |
attributes.cancelled_at |
| Time at which the stock transfer was cancelled. |
attributes.completed_at |
| Time at which the stock transfer was completed. |
attributes.created_at |
| Time at which the resource was created. |
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. |
attributes.number |
| Unique identifier for the stock transfer (numeric). |
attributes.quantity |
| The stock quantity to be transferred from the origin stock location to destination one. |
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.sku_code |
| The code of the associated SKU. |
attributes.status |
| The stock transfer status. One of 'draft' (default), 'upcoming', 'on_hold', 'picking', 'in_transit', 'completed', or 'cancelled'. |
attributes.updated_at |
| Time at which the resource was last updated. |
relationships.attachments |
| The associated attachments. |
relationships.destination_stock_location |
| The destination stock location. |
relationships.events |
| The associated events. |
relationships.line_item |
| The associated line_item. |
relationships.origin_stock_location |
| The origin stock location. |
relationships.shipment |
| The associated shipment. |
relationships.sku |
| The associated SKU. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated