The stock item object

A comprehensive list of the stock item resource's attributes and relationships

A stock item object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/stock_items endpoint.

Fields

Field	Type	Description
type	string	stock_items
id	string	The stock item unique identifier
links.self	string	The stock item endpoint URL
attributes.sku_code	string	The code of the associated SKU.
attributes.quantity	integer	The stock item quantity.
attributes._validate	boolean	Send this attribute if you want to validate the stock item quantity against the existing reserved stock one, returns an error in case the former is smaller.
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.stock_location	object	The associated stock location.
relationships.sku	object	The associated stock SKU.
relationships.reserved_stock	object	The associated reserved stock.
relationships.stock_reservations	array	The associated stock reservations.
relationships.attachments	array	The associated attachments.
relationships.versions	array	The associated changes.
meta.mode	string	The resource environment (can be one of test or live)