The inventory model object
A comprehensive list of the inventory model resource's attributes and relationships
An inventory model object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/inventory_models
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The inventory model unique identifier |
links.self |
| The inventory model endpoint URL |
attributes.created_at |
| Time at which the resource was created. |
attributes.manual_stock_decrement |
| Indicates if the the stock will be decremented manually after the order approval. |
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.name |
| The inventory model's internal name. |
attributes.put_stock_transfers_on_hold |
| Indicates if the the stock transfers must be put on hold automatically with the associated shipment. |
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.stock_locations_cutoff |
| The maximum number of stock locations used for inventory computation. |
attributes.stock_reservation_cutoff |
| The duration in seconds of the generated stock reservations. |
attributes.strategy |
| The inventory model's shipping strategy: one between 'no_split' (default), 'split_shipments', 'ship_from_primary' and 'ship_from_first_available_or_primary'. |
attributes.updated_at |
| Time at which the resource was last updated. |
relationships.attachments |
| The associated attachments. |
relationships.inventory_return_locations |
| The resources that assign a priority to each inventory model return location. |
relationships.inventory_stock_locations |
| The resources that assign a priority to each inventory model stock location. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated