Channel Menu Selection Structure

Menu selection in the cart

Type: object Properties: 6 Required: 2
Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants

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

Properties

id referenceId externalReferenceId quantity price menuSelections

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-selection-structure.json",
  "name": "MenuSelection",
  "description": "Menu selection in the cart",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Menu item identifier",
      "example": "item_42"
    },
    "referenceId": {
      "type": "string",
      "description": "Secondary menu item identifier.\n\n\u26a0\ufe0f This `referenceId` must be included along with the `id` when the value is present in the menu\n",
      "example": "item_603"
    },
    "externalReferenceId": {
      "$ref": "#/components/schemas/ExternalReferenceId"
    },
    "quantity": {
      "type": "double",
      "minimum": 0,
      "example": 1
    },
    "price": {
      "$ref": "#/components/schemas/Money"
    },
    "menuSelections": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/components/schemas/MenuSelection"
      }
    }
  },
  "required": [
    "id",
    "quantity"
  ]
}