Stock API and webhook improvements

Several improvements and updates have been made to the stock API and the stock webhook.

New identifier values in stock API and stock webhook payload

The stock API and stock webhook payloads include two additional identifiers:

• multiLocationId is a consistent identifier that applies to all versions of a menu item that is shared across locations. Toast support recommends using the multiLocationId instead of a menu item guid, when submitting requests to Toast APIs. For more information, see Toast identifiers.

• versionId has been added for future use.

Stock API search endpoint accepts multi-location IDs or GUIDs

When making a request to the /inventory/search endpoint, the message body you submit can now contain either multi-location IDs or GUIDs to identify the menu items you want to retrieve inventory information for. For more information, see Getting stock information using the stock API.

New stock API endpoint to update inventory information

The stock API has a new /inventory/update endpoint that you can use to update inventory information for menu items or modifiers. You can set one of the following status values for a menu item or modifier:

• IN_STOCK

• OUT_OF_STOCK

• QUANTITY - If you set an item status to QUANTITY, you must also provide a quantity value with double data type. For example, you can set the quantity to 0.5, 7.0, or 10.75.

For more information, see Updating stock.