The reserved stock object

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

A reserved stock object is returned as part of the response body of each successful list or retrieve API call to the /api/reserved_stocks endpoint.

Fields

FieldTypeDescription

type

string

reserved_stocks

id

string

The reserved stock unique identifier

links.self

string

The reserved stock endpoint URL

attributes.quantity

integer

The stock item reserved quantity.

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_item

object

The associated stock item.

relationships.sku

object

The associated SKU.

relationships.stock_reservations

array

The associated stock reservations.

relationships.versions

array

The associated changes.

meta.mode

string

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

Last updated