> For the complete documentation index, see [llms.txt](https://docs.commercelayer.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.commercelayer.io/core-api-reference/stock_transfers/object.md). # The stock transfer object 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** | `string` | `stock_transfers` | | **id** | `string` | The stock transfer unique identifier | | links.**self** | `string` | The stock transfer endpoint URL | | attributes.**number** | `string` | Unique identifier for the stock transfer (numeric). | | attributes.**sku\_code** | `string` | The code of the associated SKU. | | attributes.**status** | `string` | The stock transfer status. One of 'draft' (default), 'upcoming', 'on\_hold', 'picking', 'in\_transit', 'completed', or 'cancelled'. | | attributes.**quantity** | `integer` | The stock quantity to be transferred from the origin stock location to destination one. Updatable unless stock transfer is completed or cancelled and depending on origin stock availability. | | attributes.**on\_hold\_at** | `string` | Time at which the stock transfer was put on hold. | | attributes.**picking\_at** | `string` | Time at which the stock transfer was picking. | | attributes.**in\_transit\_at** | `string` | Time at which the stock transfer was in transit. | | attributes.**completed\_at** | `string` | Time at which the stock transfer was completed. | | attributes.**cancelled\_at** | `string` | Time at which the stock transfer was cancelled. | | attributes.**\_upcoming** | `boolean` | Send this attribute if you want to mark this stock transfer as upcoming. | | attributes.**\_on\_hold** | `boolean` | Send this attribute if you want to put this stock transfer on hold. | | attributes.**\_picking** | `boolean` | Send this attribute if you want to start picking this stock transfer. | | attributes.**\_in\_transit** | `boolean` | Send this attribute if you want to mark this stock transfer as in transit. | | attributes.**\_complete** | `boolean` | Send this attribute if you want to complete this stock transfer. | | attributes.**\_cancel** | `boolean` | Send this attribute if you want to cancel this stock transfer. | | attributes.**created\_at** | `string` | Time at which the resource was created. | | attributes.**updated\_at** | `string` | Time at which the resource was last updated. | | attributes.**reference** | `string` | 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** | `string` | Any identifier of the third party system that defines the reference code. | | attributes.**metadata** | `object` | 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** | `object` | The associated SKU. | | relationships.**origin\_stock\_location** | `object` | The origin stock location. | | relationships.**destination\_stock\_location** | `object` | The destination stock location. | | relationships.**shipment** | `object` | The associated shipment. | | relationships.**line\_item** | `object` | The associated line\_item. | | relationships.**stock\_reservation** | `object` | The associated stock reservation. | | relationships.**attachments** | `array` | The associated attachments. | | relationships.**events** | `array` | The associated events. | | relationships.**event\_stores** | `array` | The associated event stores. | | meta.**mode** | `string` | The resource environment (can be one of `test` or `live`) | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.commercelayer.io/core-api-reference/stock_transfers/object.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.