Versions Compared

Key

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

...

Expand
titleOracle TS Gen 2 (Commit call)
Code Block

Reward with a combo

Expand
titleRBI Partner API
Code Block
"cart": {{
    "menuSelectionsheader": [
  {
 {       "externalReferenceIdorgShortName": "8351{{OrgShortName}}",
// reward plu       "idlocRef": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //reward sanity id{{LocRef}}",
         "menuSelectionsrvcRef": [{{RvcRef}},
        "idempotencyId": "{{$guid}}",
  {      "orderTypeRef": 9,
         "externalReferenceIdcheckEmployeeRef": "8350"{{check_employee_ref}},
// combo plu        "language": "es-ES",
        "idAccept-Language": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //combo sanity ides-ES"
    },
    "menuItems": [],
      "menuSelectionscomboMeals": [
        {
           { "comboMealId": 51002003, // Cheeseburger reward
            "comboItem": {
     "externalReferenceId": "10059",          "menuItemId": 51002003, // Cheeseburger  reward
         "id": "item_1852",       "definitionSequence": 1,
                "menuSelectionsquantity": [],1
            },
            "pricemainItem": {
                "menuItemId": 1002003, // Cheeseburger ALC
       "amount": 0,        "definitionSequence": 1,
                   "currencyquantity": "SAR"1,
                "condiments": [
      },              {
          "quantity": 1,             "condimentId": 9011005, // Add bacon. Premium modifier (extra cost)
   "type": "Item"                    "priceSequence": }2,
                    {    "quantity": 2
                   "externalReferenceId": "80007", }
                   ]
    "id": "4f99db1e-128a-4e53-b23b-dffc0fedf636",            },
            "menuSelectionssideItems": [],
        }
    ],
    "tenders": [
      "price":  {
            "tenderId": 901
        }
    ]
"amount}

Reward with a combo

Expand
titleRBI Partner API
Code Block
"cart": 0,{
  "menuSelections": [
    {
      "externalReferenceId": "8351", // reward   plu
      "currencyid": "SAR"
  43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //reward sanity id
        "menuSelections": [
           },
        {
                "quantityexternalReferenceId": 1"8350", // combo      plu
                "typeid": "Item"
  43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //combo sanity id
                 },"menuSelections": [
                    {
                        "externalReferenceId": "8000110059",
                        "id": "16f482db-2f13-4476-88d3-d2eec26057f3item_1852",
                        "menuSelections": [],
                        "price": {
                            "amount": 0,
                            "currency": "SAR"
                        },
                        "quantity": 1,
                        "type": "Item"
                    },
                    {
                        "externalReferenceId": "14113980007",
                        "id": "1411394f99db1e-128a-4e53-b23b-dffc0fedf636",
                        "menuSelections": [],
                        "price": {
                            "amount": 0,
                            "currency": "SAR"
                        },
                        "quantity": 1,
                        "type": "Item"
                    },
                ],        {
        "price": {                 "amountexternalReferenceId": 300"80001",
  //  original price of combo                 "currencyid": "SAR"16f482db-2f13-4476-88d3-d2eec26057f3",
                 },       "menuSelections": [],
         "quantity": 1,
                 "typeprice": "Combo"{
                 }               ]"amount": 0,
              "price": {               "amountcurrency": 0, // final price of the reward"SAR"
                  "currency": "SAR"     },
         },               "quantity": 1,
                        "type": "RewardItem"
            }        },
 ]     },
Expand
titleOracle TS Gen 2 (Commit call)
Code Block
languagejson
{     "header": {        {
"orgShortName": "{{OrgShortName}}",         "locRef": "{{LocRef}}",         "rvcRef": {{RvcRef}},
        "idempotencyIdexternalReferenceId": "{{$guid}}141139",
  
     "orderTypeRef": 9,         "checkEmployeeRef": {{check_employee_ref}},         "languageid": "es-ES141139",
  
     "Accept-Language": "es-ES"             },     "menuItemsmenuSelections": [],
    "comboMeals": [         {
            "comboMealIdprice": 51001504,
{
           "comboItem": {                 "menuItemIdamount": 510015040,
                "definitionSequence": 1,           "currency": "SAR"
    "quantity":  1             },     },
       "mainItem": {                 "menuItemIdquantity": 10010031,
                "definitionSequence": 1,
                "quantitytype": 1"Item"
            },        }
    "sideItems": [           ],
     {                     "menuItemId"price": 1013201,
   {
                "definitionSequenceamount": 1300, // original price of combo
                "quantitycurrency": 1"SAR"
                 },
                {   "quantity": 1,
                 "menuItemIdtype": 2102002,"Combo"
                 }
  "definitionSequence": 1,           ],
         "quantity": 1    "price": {
           }   "amount": 0, // final price of the reward
  ]         }   "currency": "SAR"
 ],     "tenders": [       },
 {             "tenderIdquantity": 9011,
        }     ] }

Reward with a cart discount

Code Block
languagejson
"payload
"type": 
{
"Reward"
    
"number":
 
"5803",
     
"fees":
 
[
 }
       
{
 ]
    },
Expand
titleOracle TS Gen 2 (Commit call)
Code Block
languagejson
{
    
"
total
header": {
        "orgShortName": "{{OrgShortName}}",
        "
amount
locRef": 
19
"{{LocRef}}",
        "rvcRef": {{RvcRef}},
        "
currency
idempotencyId": "
EUR
{{$guid}}",
        "orderTypeRef": 9,
   
},
     "checkEmployeeRef": {{check_employee_ref}},
        "
type
language": "
BAG_FEE"
es-ES",
        
}
"Accept-Language": "es-ES"      
],
  
   
"serviceMode": "DELIVERY",
 },
    "
channel
menuItems": 
"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": [ {
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
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

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
{
    "header": {
        "orgShortName": "{{OrgShortName}}",
        
"
type
locRef": "
amount
{{LocRef}}",

        "
value
rvcRef": 
200
{{RvcRef}},
        
}
"idempotencyId": "{{$guid}}",
   
],
     "
storeId
orderTypeRef": 
"12349",
9,
        "
cart
checkEmployeeRef": 
{
{{check_employee_ref}}
    },
    "
menuSelections
menuItems": [
        {   
{
"menuItemId":1001001, // Whopper ALC
            
"
externalReferenceId
definitionSequence": 
"502633"
1,
            
"quantity": 1
,

        }
    ],
    "
price
tenders": [
{
        {
            "
amount
tenderId": 
645,
901
        }
    
],
    
"
currency
discounts" : 
"EUR"
[
        {
            "discountId": 
}
104, // PLU for the cart level amount discount 
            "
id
referenceText": "
item_11107
Reward 1234",

            "
type
total": 
"Item"
10 // the amount that you are discounting. 10 euros off.
   
}
     }
    ]
}

}

Reward with a product discount

...