Get menu item inventory for a restaurant

Returns inventory information for all menu items that have an OUT_OF_STOCK or QUANTITY status.

Inventory information is not returned for menu items with an IN_STOCK status, because they are not considered at risk for going out of stock.

To restrict the menu items in the response to either OUT_OF_STOCK or QUANTITY stock status, use the status query parameter.

Request
query Parameters
status
string

Limits the items in the response to those items with the specified stock status. Values are:

  • OUT_OF_STOCK- Returns all menu items that have the OUT_OF_STOCK stock status.

  • QUANTITY - Returns all menu items that have the QUANTITY stock status.

header Parameters
Toast-Restaurant-External-ID
required
string

The Toast GUID of the restaurant queried for inventory information.

Responses
200

Successful operation

404

Restaurant did not have any inventory information.

get/inventory
Request samples
curl -i -X GET \
  'https://toast-api-server/stock/v1/inventory?status=string' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
[
  • {
    }
]