Versions Compared

Old Version 9

changes.mady.by.user Lopes da Costa, Valentina

Saved on

compared with

New Version Current

changes.mady.by.user Lopes da Costa, Valentina

Saved on

Key

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

...

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": [ {
Expand
titleRBI Partner API
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
titleRBI 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
titleOracle 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
titleRBI 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
titleOracle 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
titleRBI 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,
                        "idtype": "7ee7338a-a016-47c6-aef6-3783d40c003e", // Reward Sanity idItem"
                    },
                  "externalReferenceId": "123", // Reward constant plu defined in Sanity {
              "quantity": 1,         "priceexternalReferenceId": "141139",
 {           "amount": 0,           "currencyid": "SAR141139",
        }                "typemenuSelections": "Reward"[],
         "menuSelections": [           {   "price": {
        "externalReferenceId": "51056", // item constant plu                    "idamount": "item_1862"0,
// item Sanity id             "menuSelections": [],            "currency": "price": {SAR"
                       "amount": 2495},
     // normal price                 "currencyquantity": "SAR"1,
           },             "quantitytype": 1,"Item"
            "type": "Item"       }
   }         ]    ],
  }     ]   } ]
Expand
titleOracle TS Gen 2 (Commit call)
Code Block
{     "headerprice": {
                "orgShortNameamount": "{{OrgShortName}}"300, // original price of combo
       "locRef         "currency": "{{LocRef}}",SAR"
                "rvcRef": {{RvcRef}},

       "idempotencyId": "{{$guid}}",         "orderTypeRefquantity": 91,
        "checkEmployeeRef": {{check_employee_ref}}     },    "type": "menuItemsCombo": [],
        "comboMeals": [        }
{             "comboMealId": 51002003], //
Cheeseburger reward             "comboItemprice": {
 
              "menuItemIdamount": 510020030, // Cheeseburgerfinal rewardprice PLUof the reward
              "definitionSequencecurrency": 1,"SAR"
              },
 "quantity": 1            "quantity": }1,
              "mainItemtype": "Reward"
   {         }
       "menuItemId": 1002003, // A la carte cheeseburger ]
    },
Expand
titleOracle TS Gen 2 (Commit call)
Code Block
languagejson
{
    "header": {
          "definitionSequenceorgShortName": 1,
       "{{OrgShortName}}",
        "quantitylocRef": 1"{{LocRef}}",
            "rvcRef": {{RvcRef}},
            "sideItemsidempotencyId": []"{{$guid}}",
        }
"orderTypeRef": 9,
   ],     "tenderscheckEmployeeRef": [{{check_employee_ref}},
        {
"language": "es-ES",
           "tenderId": 901 // payment method ID. Pay at Counter for this example."Accept-Language": "es-ES"        
    },
    ]
}
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
titleRBI Partner API
Code Block
"cart"menuItems": [
],
 {     "menuSelectionscomboMeals": [
        {
            "idcomboMealId": "7ee7338a-a016-47c6-aef6-3783d40c003e", // 51001504, //Whopper with Cheese Combo Reward
Sanity   id         "externalReferenceIdcomboItem": {
"123", // Reward constant plu defined in Sanity         "quantitymenuItemId": 151001504, //Whopper with Cheese Combo Reward
    "price": {           "amountdefinitionSequence": 01,
                "currencyquantity": "SAR", 1
            },
            "typemainItem": "Reward",{
                "menuSelectionsmenuItemId": [1001003, // Whopper with cheese   ALC
   {             "externalReferenceIddefinitionSequence": "51056"1,
// item constant plu             "idquantity": "item_1862", // item Sanity id 1
            },
            "menuSelectionssideItems": [],
               "price": {
                    "amountmenuItemId": 24951013201, //Small pepsi
  normal price                 "currencydefinitionSequence": "SAR"1,
          },             "quantity": 1,
            "type": "Item"   },
       }         ]{
      }     ]   } ]
Expand
titleOracle TS Gen 2 (Commit call)
Code Block
{     "headermenuItemId": {2102002, //Small fries
                    "orgShortNamedefinitionSequence": "{{OrgShortName}}",1,
          "locRef": "{{LocRef}}",         "rvcRef": {{RvcRef}},"quantity": 1
               "idempotencyId": "{{$guid}}",}
          "orderTypeRef": 9, ]
       "checkEmployeeRef": {{check_employee_ref}},}
    ],
    "languagetenders": "es-ES", [
        {
 "Accept-Language": "es-ES"     },     "menuItemstenderId": [],901
    "comboMeals": [   }
    ]
}

Reward with a combo + premium modifier

Expand
titleRBI Partner API
Code Block
{
    "payload": {
        "comboMealIdnumber": 51002003, // Cheeseburger reward
"5848",
        "fees": [
           "comboItem": {
                "menuItemIdtotal": {
51002003, // Cheeseburger reward                 "definitionSequenceamount": 119,
                    "quantitycurrency": "EUR"
1             },   },
         "mainItem": {      "type": "BAG_FEE"
         "menuItemId": 1002003, // Cheeseburger}
ALC        ],
        "definitionSequenceserviceMode": 1"DELIVERY",
                "quantity"channel": 1"WHITELABEL_DELIVERY",
                "condiments": [
     "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",
                  "condimentId"cart": 9011005,{
// Add bacon. Premium modifier (extra cost)      "menuSelections": [
                {
"priceSequence": 2,
                        "quantityexternalReferenceId": 2"948351",
                    }
"quantity": 1,
               ]     "menuSelections": [
      },             "sideItems": []         }
    ],{
     "tenders": [         {             "tenderIdexternalReferenceId": 901
   "502617",
     }     ] }

Reward with a combo

Expand
titleRBI Partner API
Code Block
"cart": {   "menuSelections": [     {       "externalReferenceIdquantity": "8351"1, // 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                "externalReferenceId": "menuSelections502633":,
 [                     {              "quantity": 1,
         "externalReferenceId": "10059",                           "idmenuSelections": "item_1852",[
                             "menuSelections": [],          {
              "price": {                             "amountexternalReferenceId": 0"528232",
                            "currency": "SAR"               "quantity": 1,
        },                         "quantity": 1,          "price": {
             "type": "Item"                     },             "amount": 90,
      {                         "externalReferenceId": "80007",                "currency": "EUR"
       "id": "4f99db1e-128a-4e53-b23b-dffc0fedf636",                         "menuSelections": [],          },
              "price": {                             "amountid": 0,"8ba0df7b35df",
                               "currency": "SAR"            "type": "ItemOptionModifier"
           },                         "quantity": 1,   }
                     "type": "Item"              ],
      },                     {         "price": {
              "externalReferenceId": "80001",                         "idamount": "16f482db-2f13-4476-88d3-d2eec26057f3",0,
                           "menuSelections": [],             "currency": "EUR"
             "price": {                      },
      "amount": 0,                             "currencyid": "SARitem_11107",
                        },                "type": "Item"
        "quantity": 1,                       },
 "type": "Item"                     },         {
           {                         "externalReferenceId": "141139942258",
                        "id": "141139",           "quantity": 1,
            "menuSelections": [],
                        "price": {
                            "amount": 0,           "amount": 0,
                "currency": "SAR"                       "currency": "EUR"
},                         "quantity": 1,          },
              "type": "Item"                     }
"id": "item_11126",
               ],                 "price": {   "type": "Item"
            "amount": 300, // original price of combo              },
  "currency": "SAR"                  },           {
      "quantity": 1,                  "type": "Combo"          "externalReferenceId": "527646",
      }               ],               "pricequantity": {1,
              "amount": 0, // final price of the reward               "currencyprice": "SAR"{
              },               "quantity": 1,
              "typeamount": "Reward"0,
            }         ]     },
Expand
titleOracle TS Gen 2 (Commit call)
Code Block
languagejson
{     "header": {         "orgShortNamecurrency": "{{OrgShortName}}",EUR"
             "locRef": "{{LocRef}}",         "rvcRef": {{RvcRef}},         "idempotencyId": "{{$guid}}"   },
        "orderTypeRef": 9,         "checkEmployeeRef": {{check_employee_ref}},
        "language": "es-ES",         "Accept-Languageid": "es-ES"9aac0a46-5a73-431d-937c-8848ca01ac86",
            },         "menuItems": [],     "comboMeals": [         {"type": "Item"
            "comboMealId": 51001504, //Whopper with Cheese Combo Reward             "comboItem": {}
                "menuItemId": 51001504, //Whopper with Cheese Combo Reward      ],
          "definitionSequence": 1,                 "quantityprice": 1{
            },             "mainItem": {      "amount": 875,
         "menuItemId": 1001003, // Whopper with cheese ALC                 "definitionSequencecurrency": 1,
 "EUR"
              "quantity": 1             },
            "sideItems": [               "id":  {"a2e73fd9-5f3d-4afc-9585-43ebd7bbc6dc",
                     "menuItemId": 1013201, //Small pepsi    "type": "Combo"
               "definitionSequence": 1,        }
            "quantity": 1       ],
         },           "price":  {
   {                     "menuItemIdamount": 2102002450,
  //Small fries                     "definitionSequencecurrency": 1, "EUR"
                    },
   "quantity": 1                 }"id": "024f9096-e3ee-45fc-8f76-d75e272ff9e9",
            ]         }"type": "Reward"
    ],     "tenders": [      }
  {             "tenderId": 901]
        }
    ]}
}

Reward with a combo + premium modifier

Expand
titleRBI Partner API
Code Block
Expand
titleOracle 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": 51001504, // Whopper Cheese combo reward
            "comboItem": {
                "menuItemId": 51001504, //// Whopper Cheese combo reward
                "definitionSequence": 1,
                "quantity": 1
            },
            "mainItem": {
                "menuItemId": 1001003, // whopper cheese
                "definitionSequence": 1,
                "quantity": 1,
                "condiments": [
                    {
                        "condimentId": 9011005, // Add bacon. Premium modifier (extra cost)
                        "priceSequence": 2,
                        "quantity": 2
                    }
                ]
            },
            "sideItems": [
                {
                    "menuItemId": 1013201, // Small fries
                    "definitionSequence": 1,
                    "quantity": 1
                },
                {
                    "menuItemId": 2000008, // Icy mango. Premium drink (extra cost)
                    "definitionSequence": 1,
                    "quantity": 1
                }
            ]
        }
    ],
    "tenders": [
        {
            "tenderId": 901
        }
    ]
}

Reward with a cart discount

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

Expand
titleRBI Partner API
Code Block
languagejson
"payload": {
    "number": "5803",
    "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/60c1983c-8cbc-4aa8-9486-c55fa78566f5/price/callback",
    "id": "60c1983c-8cbc-4aa8-9486-c55fa78566f5",
    "orderDiscounts": [
        {
            "type": "amount",
             "value": 200
        }
     ],
    "storeId": "12349",
    "cart": {	
         "menuSelections": [
             {
                "externalReferenceId": "502633",
                 "quantity": 1,
                "price": {
                    "amount": 645,
                    "currency": "EUR"
                },
                 "id": "item_11107",
                 "type": "Item"
             }
        ]
    }
 }
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
titleOracle TS Gen 2 (Commit call)
Code Block
languagejson
{
    "header": {
        "orgShortName": "{{OrgShortName}}",
        "locRef": "{{LocRef}}",
        "rvcRef": {{RvcRef}},
        "idempotencyId": "{{$guid}}",
        "orderTypeRef": 9,
        "checkEmployeeRef": {{check_employee_ref}}
    },
    "menuItems": [
        {   "menuItemId":1001001, // Whopper ALC
            "definitionSequence": 1,
            "quantity": 1
        }
    ],
    "tenders": [
        {
            "tenderId": 901
        }
    ],
    "discounts" : [
        {
            "discountId": 104, // PLU for the cart level amount discount 
            "referenceText": "Reward 1234",
            "total": 10 // the amount that you are discounting. 10 euros off. We can send whatever amount we want
        }
    ]
}

...

Expand
titleRBI Partner API
Code Block
languagejson
/{
    "payload": {
        "number": "5807",
        "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/781f28e9-d6bb-4c8e-9ea6-e65a2e7c3764/price/callback",
        "id": "781f28e9-d6bb-4c8e-9ea6-e65a2e7c3764",
        "orderDiscounts": [
            {
                "plu": "948348",
                "type": "percentage",
                "value": 50
            }
        ],
        "storeId": "12349",
        "cart": {
            "menuSelections": [
                {
                    "externalReferenceId": "948348",
                    "quantity": 1,
                    "menuSelections": [
                        {
                            "externalReferenceId": "502633",
                            "quantity": 1,
                            "price": {
                                "amount": 0,
                                "currency": "EUR"
                            },
                            "id": "item_11107",
                            "type": "Item"
                        }
                    ],
                    "price": {
                        "amount": 645,
                        "currency": "EUR"
                    },
                    "id": "fbdead97-5acb-4d1c-a5fe-5794ece61aaa",
                    "type": "Reward"
                }
            ]
        }
    }
}
Expand
titleOracle TS Gen 2 (Commit call)
Code Block
languagejson
{
    "header": {
        "orgShortName": "{{OrgShortName}}",
        "locRef": "{{LocRef}}",
        "rvcRef": {{RvcRef}},
        "idempotencyId": "{{$guid}}",
        "orderTypeRef": 9,
        "checkEmployeeRef": {{check_employee_ref}}
    },
    "menuItems": [
        {
            "menuItemId": 1001001, // Whopper
            "definitionSequence": 1,
            "quantity": 1,
            "itemDiscounts": [
                {
                    "discountId": 106104, // PLU of the product amount discount off
                    "referenceText": "OfferReward Item Discount",
                    "total": 59 // amount of discount (can be sent as any number). 59 pesos off the whopper ALC price.
                }
            ]
        }
    ],
    "tenders": [
        {
            "tenderId": 901
        }
    ]
}

...

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
titleRBI Partner API
"cart": { "menuSelections": [ {
Code Block
languagejson
 Expand
titleOracle TS Gen 2 (Commit call)
 Code Block
{
    "externalReferenceIdheader": "8351", // offer plu{
        "idorgShortName": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //offer sanity id{{OrgShortName}}",
          "menuSelectionslocRef": [
            {
                "externalReferenceId": "8167", // combo plu
        "{{LocRef}}",
        "idrvcRef": "d90a7113-0620-44d9-b678-743330a2f207", //combo sanity id
       {{RvcRef}},
        "menuSelectionsidempotencyId": ["{{$guid}}",
        "orderTypeRef": 9,
        "checkEmployeeRef":  {{{check_employee_ref}}
    },
       "menuItems": [],
           "externalReferenceId"comboMeals": "80003",[
           {
            "idcomboMealId": "ce847c79-9eb5-4be3-8a1e-842919aa5ba0"4000045, // Offer PLU for vanilla   cone
                "menuSelectionscomboItem": [],
     {
                  "pricemenuItemId": {4000045, // Offer PLU for vanilla cone
                   "definitionSequence": 1,
  "amount": 0,             "quantity": 1
            },
 "currency": "SAR"          "mainItem": {
             },   "menuItemId": 1014013, // Vanilla Cone ALC
                "quantitydefinitionSequence": 1,
                "quantity": 1
      "type": "Item"     },
            "sideItems": []
 },       }
    ],
    "tenders": [
  {      {
            "tenderId": 901
    "externalReferenceId": "142538",   }
    ]
}
Offer with a combo
 Expand
titleRBI Partner API
 Code Block
languagejson
"cart": {
  "menuSelections": [
    {
      "idexternalReferenceId": "1425388351", // offer plu
      "id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //offer sanity      id
        "menuSelections": [],
            {
           "price": {    "externalReferenceId": "8167", // combo plu
                    "amountid": 0"d90a7113-0620-44d9-b678-743330a2f207", //combo         sanity id
                  "currencymenuSelections": "SAR"[
                    {
   },
                        "quantityexternalReferenceId": 1"80003",
                        "typeid": "Item"ce847c79-9eb5-4be3-8a1e-842919aa5ba0",
                    }         "menuSelections": [],
       ],                 "price": {
                            "amount": 5000, //price of the combo
                            "currency": "SAR"
                },         },
       ],                 "pricequantity": {1,
                "amount": 100, // final price of the offer "type": "Item"
              "currency": "SAR"     },
           },         {
       "quantity": 1,
                "typeexternalReferenceId": "Offer142538",
            }         ]     },
 Expand
titleOracle TS Gen 2 (Commit call)
 Code Block
Offer with a picker
 Expand
titleRBI Partner API
 Code Block
languagejson
"cart": {
  "menuSelections": ["id": "142538",
                 {       "externalReferenceIdmenuSelections": "8351", // offer plu [],
           "id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //offer sanity id         "menuSelectionsprice": [
{
           {                 "externalReferenceIdamount": "8168", //combo plu0,
                            "idcurrency": "3318d2c2-99d3-40f9-92d2-1798d9c5e987", //combo sanity idSAR"
                        },
   "menuSelections": [                     {"quantity": 1,
                        "externalReferenceIdtype": "20001Item",
                    }
   "id": "item_61936",            ],
            "menuSelections": [],   "price": {
                    "priceamount": {
       500, //price of the combo
                    "amountcurrency": 0,"SAR"
                },
           "currency": "SAR"    ],
                "price": {
  },              "amount": 100, // final price of the offer
   "quantity": 1,            "currency": "SAR"
           "type": "Item"    },
                }"quantity": 1,
                "type": "Offer"
  {          }
        ]
     "externalReferenceId": "80002",
   },
 Expand
titleOracle TS Gen 2 (Commit call)
 Code Block
languagejson
{
    "header": {
        "orgShortName": "{{OrgShortName}}",
          "idlocRef": "865a632f-e2f7-4e2b-8fcc-9281aa3f5868",{{LocRef}}",
        "rvcRef": {{RvcRef}},
        "idempotencyId": "{{$guid}}",
        "menuSelectionsorderTypeRef": []9,
        "checkEmployeeRef": {{check_employee_ref}}
    },
    "menuItems": [],
    "pricecomboMeals": {[
        {
            "comboMealId": 4000045, // Buy one Cone, Get one Cone "amount": 0,
 for free Offer PLU
            "comboItem": {
            "currency": "SAR"   "menuItemId": 4000045, // Buy one Cone, Get one Cone for free Offer PLU
         },       "definitionSequence": 1,
                "quantity": 1,
            },
            "typesideItems": "Item"[{
                    }"menuItemId": 1014013, // Vanilla Cone (could be any selection of cones)
           {        "definitionSequence": 1,
                "externalReferenceIdquantity": "80008",1
            },
           "id": "04462c22-bf58-4eee-842a-213e3d17a072",
  {
                      "menuSelections"menuItemId": []1014012, // Strawberry Cone (could be any selection of cones)
                "pricedefinitionSequence": {1,
                            "amount": 0,"quantity": 1
            }]
        }
    ],
    "currencytenders": "SAR"[
        {
            "tenderId": 901
 },       }
    ]
}
Offer with a cart discount
 Expand
titleRBI Partner API
 Code Block
languagejson
{
    "payload": {
        "quantitynumber": 1"5814",
        "fees": [
            {
 "type": "Item"              "total": {
     },               "amount": 19,
    {                "currency": "EUR"
       "externalReferenceId": "142538",        },
                "idtype": "142538BAG_FEE",
                }
       "menuSelections": [],
              "serviceMode": "DELIVERY",
         "pricechannel": {"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",
        "amountorderDiscounts": [
0,            {
                "currencytype": "SARpercentage",
                "value": 20
      },      }
         ],
        "quantitystoreId": 1"12349",
           "cart": {
            "typemenuSelections": "Item"
                [
   }             {
   ],                 "priceexternalReferenceId": {"502633",
                    "amountquantity": 5001,
//price of the combo                 "price": {
  "currency": "SAR"                 },    "amount": 645,
         ],               "pricecurrency": { "EUR"
                   "amount": 100},
// final price of the offer               "currencyid": "SARitem_11107",
              },                 "quantity"type": 1,"Item"
                "type": "Offer"}
            ]
}        }
]    }
},
 Expand
 Expand
titleOracle TS Gen 2 (Commit call)
 Code Block
Offer with a cart discount
titleRBI Partner API
 Code Block
languagejson
{
    "payloadheader": {
        "numberorgShortName": "5814{{OrgShortName}}",
        "feeslocRef": ["{{LocRef}}",
        "rvcRef": {{RvcRef}},
  {      "idempotencyId": "{{$guid}}",
         "totalorderTypeRef": {9,
        "checkEmployeeRef": {{check_employee_ref}}
     },
    "amountmenuItems": 19,[
         {           "currency"menuItemId": "EUR"
 1001001, // Whopper ALC
              },
   "definitionSequence": 1,
            "typequantity": 1
"BAG_FEE"        }
    }],
    "tenders": [
  ],      {
  "serviceMode": "DELIVERY",         "channeltenderId": "WHITELABEL_DELIVERY",901
        "callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/6d66a02e-810f-478f-bf0d-b69bfcb56d51/price/callback",}
    ],
    "iddiscounts" : "6d66a02e-810f-478f-bf0d-b69bfcb56d51", [
        {
    "orderDiscounts": [       "discountId": 106, // PLU for the {cart level percent discount 
            "typereferenceText": "percentageOffer 1234",
            "total": 10 // the percentage that you  "value": 20
       are discounting. 10% off. We can send whatever percentage we want
    }    }
    ],
   
}
Offer with a product discount
 Expand
titleRBI Partner API
 Code Block
{
    "storeIdpayload": "12349",{
        "cartnumber": {
 "5821",
          "menuSelectionsfees": [
   
            {
                    "externalReferenceIdtotal": "502633",{
                    "quantityamount": 119,
                    "pricecurrency": {"EUR"
                        "amount": 645,
       },
                "currencytype": "EURBAG_FEE"
                    },
           ],
        "idserviceMode": "item_11107",
          DELIVERY",
         "typechannel": "ItemWHITELABEL_DELIVERY",
        "callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/ed50be10-cf7c-4b1c-8bb1-0c2625cbf3be/price/callback",
      }  "id": "ed50be10-cf7c-4b1c-8bb1-0c2625cbf3be",
        "orderDiscounts": ][
        }    {
} }
 Expand
titleOracle TS Gen 2 (Commit call)
 Code Block
Offer with a product discount
 Expand
titleRBI Partner API
 Code Block
{     "payload": {         "numberplu": "5821502617",
             "fees": [  "type": "percentage",
         {       "value": 20
        "total": {   }
        ],
        "amountstoreId": 19"12349",
        "cart": {
            "currencymenuSelections": "EUR"[
                {
   },                 "typeexternalReferenceId": "BAG_FEE502617",
            }        "quantity": ]1,
          "serviceMode": "DELIVERY",         "channelmenuSelections": "WHITELABEL_DELIVERY",[
        "callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/ed50be10-cf7c-4b1c-8bb1-0c2625cbf3be/price/callback",         "id": "ed50be10-cf7c-4b1c-8bb1-0c2625cbf3be",         "orderDiscounts": [ {
           {                 "pluexternalReferenceId": "502617502633",
                      "type      "quantity": "percentage",1,
                   "value         "price": {
 20             }         ],         "storeIdamount": "12349"0,
         "cart": {                       "currency": "EUR"
                  "menuSelections": [         },
       {                     "externalReferenceIdid": "502617item_11107",
                            "quantitytype": 1,"Item"
                       "menuSelections": [ },
                        {
                            "externalReferenceId": "502633942258",
                            "quantity": 1,
                            "price": {
                                "amount": 0,
                                "currency": "EUR"
                            },
                            "id": "item_1110711126",
                            "type": "Item"
                        },
                        {
                            "externalReferenceId": "942258527646",
                            "quantity": 1,
                            "price": {": {
                                "amount": 0,
                                "currency": "EUR"
                            },
                            "amountid": 0,
   "9aac0a46-5a73-431d-937c-8848ca01ac86",
                            "currencytype": "EURItem"
   
                        },
                    ],
       "id": "item_11126",            "price": {
               "type": "Item"        "amount": 875,
               },         "currency": "EUR"
              {      },
                      "externalReferenceIdid": "527646a2e73fd9-5f3d-4afc-9585-43ebd7bbc6dc",
                    "type": "Offer"
      "quantity": 1,         }
            ]
      "price": { }
         }
}
 Expand
titleOracle TS Gen 2 (Commit call)
 Code Block
languagejson
{
          "header": {
          "amountorgShortName": 0"{{OrgShortName}}",
        "locRef": "{{LocRef}}",
        "rvcRef": {{RvcRef}},
            "currencyidempotencyId": "EUR{{$guid}}",
        "orderTypeRef": 9,
        "checkEmployeeRef": {{check_employee_ref}}
        },
    "menuItems": [
         {
            "idmenuItemId": "9aac0a46-5a73-431d-937c-8848ca01ac86"1001001, // Whopper
            "definitionSequence": 1,
            "typequantity": "Item"
          1,
            "itemDiscounts": [
}                {
    ],                "discountId": 106, // PLU of "price": {
   the product percent discount off
                    "amountreferenceText": 875,"Offer Item Discount",
                      "currencytotal": "EUR"50 // percentage discount (can be sent as any percentage). 50% off the whopper ALC price.
     },           }
         "id": "a2e73fd9-5f3d-4afc-9585-43ebd7bbc6dc",  ]
        }
    ],
    "typetenders": "Offer"[
        {
       }             ]"tenderId": 901
        }
    }]
}
 Expand
titleOracle TS Gen 2 (Commit call)
code
Reference
NMS guides on how to set up offers and rewards in Sanity for Oracle: /wiki/spaces/MS/pages/4057661622