PaperCouponEntry

PaperCouponEntry schema from Burger King's Partners API v2

Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants
View JSON Schema on GitHub

JSON Schema

menu-v2-paper-coupon-entry-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "PaperCouponEntry",
  "description": "PaperCouponEntry schema from Burger King's Partners API v2",
  "$id": "https://raw.githubusercontent.com/api-evangelist/restaurant-brands/refs/heads/main/json-schema/menu-v2-paper-coupon-entry-schema.json",
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "availability": {
          "description": "Availability override for the paper coupon",
          "$ref": "#/components/schemas/Availability"
        },
        "id": {
          "type": "string",
          "description": "Unique id of the paper coupon",
          "example": "paperCoupon_123"
        },
        "loyaltyEngineId": {
          "type": "string",
          "description": "Unique id generated by the loyalty engine",
          "example": "123e4567-e89b-12d3-a456-426614174000"
        },
        "name": {
          "$ref": "#/components/schemas/LocalizedString",
          "description": "Name of the paper coupon",
          "example": "Paper Coupon"
        },
        "options": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Option"
          },
          "description": "Optional list of options"
        },
        "quantity": {
          "$ref": "#/components/schemas/Quantity",
          "description": "Quantity of the paper coupon"
        },
        "shortCode": {
          "type": "string",
          "description": "Shortcode for the paper coupon\n",
          "example": "123456"
        },
        "type": {
          "type": "string",
          "description": "Unique identifier for a reward entry",
          "enum": [
            "PAPER_COUPON"
          ]
        }
      },
      "required": [
        "id",
        "type"
      ]
    }
  ]
}