Restaurant Brands International · Schema

LoyaltyEntry

LoyaltyEntry schema from Burger King's Partners API v2

Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants

Properties

Name	Type	Description
availability	object
description	object
discountType	string	Provides if the discount should be calculated as a percentage or an amount
discountValue	number	Amount that should be discounted
id	string	Unique identifier for a reward entry
image	object
loyaltyEngineId	string
loyaltyPoints	number	Amount of Loyalty Points required to redeem this offer
name	object
options	array
price	object
quantity	object
type	string	Unique identifier for a reward entry

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "LoyaltyEntry",
  "description": "LoyaltyEntry schema from Burger King's Partners API v2",
  "$id": "https://raw.githubusercontent.com/api-evangelist/restaurant-brands/refs/heads/main/json-schema/menu-v2-loyalty-entry-schema.json",
  "type": "object",
  "properties": {
    "availability": {
      "$ref": "#/components/schemas/Availability"
    },
    "description": {
      "$ref": "#/components/schemas/LocalizedString"
    },
    "discountType": {
      "type": "string",
      "description": "Provides if the discount should be calculated as a percentage or an amount",
      "example": 1
    },
    "discountValue": {
      "type": "number",
      "description": "Amount that should be discounted",
      "example": 1
    },
    "id": {
      "type": "string",
      "description": "Unique identifier for a reward entry",
      "example": "500123"
    },
    "image": {
      "$ref": "#/components/schemas/Image"
    },
    "loyaltyEngineId": {
      "type": "string",
      "example": "500123"
    },
    "loyaltyPoints": {
      "type": "number",
      "description": "Amount of Loyalty Points required to redeem this offer",
      "example": 1.0
    },
    "name": {
      "$ref": "#/components/schemas/LocalizedString"
    },
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Option"
      }
    },
    "price": {
      "$ref": "#/components/schemas/EntryPrice"
    },
    "quantity": {
      "$ref": "#/components/schemas/Quantity"
    },
    "type": {
      "type": "string",
      "description": "Unique identifier for a reward entry",
      "enum": [
        "CONFIG_OFFER",
        "SYSTEM_WIDE_OFFER",
        "ENTRY",
        "REWARD"
      ],
      "example": "CONFIG_OFFER"
    }
  },
  "required": [
    "id",
    "type"
  ]
}