The inventory stock location object
A comprehensive list of the inventory stock location resource's attributes and relationships
An inventory stock location object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/inventory_stock_locations
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The inventory stock location unique identifier |
links.self |
| The inventory stock location endpoint URL |
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.on_hold |
| Indicates if the shipment should be put on hold if fulfilled from the associated stock location. This is useful to manage use cases like back-orders, pre-orders or personalized orders that need to be customized before being fulfilled. |
attributes.priority |
| The stock location priority within the associated invetory model. |
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.updated_at |
| Time at which the resource was last updated. |
relationships.inventory_model |
| The associated inventory model. |
relationships.stock_location |
| The associated stock location. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated