Salesforce B2C Commerce 24.7 > Open Commerce API 23.2 > Shop API documents 23.2

Inventory document (Shop API 23.2)

Document representing inventory information of the current product for a particular inventory list.

Property Type Constraints Description
ats Decimal   The ats of the product. If it is infinity, the return value is 999999. The value can be overwritten by the OCAPI setting 'product.inventory.ats.max_threshold'.
backorderable Boolean   A flag indicating whether the product is back orderable.
id String mandatory=true, nullable=false The inventory id.
in_stock_date DateTime   A flag indicating the date when the product will be in stock.
orderable Boolean   A flag indicating whether at least one of products is available to sell.
preorderable Boolean   A flag indicating whether the product is pre orderable.
stock_level Decimal   The stock level of the product. If it is infinity, the return value is 999999. The value can be overwritten by the OCAPI setting 'product.inventory.stock_level.max_threshold'.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.