API reference
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
string
inventory_models
id
string
The inventory model unique identifier
links.self
string
The inventory model endpoint URL
attributes.name
string
The inventory model's internal name.
attributes.strategy
string
The inventory model's shipping strategy: one between 'split_shipments' (default), 'ship_from_primary' and 'ship_from_first_available_or_primary'.
attributes.stock_locations_cutoff
integer
The maximum number of stock locations used for inventory computation
attributes.created_at
datetime
Time at which the resource was created.
attributes.updated_at
datetime
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.inventory_stock_locations
array
The resources that assign a priority to each inventory model stock location.
relationships.inventory_return_locations
array
The resources that assign a priority to each inventory model return location.
relationships.attachments
array
The associated attachments.
meta.mode
string
The resource environment (can be one of test or live)
Copy link
Contents
Fields