This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Inventory

The stock webhook and stock API both provide information about changes to the stock status (in stock, out of stock, low quantity) of menu items and modifier options. With the stock webhook, the Toast platform pushes updates to your system when the stock status of a menu item or modifier option changes. This is the preferred method for getting information about changes in stock status.

Using the stock API, you can retrieve a list of menu items that are out of stock and/or in limited supply. You can also submit a list of menu items to the stock API and it will return their current stock status.

Stock updates do not represent changes to the menu itself. Consuming stock updates does not require retrieving menu information. Only retrieve a new menu when the /metadata endpoint of the menus API indicates that the menu JSON is outdated. For more information about when to retrieve a new menu, see Determining If a Restaurant's Menu Data Has Gone Stale.

Note

Modifier options are supported by an underlying menu item, called the modifier option's item reference. Therefore, in this section, the term menu item is used to generically refer to both standalone menu items and modifier option item references, because the same data is returned for both entities. For detailed information on modifier option item references, see Understanding a modifier option's item reference.

Note

Scheduled future orders decrement quantity-based stock count immediately upon order placement. In the following example, a restaurant location has ten cookies in stock on Monday. If a guest places a catering order on Monday to be fulfilled on Friday and this order includes a cookie, the cookie stock count will decrement to nine on Monday (not on Friday). For more information about scheduling future orders, see Scheduling future orders.

The following sections provide more information about the stock webhook and the stock API: