MenuEntry

Represents a single menu entry

Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants

Properties

Name Type Description
availability object Whether or not the entry is available.
dayParts array Collection of references to the item's day parts. The item should only be available during the associated day parts.
description object Text that has been translated to the correct locale for the current context
displayGroup string Display group id
id string Unique identifier for a menu entry
image object
name object Text that has been translated to the correct locale for the current context
nutrition object Nutrition Details
options object
price object Base prices for this entry
productType array Product type enum values
quantity object Quantity constraints (min, max, default) for ordering this entry. The max value represents the maximum amount of this specific entry that can be included in a single order.
type string Entry type enum values
View JSON Schema on GitHub

JSON Schema

menu-v2-menu-entry-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "MenuEntry",
  "description": "Represents a single menu entry",
  "$id": "https://raw.githubusercontent.com/api-evangelist/restaurant-brands/refs/heads/main/json-schema/menu-v2-menu-entry-schema.json",
  "type": "object",
  "properties": {
    "availability": {
      "$ref": "#/components/schemas/Availability",
      "description": "Whether or not the entry is available."
    },
    "dayParts": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Collection of references to the item's day parts. The item should only be available during the associated day parts.\n",
      "example": []
    },
    "description": {
      "$ref": "#/components/schemas/LocalizedString",
      "description": "Text that has been translated to the correct locale for the current context"
    },
    "displayGroup": {
      "type": "string",
      "description": "Display group id",
      "example": "example"
    },
    "id": {
      "type": "string",
      "description": "Unique identifier for a menu entry",
      "example": "500123"
    },
    "image": {
      "$ref": "#/components/schemas/Image"
    },
    "name": {
      "$ref": "#/components/schemas/LocalizedString",
      "description": "Text that has been translated to the correct locale for the current context"
    },
    "nutrition": {
      "$ref": "#/components/schemas/Nutrition",
      "description": "Nutrition Details"
    },
    "options": {
      "$ref": "#/components/schemas/EntryOptions"
    },
    "price": {
      "$ref": "#/components/schemas/EntryPrice",
      "description": "Base prices for this entry"
    },
    "productType": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "DRINKS",
          "DESSERTS",
          "FROZEN_DRINKS",
          "JUICES",
          "SHAKES",
          "SIDES",
          "SIDES_OR_DRINKS",
          "SOFT_DRINKS",
          "CONDIMENTS"
        ]
      },
      "description": "Product type enum values",
      "example": []
    },
    "quantity": {
      "$ref": "#/components/schemas/Quantity",
      "description": "Quantity constraints (min, max, default) for ordering this entry. The max value represents the maximum amount of this specific entry that can be included in a single order."
    },
    "type": {
      "type": "string",
      "enum": [
        "ITEM",
        "ASPECT_OPTION",
        "COMBO",
        "COMBO_SLOT",
        "MENU",
        "MODIFIER_GROUP",
        "PICKER",
        "PICKER_ASPECT",
        "SECTION",
        "MODIFIER"
      ],
      "description": "Entry type enum values",
      "example": "ITEM"
    }
  },
  "required": [
    "id",
    "type"
  ]
}