MenuItemInventory

Contains the stock status and quantity information for a menu item.

• guid:
  string <uuid>

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

• itemGuidValidity read-only:
  string

  Indicates whether a menu item identifier that you included in your request is valid or not.

  INVALID indicates the stock API did not find a matching menu item for the identifier you supplied in the search or update request. This means either the menu item does not exist at the location being queried or it has been archived.

  VALID indicates that the item in the API response is a valid item at the restaurant location.

  For more information, see Getting stock information using the stock API and Updating stock API.

  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 or null <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.

{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "itemGuidValidity": "VALID",
  "status": "IN_STOCK",
  "quantity": 0,
  "multiLocationId": "string",
  "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7"
}