Module shopperAvailability

id: The id (SKU) of the product.

• Min Length: 1
• Max Length: 100

inventories: The array of inventory information for the product.

limit: The number of returned product entries in the data array.

data: The array of product availability entries. Each entry represents one product (SKU) with available inventory across the requested inventory lists.

total: The total number of distinct product entries in the data array, not individual inventory records.

title: A short, human-readable summary of the problem type. It will not change from occurrence to occurrence of the problem, except for purposes of localization

• Max Length: 256

type: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

• Max Length: 2048

detail: A human-readable explanation specific to this occurrence of the problem.

instance: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

• Max Length: 2048

ats: The Available To Sell (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: A flag indicating whether the product is backorderable.

id: The inventory ID.

• Min Length: 1
• Max Length: 256

inStockDate: A flag indicating the date when the product will be in stock.

orderable: A flag indicating whether at least one of the products is available to sell.

preorderable: A flag indicating whether the product is preorderable.

stockLevel: 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'.