Menu Stock Status contains data about the availability of menu items.

Methods

Retrieve POS Menu Stock statuses that are available for integration.

GET /online-ordering/v3/{locationId}/menu/stock-status

Response 200

Menu stock status data

{
  "items": [
    {
      "itemRef": "string",
      "status": "LOW_STOCK"
    }
  ]
}

Definitions

Indicates Menu Item stock status

Name	Type	Description
itemRef*	string	The POS Menu Item reference
status*	string	`LOW_STOCK` - The item stock is low `OUT_OF_STOCK` - The item is out of stock