Inventory models

The inventory model object and its fields

An inventory model defines a list of stock locations ordered by priority. The order determines 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 (learn more).

The inventory model object

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

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.id

string

Unique identifier for the resource (hash).

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 your own identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool or a CRM.

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.stock_levels

array

The resources that assign a priority to each inventory model stock location.

meta.mode

string

The resource environment (can be one of test or live)