MenuSelection

Menu selection in the cart

Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants

Properties

Name Type Description
id string Menu item identifier
referenceId string Secondary menu item identifier. ⚠️ This `referenceId` must be included along with the `id` when the value is present in the menu
externalReferenceId object
quantity number
price object
menuSelections array
View JSON Schema on GitHub

JSON Schema

channel-menu-selection-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "MenuSelection",
  "description": "Menu selection in the cart",
  "$id": "https://raw.githubusercontent.com/api-evangelist/restaurant-brands/refs/heads/main/json-schema/channel-menu-selection-schema.json",
  "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": "number",
      "format": "integer",
      "minimum": 0,
      "example": 1
    },
    "price": {
      "$ref": "#/components/schemas/Money"
    },
    "menuSelections": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/components/schemas/MenuSelection"
      }
    }
  },
  "required": [
    "id",
    "quantity"
  ]
}