Menu

Store menu

Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants

Properties

Name Type Description
meta object Metadata about the menu document
dayParts array Categories of menu availability by day and time
rootMenuEntryId object Reference to root menu entry
entries array All valid menu entries
systemWideOfferEntries array All System-Wide Offer Entries
rewardEntries array All Reward Entries
configOfferEntries array All Config Offer Entries
View JSON Schema on GitHub

JSON Schema

channel-menu-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Menu",
  "description": "Store menu\n",
  "$id": "https://raw.githubusercontent.com/api-evangelist/restaurant-brands/refs/heads/main/json-schema/channel-menu-schema.json",
  "type": "object",
  "properties": {
    "meta": {
      "description": "Metadata about the menu document",
      "properties": {
        "brand": {
          "$ref": "#/components/schemas/Brand"
        },
        "currency": {
          "$ref": "#/components/schemas/Currency"
        },
        "locale": {
          "$ref": "#/components/schemas/Locale"
        },
        "serviceMode": {
          "type": "string",
          "enum": [
            "delivery",
            "pickup"
          ]
        },
        "version": {
          "type": "string",
          "example": "xyz1"
        }
      },
      "example": "example"
    },
    "dayParts": {
      "description": "Categories of menu availability by day and time\n",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DayPart"
      }
    },
    "rootMenuEntryId": {
      "$ref": "#/components/schemas/EntryId",
      "description": "Reference to root menu entry"
    },
    "entries": {
      "description": "All valid menu entries\n",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Entry"
      }
    },
    "systemWideOfferEntries": {
      "description": "All System-Wide Offer Entries\n",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SystemWideOfferEntry"
      }
    },
    "rewardEntries": {
      "description": "All Reward Entries\n",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RewardEntry"
      }
    },
    "configOfferEntries": {
      "description": "All Config Offer Entries\n",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConfigOfferEntry"
      }
    }
  },
  "required": [
    "meta",
    "dayParts",
    "rootMenuEntryId",
    "entries"
  ]
}