Toast · Schema

MenuItemInventory

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

Food ServicePoint of SaleRestaurantsHospitality

Properties

Name	Type	Description
guid	string	The unique GUID assigned to the menu item by the Toast platform.
itemGuidValidity	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 s
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
quantity	number	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`.
multiLocationId	string	A consistent identifier that applies to all versions of a menu item that is shared across locations. See Toast identifiers
versionId	string	For future use.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-schema/stock-menu-item-inventory-schema.json",
  "title": "MenuItemInventory",
  "description": "Contains the stock status and quantity information for a menu item.",
  "type": "object",
  "properties": {
    "guid": {
      "type": "string",
      "description": "The unique GUID assigned to the menu item by the Toast platform.\n",
      "format": "uuid"
    },
    "itemGuidValidity": {
      "type": "string",
      "description": "Indicates whether a menu item identifier that you included in your request is valid or not.\n\n`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.\n            \n`VALID` indicates that the item in the API response is a valid item at the restaurant location.\n\nFor more information, see <a\nhref=\"https://doc.toasttab.com/doc/devguide/apiUsingTheStockApi.html\">Getting stock information using the stock API</a> and <a\nhref=\"https://doc.toasttab.com/doc/devguide/apiUpdatingInventoryInformation.html\">Updating stock API</a>.          \n",
      "readOnly": true,
      "enum": [
        "VALID",
        "INVALID"
      ]
    },
    "status": {
      "type": "string",
      "description": "The inventory status of the menu item. The `status` value can be:\n\n* `IN_STOCK` - The menu item is in stock in the restaurant.\n\n* `QUANTITY` - The menu item is in limited supply. The amount\nof remaining items is indicated by the `quantity` value.\n\n* `OUT_OF_STOCK` - The menu item is no longer in stock and cannot\nbe selected for an order.\n",
      "enum": [
        "IN_STOCK",
        "QUANTITY",
        "OUT_OF_STOCK"
      ]
    },
    "quantity": {
      "type": "number",
      "nullable": true,
      "description": "Contains the amount of stock remaining when the menu item\n`status` is `QUANTITY`.\n\nThis value is `null` for menu items\nthat have a stock staus of `IN_STOCK` or `OUT_OF_STOCK`.\n",
      "format": "double"
    },
    "multiLocationId": {
      "type": "string",
      "description": "A consistent identifier that applies to all versions of a menu item\nthat is shared across locations.\n\nSee <a\nhref=\"https://doc.toasttab.com/doc/devguide/portalToastIdentifiers.html\">Toast\nidentifiers</a> for more information.\n"
    },
    "versionId": {
      "type": "string",
      "description": "For future use.\n",
      "format": "uuid"
    }
  }
}