Stock API (1.0.0)

Download OpenAPI specification:Download

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.

Data definitions