Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Endpoint

GET /loyalty/v2/content?[type=rewards|offers

...

Parameter

...

Type

...

Description

...

type

...

string

...

]

Headers

Bearer token in JWT format as specified in /wiki/spaces/IN/pages/3739288100.

...

  • type <string> (optional): “rewards” will return content of all the rewards available at that time. “offers” will return content of all offers available at that time. If this field is not sent, it will return the full list of offers and rewards.

Body

Empty.

Example request

To get all content:

Code Block
GET /loyalty/v2/content

To get, for example, just rewards:

Code Block
GET /loyalty/v2/content?type=rewards

Response Format

Success response body

...

Code Block
{
    "offers": [
        {
            "title": "MEAT FREE MONDAYS VEGAN ROYALE",
            "description": "Vegan Royale for just £2.99. Only on Mondays. Use app code APP903 if using a kiosk.",
            "moreInfo": "Not valid in conjunction with any other offer. One voucher per transaction. Valid only in the UK. Subject to availability. Voucher valid at participating restaurants only.  Not valid at Burger King motorway service locations, airports train stations and holiday parks. © 2023 Burger King Europe GmbH. All rights reserved.",
            "image": "https://cdn.sanity.io/images/czqk28jt/prod_bk_gb/aae9c1303b7cea013c984ee647ed7898ce6cfce9-1000x850.png",
            "plu": "9920",
            "type": "offer",
            "personalized": "false",
            "benefit": {
              "benefitPlu": "9920",
              "discountType": "percentage",
              "discountAmount": "20"
            }
            "rules": [
                {
                "type": "day-of-week-band"
                friday: false
                monday: true
                saturday: false
                sunday: false
                thursday: false
                tuesday: false
                wednesday: false
                },
                {
                "type": "service-mode-restrictions"
                CATERING_DELIVERY: true
                CATERING_PICKUP: true
                CURBSIDE: true
                DELIVERY: false
                DRIVE_THRU: true
                EAT_IN: true
                TABLE_SERVICE: true
                TAKEOUT: true
                },
                {
                    "type": "limit"
                interval:day
                maximumRedemptions: 1
                },
            ],
        },
        {
            "title": "WHOPPER WEDNESDAYS SPECIAL OFFER",
            "description": "Whopper for just £1.99. Only on Wednesdays.",
            "moreInfo": "Not valid in conjunction with any other offer. One voucher per transaction. Valid only in the UK. Subject to availability. Voucher valid at participating restaurants only.  Not valid at Burger King motorway service locations, airports train stations and holiday parks. © 2023 Burger King Europe GmbH. All rights reserved.",
            "image": "https://cdn.sanity.io/images/czqk28jt/prod_bk_gb/aae9c1303b7cea013c984ee647ed7898ce6cfce9-1000x850.png",
            "plu": "9921",
            "type": "offer",
            "personalized": "personalizedOffer",true",
            "benefit": {
              "benefitPlu": "9920",
            }
            "rules": [
                {
                "type": "day-of-week-band"
                friday: false
                monday: false
                saturday: false
                sunday: false
                thursday: false
                tuesday: false
                wednesday: true
                },
                {
                "type": "service-mode-restrictions"
                CATERING_DELIVERY: true
                CATERING_PICKUP: true
                CURBSIDE: true
                DELIVERY: false
                DRIVE_THRU: true
                EAT_IN: true
                TABLE_SERVICE: true
                TAKEOUT: true
                },
                {
                    "type": "limit"
                interval:day
                maximumRedemptions: 1
                },
            ],
        }
    ],
    "rewards": [
        {
            "title": "Small Fries Reward",
            "description": "Order this reward and get free small fries",
            "moreInfo": "Contains allergens",
            "image": "https://cdn.sanity.io/images/czqk28jt/staging_bk_gb/fc7c2a73e7a9bf14f3e3401bedcc090c4f421c67-1333x1333.png",
            "plu": "8810",
            "type": "reward",
            "benefit": {
              "benefitPlu": "9920",
              "discountType": "percentage",
              "discountAmount": "20"
            }
            "rules": [
                {
                    "type": "loyaltyPoints",
                    "points": 200,
                }
            ]
        }
    ]
}

...