An inventory model defines a list of stock locations ordered by priority. The priority and cutoff determine how the availability of SKUs gets calculated within a market. If an order contains line items from two or more stock locations, the order is split into two or more shipments, one for each location.
An inventory model object is returned as part of the response body of each successful create, list, retrieve, or update API call.
Field | Type | Description |
type |
|
|
id |
| The inventory model unique identifier |
links.self |
| The inventory model endpoint URL |
attributes.name |
| The inventory model's internal name |
attributes.stock_locations_cutoff |
| The maximum number of stock locations used for inventory computation |
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.inventory_stock_locations |
| The resources that assign a priority to each inventory model stock location. |
relationships.inventory_return_locations |
| The resources that assign a priority to each inventory model return location. |
meta.mode |
| The resource environment (can be one of |