Updates inventory information for specific menu items

Updates inventory information for a list of menu items.

Securityoauth2
Request
header Parameters
Toast-Restaurant-External-ID
required
string

The Toast GUID of the restaurant whose inventory information will be updated.

Request Body schema: application/json

An array of MenuItemInventoryUpdate objects for the menu items to be updated, with the following values:

  • An identifier for the menu item to be updated. This may be either the menu item's multiLocationId or its guid. See Toast identifiers for more information on these two identifier types.

  • The status for the menu item. Must be one of the following:

    • IN_STOCK
    • OUT_OF_STOCK
    • QUANTITY

  • For menu items with a status of QUANTITY, you must also provide a quantity value that is a double greater than 0 (such as 0.5, 7.0, or 10.75). Do not include a quantity value for menu items with a status of IN_STOCK or OUT_OF_STOCK.

guid
string <uuid>

The unique GUID assigned to the menu item by the Toast platform.

itemGuidValidity
string

This value, which is only included in the MenuItemInventory object when the /inventory/search endpoint is queried, indicates whether the menu item GUID is valid or not. A menu item GUID is not valid if the menu item does not exist at the restaurant being queried or it has been archived. The itemGuidValidity value can be:

  • VALID - The menu item exists at the restaurant being queried and it has not been archived.

  • INVALID - The menu item either does not exist at the restaurant being queried or it has been archived.

Enum: "VALID" "INVALID"
multiLocationId
string

A consistent identifier that applies to all versions of a menu item that is shared across locations.

See Toast identifiers for more information.

quantity
number <double>

Contains the amount of stock remaining when the menu item status is QUANTITY.

This value is null for menu items that have a stock staus of IN_STOCK or OUT_OF_STOCK.

status
string

The inventory status of the menu item. The status value can be:

  • IN_STOCK - The menu item is in stock in the restaurant.

  • QUANTITY - The menu item is in limited supply. The amount of remaining items is indicated by the quantity value.

  • OUT_OF_STOCK - The menu item is no longer in stock and cannot be selected for an order.

Enum: "IN_STOCK" "QUANTITY" "OUT_OF_STOCK"
versionId
string <uuid>

For future use.

Responses
200

Successful operation

404

One or more of the specified menu items could not be found. The entire update request fails. The GUIDs for the menu items that couldn't be found are provided in the message value of the response's message body.

put/inventory/update
Request samples
application/json
{
  • "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  • "itemGuidValidity": "VALID",
  • "status": "IN_STOCK",
  • "quantity": 0,
  • "multiLocationId": "string",
  • "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7"
}
Response samples
application/json
[
  • {
    }
]