Restaurant Brands International · JSON Structure

Channel Menu Structure

Store menu

Type: object Properties: 7 Required: 4
Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants

Menu is a JSON Structure definition published by Restaurant Brands International, describing 7 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

meta dayParts rootMenuEntryId entries systemWideOfferEntries rewardEntries configOfferEntries

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/restaurant-brands/refs/heads/main/json-structure/channel-menu-structure.json",
  "name": "Menu",
  "description": "Store menu\n",
  "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"
  ]
}