Stock API (1.0.0)

The stock API lets you retrieve and update inventory information for a restaurant's menu items and modifiers.

Note: Modifiers are supported by an underlying menu item, called the modifier's item reference. In this reference, the term "menu item" is used to generically refer to both standalone menu items and modifier item references, because the same data is used for both. For more information, see Understanding a modifier option's item reference.

You can use the stock API to:

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

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
[
  • {
    }
]