Rewards are an item benefit that can be redeemed in exchange for points (and sometimes money + points). Read more about it here: /wiki/spaces/HELP/pages/4921819186 .

Reward with an item

"cart": [ { "menuSelections": [ {

Code Block
Info
Oracle documentation: https://docs.oracle.com/en/industries/food-beverage/simphony/19.7/simcg/c_discounts_automatic_discount_rules.htm

Online

0 Priced reward item - discount it 100%.
- discounts have a discount ID.
- each offer / reward has a unique discount ID

In Restaurant

0 priced reward item - pre select and offer and reward. discount it 100%.

Next steps:

Send all offer and reward information to Oracle team. Multiple different discounts that can be used (100% discount off, item price substitution)
Talk with TRX team about Rewards with prices + loyalty points (using item price substitution discount)
Have internal discussion and setup a call with Oracle team to validate
Understand if there are any implications to analytics (understanding the difference between offers and rewards)

Reward with an item

Expand

title	RBI Partner API

Code Block

"cart": [
  {
    "menuSelections": [
      {
        "id": "7ee7338a-a016-47c6-aef6-3783d40c003e", // Reward Sanity id
        "externalReferenceId": "123", // Reward constant plu defined in Sanity
        "quantity": 1,
        "price": {
          "amount": 0,
          "currency": "SAR",
        }
        "type": "Reward", 
        "menuSelections": [
          {
            "externalReferenceId": "51056", // item constant plu
            "id": "item_1862", // item Sanity id
            "menuSelections": [],
            "price": {
                "amount": 2495, // normal price
                "currency": "SAR"
          },
            "quantity": 1,
            "type": "Item"
          }
        ]
      }
    ]
  }
]

Expand

title	Oracle TS Gen 2 (Commit call)

Code Block

{
    "header": {
        "orgShortName": "{{OrgShortName}}",
        "locRef": "{{LocRef}}",
        "rvcRef": {{RvcRef}},
        "idempotencyId": "{{$guid}}",
        "orderTypeRef": 9,
        "checkEmployeeRef": {{check_employee_ref}}
    },
    "menuItems": [],
    "comboMeals": [
        {
            "comboMealId": 51002003, // Cheeseburger reward
            "comboItem": {
                "menuItemId": 51002003, // Cheeseburger reward PLU
                "definitionSequence": 1,
                "quantity": 1
            },
            "mainItem": {
                "menuItemId": 1002003, // A la carte cheeseburger
                "definitionSequence": 1,
                "quantity": 1
            },
            "sideItems": []
        }
    ],
    "tenders": [
        {
            "tenderId": 901 // payment method ID. Pay at Counter for this example.
        }
    ]
}

Info
In Oracle, we use a separate combo for reward items so that we can set up a different price (0) vs the single item ALC. Alternatively, we could create a new `priceSequence` set to 0 for each `definitionSequence` , and then re-use the single item.

Note
Oracle can only handle up to 10,000 combos.

Reward with an item + premium modifier

Expand

title	RBI Partner API

Code Block

"cart": [
  {
    "menuSelections": [
      {
        "id": "7ee7338a-a016-47c6-aef6-3783d40c003e", // Reward Sanity id
        "externalReferenceId": "123", // Reward constant plu defined in Sanity
        "quantity": 1,
        "price": {
          "amount": 0,
          "currency": "SAR",
        }
        "type": "Reward", 
        "menuSelections": [
          {
            "externalReferenceId": "51056", // item constant plu
            "id": "item_1862", // item Sanity id
            "menuSelections": [],
            "price": {
                "amount": 2495, // normal price
                "currency": "SAR"
          },
            "quantity": 1,
            "type": "Item"
          }
        ]
      }
    ]
  }
]

Expand

title	Oracle TS Gen 2 (Commit call)

Code Block

{
    "header": {
        "orgShortName": "{{OrgShortName}}",
        "locRef": "{{LocRef}}",
        "rvcRef": {{RvcRef}},
        "idempotencyId": "{{$guid}}",
        "orderTypeRef": 9,
        "checkEmployeeRef": {{check_employee_ref}},
        "language": "es-ES",
        "Accept-Language": "es-ES"
    },
    "menuItems": [],
    "comboMeals": [
        {
            "comboMealId": 51002003, // Cheeseburger reward
            "comboItem": {
                "menuItemId": 51002003, // Cheeseburger reward
                "definitionSequence": 1,
                "quantity": 1
            },
            "mainItem": {
                "menuItemId": 1002003, // Cheeseburger ALC
                "definitionSequence": 1,
                "quantity": 1,
                "condiments": [
                    {
                        "condimentId": 9011005, // Add bacon. Premium modifier (extra cost)
                        "priceSequence": 2,
                        "quantity": 2
                    }
                ]
            },
            "sideItems": []
        }
    ],
    "tenders": [
        {
            "tenderId": 901
        }
    ]
}

Reward with a combo

Expand

title	RBI Partner API

Code Block

"cart": {
  "menuSelections": [
    {
      "externalReferenceId": "8351", // reward plu
      "id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //reward sanity id
        "menuSelections": [
            {
                "externalReferenceId": "8350", // combo plu
                "id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //combo sanity id
                "menuSelections": [
                    {
                        "externalReferenceId": "10059",
                        "id": "item_1852",
                        "menuSelections": [],
                        "price": {
                            "amount": 0,
                            "currency": "SAR"
                        },
                        "quantity": 1,
                        "type": "Item"
                    },
                    {
                        "externalReferenceId": "80007",
                        "id": "4f99db1e-128a-4e53-b23b-dffc0fedf636",
                        "menuSelections": [],
                        "price": {
                            "amount": 0,
                            "currency": "SAR"
                        },
                        "quantity": 1,
                        "type": "Item"
                    },
                    {
                        "externalReferenceId": "80001",
                        "id": "16f482db-2f13-4476-88d3-d2eec26057f3",
                        "menuSelections": [],
                        "price": {
                            "amount": 0,
                            "currency": "SAR"
                        },
                        "quantity": 1,
                        "type": "Item"
                    },
                    {
                        "externalReferenceId": "141139",
                        "id": "141139",
                        "menuSelections": [],
                        "price": {
                            "amount": 0,
                            "currency": "SAR"
                        },
                        "quantity": 1,
                        "type": "Item"
                    }
                ],
                "price": {
                "amount": 300, // original price of combo
                "currency": "SAR"
                 },
                 "quantity": 1,
                 "type": "Combo"
                 }
              ],
              "price": {
              "amount": 0, // final price of the reward
              "currency": "SAR"
              },
              "quantity": 1,
              "type": "Reward"
            }
        ]
    },

Expand

title	Oracle TS Gen 2 (Commit call)

Code Block

language	json

{
    "header": {
        "orgShortName": "{{OrgShortName}}",
        "locRef": "{{LocRef}}",
        "rvcRef": {{RvcRef}},
        "idempotencyId": "{{$guid}}",
        "orderTypeRef": 9,
        "checkEmployeeRef": {{check_employee_ref}},
        "language": "es-ES",
        "Accept-Language": "es-ES"        
    },
    "menuItems": [],
    "comboMeals": [
        {
            "comboMealId": 51001504, //Whopper with Cheese Combo Reward
            "comboItem": {
                "menuItemId": 51001504, //Whopper with Cheese Combo Reward
                "definitionSequence": 1,
                "quantity": 1
            },
            "mainItem": {
                "menuItemId": 1001003, // Whopper with cheese ALC
                "definitionSequence": 1,
                "quantity": 1
            },
            "sideItems": [
                {
                    "menuItemId": 1013201, //Small pepsi
                    "definitionSequence": 1,
                    "quantity": 1
                },
                {
                    "menuItemId": 2102002, //Small fries
                    "definitionSequence": 1,
                    "quantity": 1
                }
            ]
        }
    ],
    "tenders": [
        {
            "tenderId": 901
        }
    ]
}

Reward with a combo + premium modifier

Expand

title	RBI Partner API

Code Block

{
    "payload": {
        "number": "5848",
        "fees": [
            {
                "total": {
                    "amount": 19,
                    "currency": "EUR"
                },
                "type": "BAG_FEE"
            }
        ],
        "serviceMode": "DELIVERY",
        "channel": "WHITELABEL_DELIVERY",
        "callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/15c3dbe1-5165-404b-8858-088239d14014/price/callback",
        "id": "15c3dbe1-5165-404b-8858-088239d14014",
        "storeId": "12349",
        "cart": {
            "menuSelections": [
                {
                    "externalReferenceId": "948351",
                    "quantity": 1,
                    "menuSelections": [
                        {
                            "externalReferenceId": "502617",
                            "quantity": 1,
                            "menuSelections": [
                                {
                                    "externalReferenceId": "502633",
                                    "quantity": 1,
                                    "menuSelections": [
                                        {
                                            "externalReferenceId": "528232",
                                            "quantity": 1,
                                            "price": {
                                                "amount": 90,
                                                "currency": "EUR"
                                            },
                                            "id": "8ba0df7b35df",
                                            "type": "ItemOptionModifier"
                                        }
                                    ],
                                    "price": {
                                        "amount": 0,
                                        "currency": "EUR"
                                    },
                                    "id": "item_11107",
                                    "type": "Item"
                                },
                                {
                                    "externalReferenceId": "942258",
                                    "quantity": 1,
                                    "price": {
                                        "amount": 0,
                                        "currency": "EUR"
                                    },
                                    "id": "item_11126",
                                    "type": "Item"
                                },
                                {
                                    "externalReferenceId": "527646",
                                    "quantity": 1,
                                    "price": {
                                        "amount": 0,
                                        "currency": "EUR"
                                    },
                                    "id": "9aac0a46-5a73-431d-937c-8848ca01ac86",
                                    "type": "Item"
                                }

"id":

"7ee7338a-a016-47c6-aef6-3783d40c003e",

//

Reward

Sanity

id

"externalReferenceId": "123", // Reward constant plu defined in Sanity

],

"quantity":

1,

         "price": {
                                "amount":

0,

 875,
                                "currency": "

SAR",

EUR"

}

"type":

"Reward",

},

"menuSelections":

[

{

externalReferenceId

id": "

51056", // item constant plu

a2e73fd9-5f3d-4afc-9585-43ebd7bbc6dc",
                            "

id

type": "

item_1862

Combo"

,

//

item

Sanity

id

"menuSelections":

[],

"price":

{

"amount": 2495, // normal price

],
                    "

currency

price": {

"SAR"

},

quantity

amount":

1

450,

"type

       "currency": "

Item

EUR"

}

},

]

}

]

}

]

Reward with a combo

Code Block

"cart":

{

menuSelections

id":

[

"024f9096-e3ee-45fc-8f76-d75e272ff9e9",

{

"externalReferenceId":

"8351",

//

reward

plu

id

type": "

43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //reward sanity id

Reward"

"menuSelections":

[

{

    ]
        }

"externalReferenceId": "8350", // combo plu

}
}

Expand

title	Oracle TS Gen 2 (Commit call)

Code Block
{ "header": { "

id

orgShortName": "

43b4cf07-79c9-4aff-98d1-bce9cf2d890f

{{OrgShortName}}",

//combo

sanity

id

"locRef": "{{LocRef}}",
        "

menuSelections

rvcRef":

[

{{RvcRef}},
        "idempotencyId": "{{$guid}}",
        "orderTypeRef": 9,

{

"checkEmployeeRef": {{check_employee_ref}},

externalReferenceId

language": "

10059

es-ES",
        "Accept-Language": "es-ES"

},
    "

id

menuItems":

"item_1852",

[],
    "comboMeals": [
        {
            "

menuSelections

comboMealId":

[]

51001504, // Whopper Cheese combo reward
            "comboItem": {

"price":

{

          "menuItemId": 51001504, //// Whopper Cheese combo reward
                "

amount

definitionSequence":

0

1,
                "quantity": 1

"currency": "SAR"

  },
            "mainItem": {

},

    "menuItemId": 1001003, // whopper cheese
                "

quantity

definitionSequence": 1,
                "quantity": 1,

"type":

"Item"

         "condiments": [

},

{

              "condimentId": 9011005, // Add

bacon. Premium modifier

"externalReferenceId": "80007",

(extra cost)
                        "

id

priceSequence":

"4f99db1e-128a-4e53-b23b-dffc0fedf636"

2,
                        "

menuSelections

quantity":

[],

2
                    }

"price":

{

"amount": 0

},
            "sideItems": [

"currency":

"SAR"

}

"menuItemId": 1013201, // Small

fries
                    "

quantity

definitionSequence": 1,

type

quantity":

"Item"

1
                },

externalReferenceId

menuItemId":

"80001"

2000008, // Icy mango. Premium drink (extra cost)
                    "

id

definitionSequence":

"16f482db-2f13-4476-88d3-d2eec26057f3"

1,

menuSelections

quantity":

[],

1
                }

"price":

{

    ]
        }

],

amount

tenders":

0,

currency

tenderId":

"SAR"

Reward with a cart discount

The reward is the cart discount. You use points to buy a discount.

Expand

title	RBI Partner API

Code Block

language	json

"payload": {
    "number": "5803",

},

 "fees": [

{
            "

quantity

total":

1,

type

amount":

"Item"

19,
                 "currency": "EUR"

},

},

{

   "type": "BAG_FEE"
        }
     ],
     "

externalReferenceId

serviceMode": "

141139

DELIVERY",
     "channel": "WHITELABEL_DELIVERY",
    "callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/60c1983c-8cbc-4aa8-9486-c55fa78566f5/price/callback",

"id": "60c1983c-8cbc-4aa8-9486-c55fa78566f5",
    "

id

orderDiscounts":

"141139",

{
            "

menuSelections

type":

[]

"amount",
             "value": 200
        }

"price":

{

    ],
    "storeId": "12349",

"cart": {	
         "

amount

menuSelections":

0,

[
             {
                "

currency

externalReferenceId": "

SAR

502633",

},

"quantity": 1,

quantity

price":

1,

{
                    "

type

amount": 645,

"Item"

}

"currency": "EUR"

]

},
                 "

price": {

id": "item_11107",
                 "

amount

type":

300, // original price of combo

"Item"
             }

"currency": "SAR"

 ]
    }
 }

Info
Note: the cart discount can be also sent with a `plu` inside the `orderDiscounts` object. Please refer to “Reward with a product discount” section for an example.

Expand

title	Oracle TS Gen 2 (Commit call)

Code Block

language	json

{
    "header": {

},

"orgShortName": "{{OrgShortName}}",

quantity

locRef":

1,

"{{LocRef}}",

"rvcRef": {{RvcRef}},
        "

type

idempotencyId": "

Combo

{{$guid}}",
        "orderTypeRef": 9,

}

 "checkEmployeeRef": {{check_employee_ref}}
    },
    "menuItems": [

],

{   "

price

menuItemId":1001001,

{

// Whopper ALC
            "

amount

definitionSequence":

0, // final price of the reward

1,
            "

currency

quantity":

"SAR"

1
        }
    ],

},

    "tenders": [
        {

"quantity":

1,

           "tenderId": 901

"type":

"Reward"

     }
    ],

}

  "discounts" : [

]

},

Reward with a cart discount

Code Block

"payload": {

"number":

"5803",

fees

discountId":

[

104, // PLU for the cart level amount discount

{

total

referenceText":

{

"Reward 1234",

amount

total":

19, "currency": "EUR"

10 // the amount that you are discounting. 10 euros off. We can send whatever amount we want
        }
    ]
}

Reward with a product discount

Expand

title	RBI Partner API

Code Block

language	json

},

   "payload": {
        "

type

number": "

BAG_FEE"

5807",
        "fees": [

}

],

"serviceMode":

"DELIVERY",

"channel":

"WHITELABEL_DELIVERY",

callbackUrl

total":

"https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/60c1983c-8cbc-4aa8-9486-c55fa78566f5/price/callback",

"id":

"60c1983c-8cbc-4aa8-9486-c55fa78566f5",

"orderDiscounts":

[

       "amount": 19,

{

"type":

"amount",

      "currency": "EUR"

"value":

200

},

],

"storeId":

"12349",

cart

type":

{

"BAG_FEE"

"menuSelections":

[

  }
        ],

{

"serviceMode": "DELIVERY",
        "

externalReferenceId

channel": "

502633

WHITELABEL_DELIVERY",
        "callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/781f28e9-d6bb-4c8e-9ea6-e65a2e7c3764/price/callback",
        "

quantity

id":

1

"781f28e9-d6bb-4c8e-9ea6-e65a2e7c3764",
        "orderDiscounts": [

"price":

{

    {
                "

amount

plu":

645,

"948348",

currency

type": "

EUR

percentage",

},

"value": 50
            }

"id":

"item_11107",

],
        "

type

storeId": "

Item

12349",
        "cart": {

}

]

"menuSelections": [

}

Reward with a product discount

Code Block

{

"payload":

{

"number":

"5807",

"fees":

[

        "externalReferenceId": "948348",

{

total

quantity":

{

1,
                    "

amount

menuSelections":

19,

"currency":

"EUR"

},

type

externalReferenceId": "

BAG_FEE

502633",

}

],

serviceMode

quantity":

"DELIVERY"

1,

"channel": "WHITELABEL_DELIVERY",

"callbackUrl":

https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/781f28e9-d6bb-4c8e-9ea6-e65a2e7c3764/

price

/callback

,

: {

"id":

"781f28e9-d6bb-4c8e-9ea6-e65a2e7c3764",

"orderDiscounts":

[

{

 "amount": 0,

"plu":

"948348",

type

currency": "

percentage

EUR"

,

"value":

50

},

}

],

"storeId":

"12349",

        "id": "

cart

item_11107"

:

{

"menuSelections":

[

              "type": "Item"

{

"externalReferenceId":

"948348",

"quantity":

1

],
                    "

menuSelections

price":

[

{

"amount": 645,
                        "

externalReferenceId

currency": "

502633",

EUR"
                    },

"quantity": 1,

         "id": "fbdead97-5acb-4d1c-a5fe-5794ece61aaa",
                    "

price

type":

{

"Reward"
                }
            ]

"amount":

0,

  }
    }
}

Expand

title	Oracle TS Gen 2 (Commit call)

Code Block

language	json

{
    "header": {
        "orgShortName": "{{OrgShortName}}",
        "

currency

locRef": "

EUR

{{LocRef}}",
        "rvcRef": {{RvcRef}},
        "idempotencyId": "{{$guid}}",
        "orderTypeRef":

}

9,
        "checkEmployeeRef": {{check_employee_ref}}
    },
    "menuItems": [

"id": "item_11107",

{
            "menuItemId": 1001001, //

Whopper
            "

type

definitionSequence":

"Item"

1,
            "quantity": 1,

}

  "itemDiscounts": [
                {

],

price

discountId":

{

 104, // PLU of the product amount discount off
                    "

amount

referenceText":

645,

"Reward Item Discount",

currency

total":

"EUR"

59 // amount of discount (can be sent as any number). 59 pesos off the whopper ALC price.

},

"id": "fbdead97-5acb-4d1c-a5fe-5794ece61aaa",

         ]
        }

"type":

"Reward"

 ],
    "tenders": [
        {

}

            "tenderId":

]

901
        }

}

]
}

Offer Payload Structure

Offers are a discount on the order or item. Can take the form of a discounted bundle, cheaper item, order-level % discount, or order-level $ off. Also known as a “coupon” in some markets. Read more about it here: /wiki/spaces/HELP/pages/4854349911 .

Offer with an item

Info
As with rewards, Oracle also creates a separate combo for an item offer.

Expand

title	RBI Partner API

Code Block

Expand

title	Oracle TS Gen 2 (Commit call)

Code Block

"cart

{
    "header": {

"menuSelections":

[

    "orgShortName": "{{OrgShortName}}",
        "

externalReferenceId

locRef": "

8351

{{LocRef}}",

//

offer

plu

id

rvcRef":

"43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //offer sanity id

{{RvcRef}},
        "

menuSelections

idempotencyId":

[

"{{$guid}}",
        "orderTypeRef": 9,

{

      "checkEmployeeRef": {{check_employee_ref}}
    },
    "

externalReferenceId

menuItems": [],
    "

8167", // combo plu

comboMeals": [
        {
            "

id

comboMealId":

"d90a7113-0620-44d9-b678-743330a2f207"

4000045, //

combo

sanity

Offer

id

PLU for vanilla cone

menuSelections

comboItem":

[

{
                "menuItemId": 4000045, // Offer

{

PLU for vanilla

cone
                "

externalReferenceId

definitionSequence":

"80003",

 1,
                "

id

quantity":

"ce847c79-9eb5-4be3-8a1e-842919aa5ba0",

 1
            },
            "

menuSelections

mainItem":

[],

{
                "menuItemId": 1014013, // Vanilla Cone ALC

"price":

{

           "definitionSequence": 1,
                "

amount

quantity":

0,

1
            },

currency

sideItems":

"SAR"

[]
        }
    ],

"tenders": [

},

quantity

tenderId":

1,

901
        }

]
}

Offer with a combo

Expand

title	RBI Partner API

Code Block

language	json

"cart": {
  "

type

menuSelections":

"Item"

[
    {
      "externalReferenceId": "8351", // offer plu

},

  "id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //offer sanity id
        "menuSelections": [

{

        {
                "externalReferenceId": "

142538

8167", // combo plu

"id": "

142538

d90a7113-0620-44d9-b678-743330a2f207", //combo sanity

id

"menuSelections": [

],

"price":

amount

externalReferenceId":

0

"80003",

"currency": "SAR"

"id": "ce847c79-9eb5-4be3-8a1e-842919aa5ba0",

}

"menuSelections": [],
                        "

quantity

price": {

1,

type

amount":

"Item"

0,

}

     "currency": "SAR"

],

},

"price":

{

amount

quantity":

500

1,

//price

of

the

combo

currency

type": "

SAR

Item"

},

},

],

"price":

{

amount

externalReferenceId":

100

"142538",

//

final

price

of

the

offer

currency

id": "

SAR

142538",

},

        "menuSelections": [],

"quantity":

1,

type

price":

"Offer"

}

]

},

Offer with a picker

Code Block

"cart

"amount":

{

0,

"menuSelections":

[

{

"externalReferenceId":

"8351",

//

offer

plu

id

currency": "

43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //offer sanity id

SAR"

"menuSelections":

[

},

{

externalReferenceId

quantity":

"8168", //combo plu

1,
                        "

id

type": "

3318d2c2-99d3-40f9-92d2-1798d9c5e987", //combo sanity id

Item"
                    }

"menuSelections":

[

],

{

   "price": {
                    "

externalReferenceId

amount":

"20001"

500, //price of the combo
                    "

id

currency": "

item_61936

SAR"

,

},

"menuSelections":

[],

        ],
                "price": {
                "amount": 100, // final price of the offer

"amount":

0,

       "currency": "SAR"
                },

"currency":

"SAR"

            "quantity": 1,

},

     "type": "Offer"
            }

"quantity":

1,

  ]
    },

Expand

title	Oracle TS Gen 2 (Commit call)

Code Block

language	json

"header": {
        "

type

orgShortName": "

Item

{{OrgShortName}}",
        "locRef": "{{LocRef}}",

"rvcRef": {{RvcRef}},
        "idempotencyId": "{{$guid}}",
        "orderTypeRef": 9,

{

        "checkEmployeeRef": {{check_employee_ref}}
    },
    "menuItems": [],
    "

externalReferenceId

comboMeals":

"80002",

{
            "

id

comboMealId":

"865a632f-e2f7-4e2b-8fcc-9281aa3f5868"

4000045, // Buy one Cone, Get one Cone for free Offer

PLU
            "

menuSelections

comboItem":

[],

{
                "

price

menuItemId":

{

4000045, // Buy one Cone, Get one Cone for free Offer

PLU
                "

amount

definitionSequence":

0

1,
                "quantity": 1

"currency":

"SAR"

 },
            "sideItems": [{

},

       "menuItemId": 1014013, // Vanilla Cone (could be any selection of cones)

"quantity":

1,

       "definitionSequence": 1,
                "

type

quantity": 1

"Item"

},

},

    {
                "menuItemId": 1014012,

{

// Strawberry Cone (could be any selection of cones)
                "

externalReferenceId

definitionSequence":

"80008"

1,
                "quantity": 1

"id":

"04462c22-bf58-4eee-842a-213e3d17a072",

     }]
        }

],
    "

menuSelections

tenders": [

],

price

tenderId":

{

Offer with a cart discount

Expand

title	RBI Partner API

Code Block

language	json

{
    "payload": {
        "

amount

number":

0,

"5814",
        "fees": [
            {
                "

currency

total": {

"SAR"

                   "amount": 19,

},

"currency": "EUR"

"quantity":

1,

        },
                "type": "

Item

BAG_FEE"
            }

}

],
        "serviceMode": "DELIVERY",
        "channel": "WHITELABEL_DELIVERY",

{

        "callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/6d66a02e-810f-478f-bf0d-b69bfcb56d51/price/callback",
        "id": "6d66a02e-810f-478f-bf0d-b69bfcb56d51",
        "

externalReferenceId

orderDiscounts":

"142538",

 [
            {
                "

id

type": "

142538

percentage",


                "value":

"menuSelections":

[],

       }
        ],
        "

price

storeId":

{

"12349",
        "cart": {
            "menuSelections": [

"amount":

0,

        {
                    "

currency

externalReferenceId": "

SAR

502633",

}

"quantity": 1,

quantity

price":

1,

{
                        "

type

amount":

"Item"

645,

}

    "currency": "EUR"

],

"price": {

},
                    "

amount

id":

500, //price of the combo

"item_11107",

currency

type": "

SAR

Item"
                }

,

],

       }
    }
}

Expand

title	Oracle TS Gen 2 (Commit call)

Code Block

language	json

{
    "

price

header": {
        "orgShortName": "{{OrgShortName}}",
        "

amount

locRef":

100

"{{LocRef}}",

//

final

price

of

the

offer

"rvcRef": {{RvcRef}},
        "

currency

idempotencyId": "

SAR

{{$guid}}",
        "orderTypeRef": 9,

},

    "checkEmployeeRef": {{check_employee_ref}}

},
    "

quantity

menuItems":

1,

 [
        {   "

type

menuItemId":

"Offer"

1001001, // Whopper ALC

}

  "definitionSequence": 1,

]

},

Offer with a cart discount

Code Block

{

payload

quantity":

{

"number": "5814",

}
    ],
    "

fees

tenders": [

total

tenderId":

{

901
        }
    ],

amount

discounts" :

19,

[
        {
            "

currency

discountId":

"EUR"

 106, // PLU for the cart level percent discount 
            "referenceText": "Offer

}

1234",
            "total": 10 //

"type": "BAG_FEE" }

the percentage that you are discounting. 10% off. We can send whatever percentage we want
        }

],

]
}

Offer with a product discount

Expand

title	RBI Partner API

Code Block
{ "

serviceMode

payload":

"DELIVERY",

{
        "

channel

number": "

WHITELABEL_DELIVERY

5821",
        "

callbackUrl

fees":

"https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/6d66a02e-810f-478f-bf0d-b69bfcb56d51/price/callback",

"id":

"6d66a02e-810f-478f-bf0d-b69bfcb56d51",

"orderDiscounts":

[

            "total": {
                    "

type

amount":

"percentage",

19,
                    "

value

currency":

20

"EUR"
                }

],

storeId

type": "

12349

BAG_FEE"

,

"cart":

{

   }
        ],

"menuSelections":

[

       "serviceMode": "DELIVERY",

{

"channel": "WHITELABEL_DELIVERY",

"callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/ed50be10-cf7c-4b1c-8bb1-0c2625cbf3be/price/callback",
        "

externalReferenceId

id": "

502633

ed50be10-cf7c-4b1c-8bb1-0c2625cbf3be",
        "orderDiscounts": [

"quantity":

1,

price

plu":

{

"502617",

amount

type":

645,

"percentage",

currency

value":

"EUR"

20
            }

}

],

"storeId": "12349",
        "

id

cart":

"item_11107",

 {
            "menuSelections": [

"type":

"Item"

}

]

"externalReferenceId": "502617",

}

} }

Offer with a product discount

Code Block

{

payload

quantity": 1,

{

"number":

"5821",

fees

menuSelections": [

{

"total":

{

amount

externalReferenceId":

19,

"502633",

"currency":

"EUR"

    "quantity": 1,

},

type

price":

"BAG_FEE"

}

],

serviceMode

amount":

"DELIVERY"

0,

"channel":

"WHITELABEL_DELIVERY",

"callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/ed50be10-cf7c-4b1c-8bb1-0c2625cbf3be/price/callback",

id

currency": "

ed50be10-cf7c-4b1c-8bb1-0c2625cbf3be",

EUR"

"orderDiscounts":

[

{

},

"plu":

"502617",

type

id": "

percentage

item_11107",

"value":

20

           "type": "Item"

}

],

"storeId":

"12349",

"cart": {

},

"menuSelections":

[

{

                     "externalReferenceId": "

502617

942258",

"quantity":

1,

            "quantity": 1,

"menuSelections":

[

                    "price": {

{

externalReferenceId

amount":

"502633"

0,

"quantity":

1,

    "currency": "EUR"

"price":

{

    },
                            "

amount

id":

0

"item_11126",

currency

type": "

EUR

Item"
                        },

},

"id":

"item_11107",

                   "externalReferenceId": "527646",

"type":

"Item"

                   "quantity": 1,

},

                        "price": {
                                "

externalReferenceId

amount":

"942258"

0,

"quantity":

1,

   "currency": "EUR"

"price":

{

},

"amount": 0,

"id": "9aac0a46-5a73-431d-937c-8848ca01ac86",
                            "

currency

type": "

EUR

Item"

,

],

"id":

"item_11126",

            "price": {

"type":

"Item"

        "amount": 875,

},

         "currency": "EUR"

{

},
                    "

externalReferenceId

id": "

527646

a2e73fd9-5f3d-4afc-9585-43ebd7bbc6dc",

quantity

type":

1,

"Offer"
                }

"price":

{

]
        }

}
}

Expand

title	Oracle TS Gen 2 (Commit call)

Code Block

language	json

"header": {
        "

amount

orgShortName":

0

"{{OrgShortName}}",
        "locRef": "{{LocRef}}",

"rvcRef": {{RvcRef}},

currency

idempotencyId": "

EUR

{{$guid}}",
        "orderTypeRef": 9,

"checkEmployeeRef": {{check_employee_ref}}
    },
    "menuItems": [
        {

id

menuItemId":

"9aac0a46-5a73-431d-937c-8848ca01ac86"

1001001,

// Whopper

"type": "Item"

"definitionSequence": 1,
            "quantity": 1,

}

   "itemDiscounts": [

],

{
                    "

price

discountId":

{

 106, // PLU of the product percent discount off
                    "

amount

referenceText":

875,

"Offer Item

Discount",
                    "

currency

total":

"EUR"

50 // percentage discount (can be sent as any percentage). 50% off the whopper ALC price.

},

"id":

"a2e73fd9-5f3d-4afc-9585-43ebd7bbc6dc",

type

tenders":

"Offer"

}

      "tenderId":

]

}

]
}

Reference

NMS guides on how to set up offers and rewards in Sanity for Oracle: /wiki/spaces/MS/pages/4057661622

Versions Compared

Old Version 4

New Version Current

Key

Reward with an item

Reward with an item

Reward with an item + premium modifier

Reward with a combo

Reward with a combo + premium modifier

Reward with a combo

Reward with a cart discount

Reward with a cart discount

Reward with a product discount

Reward with a product discount

Offer Payload Structure

Offer with an item

Offer with a combo

Offer with a picker

Offer with a cart discount

Offer with a cart discount

Offer with a product discount

Offer with a product discount

Reference

Page Comparison

Versions Compared

Old Version 4

New Version Current

Key

Reward with an item

Reward with an item

Reward with an item + premium modifier

Reward with a combo

Reward with a combo + premium modifier

Reward with a combo

Reward with a cart discount

Reward with a cart discount

Reward with a product discount

Reward with a product discount

Offer Payload Structure

Offer with an item

Offer with a combo

Offer with a picker

Offer with a cart discount

Offer with a cart discount

Offer with a product discount

Offer with a product discount

Reference