Stock API (1.0.0)

The Stock API retrieves inventory information for menu items and modifier options from a restaurant.

You can use the Stock API to:

  • Get all inventory information for a restaurant.
  • Get the inventory for a list of menu items.
  • Get the inventory of a restaurant given a specific status of the menu items (such as all menu items that are out of stock).

Get menu item inventory for a restaurant

All item inventory for a restaurant will be returned. Inventory information is not returned for menu items with an IN_STOCK status. You can restrict the menu items in the response data to either OUT_OF_STOCK or QUANTITY inventory status using the status query parameter.

Request
query Parameters
status
string

Selects the inventory status of the menu items in the response data. Values are:

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

  • QUANTITY - Returns all menu items that have the QUANTITY inventory 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
[
  • {
    }
]