Contents
Cart Structures
Item | |
|---|---|
Item |  {
"callbackUrl": "https://euw3-staging-plk-partners-api.rbictg.com/api/v1/orders/c5412daa-f7e9-455c-9bf6-e1c1bb8d16c7/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "801500",
"id": "item_67165",
"menuSelections": [],
"price": {
"amount": 649,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
}
]
},
"channel": "WHITELABEL_DELIVERY",
"fees": [],
"id": "c5412daa-f7e9-455c-9bf6-e1c1bb8d16c7",
"instructions": [],
"number": "4999",
"orderDiscounts": [],
"serviceMode": "DELIVERY",
"storeId": "1111"
}
|
Item w/ modifiers |  {
"callbackUrl": "https://euw3-staging-plk-partners-api.rbictg.com/api/v1/orders/6e9d20f9-e3ae-47b4-87cd-3f9e3637f20a/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "801500",
"id": "item_67165",
"menuSelections": [
{
"externalReferenceId": "940289",
"id": "34933841d0e7",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "ItemOptionModifier"
},
{
"externalReferenceId": "940294",
"id": "2fb34e217cf2",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "ItemOptionModifier"
}
],
"price": {
"amount": 649,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
}
]
},
"channel": "WHITELABEL_DELIVERY",
"fees": [],
"id": "6e9d20f9-e3ae-47b4-87cd-3f9e3637f20a",
"instructions": [],
"number": "5498",
"orderDiscounts": [],
"serviceMode": "DELIVERY",
"storeId": "7777"
}
|
Combo | |
|---|---|
Combo |  {
"callbackUrl": "https://euw3-staging-plk-partners-api.rbictg.com/api/v1/orders/b1f2302b-723b-416f-bdc6-1e2f9659caaf/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "940269",
"id": "3ffc8d3e-7c67-4410-8fbd-cd1b366fbf20",
"menuSelections": [
{
"externalReferenceId": "801500",
"id": "item_67165",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "942214",
"id": "item_50929",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "942215",
"id": "item_66018",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "940325",
"id": "45adf5bb-2f3d-4c40-a735-cf59d5a661ef",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
}
],
"price": {
"amount": 849,
"currency": "EUR"
},
"quantity": 1,
"type": "Combo"
}
]
},
"channel": "WHITELABEL_DELIVERY",
"fees": [],
"id": "b1f2302b-723b-416f-bdc6-1e2f9659caaf",
"instructions": [],
"number": "5495",
"orderDiscounts": [],
"serviceMode": "DELIVERY",
"storeId": "7777"
}
|
Combo with items with modifiers |  {
"callbackUrl": "https://euw3-staging-plk-partners-api.rbictg.com/api/v1/orders/3e7b0a1b-7373-4024-8916-83057924988a/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "940269",
"id": "3ffc8d3e-7c67-4410-8fbd-cd1b366fbf20",
"menuSelections": [
{
"externalReferenceId": "801500",
"id": "item_67165",
"menuSelections": [
{
"externalReferenceId": "940275",
"id": "9cbf858b2190",
"menuSelections": [],
"price": {
"amount": 1000,
"currency": "EUR"
},
"quantity": 1,
"type": "ItemOptionModifier"
},
{
"externalReferenceId": "940294",
"id": "2fb34e217cf2",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "ItemOptionModifier"
}
],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "942214",
"id": "item_50929",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "940209",
"id": "item_66033",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "940325",
"id": "45adf5bb-2f3d-4c40-a735-cf59d5a661ef",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
}
],
"price": {
"amount": 849,
"currency": "EUR"
},
"quantity": 1,
"type": "Combo"
}
]
}
|
Combo with Premium Items | |
Systemwide Offer | |
|---|---|
Item |  |
Combo 
 | {
"callbackUrl": "https://euc1-staging-plk-partners-api.rbictg.com/api/v1/orders/f07c593e-0d35-4845-8509-cce96a0b0b59/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "4017", # (plu-Offer) Mechanics > Vendor Configs > Partner > Constant PLU
"id": "24f239c0-e8de-4d13-9967-bb96b8aef2b4", # Combo PLU: Mechanics > In-App Benefits > Add Item… > Combo
"menuSelections": [
{
"externalReferenceId": "3001001", # Vendor Configs > Partner > Constant PLU
"id": "74c5465d-bd85-413b-b730-e1eece111125", # product Id inside the combo
"menuSelections": [],
"price": {
"amount": 1995,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
}
],
"price": {
"amount": 1895,
"currency": "PLN"
},
"quantity": 1,
"type": "OfferCombo" # The Offer configs only accept combos as OfferCombo
}
]
},
"channel": "WHITELABEL_IN_STORE",
"fees": [],
"id": "f07c593e-0d35-4845-8509-cce96a0b0b59",
"instructions": [],
"number": "M346",
"serviceMode": "TAKEOUT",
"storeId": "48002"
}
|
Combo w/ modifier 
| {
"callbackUrl": "https://euc1-staging-plk-partners-api.rbictg.com/api/v1/orders/ea7645b5-1ce9-44c2-be77-946e3187a0fa/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "4017",
"id": "45808975-71c2-459e-8809-3c9635c68d97",
"menuSelections": [
{
"externalReferenceId": "3001001",
"id": "74c5465d-bd85-413b-b730-e1eece111125",
"menuSelections": [],
"price": {
"amount": 1995,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "3500001",
"id": "aec9dc8a-afc1-420d-bfc4-fd7c004e6c16",
"menuSelections": [
{
"externalReferenceId": "8002001",
"id": "406f327f8d6f",
"menuSelections": [],
"price": {
"amount": 25,
"currency": "PLN"
},
"quantity": 1,
"type": "ItemOptionModifier"
}
],
"price": {
"amount": 995,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
}
],
"price": {
"amount": 1895,
"currency": "PLN"
},
"quantity": 1,
"type": "OfferCombo"
}
]
},
"channel": "WHITELABEL_IN_STORE",
"fees": [],
"id": "ea7645b5-1ce9-44c2-be77-946e3187a0fa",
"instructions": [],
"number": "M349",
"serviceMode": "TAKEOUT",
"storeId": "48002"
}
|
Config Offers | |
|---|---|
Amount discount
 When we added only the promo item, we are not able to checkout, so I added an extra Chicken Sandwich 
| {
"callbackUrl": "https://euc1-staging-plk-partners-api.rbictg.com/api/v1/orders/ec2ca2e1-f490-492d-b320-2dae80e9befa/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "3001001",
"id": "690f1bc2-f254-4ec6-b5be-8215ee023a6f",
"menuSelections": [],
"price": {
"amount": 1995,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "2002",
"id": "4fa240c0-d2f0-4ca3-8736-4c62e798267a", # Sanity ID
"menuSelections": [],
"price": {
"amount": 0,
"currency": "PLN"
},
"quantity": 1,
"type": "OfferDiscount"
}
]
},
"channel": "WHITELABEL_IN_STORE",
"fees": [],
"id": "ec2ca2e1-f490-492d-b320-2dae80e9befa",
"instructions": [],
"number": "M351",
"orderDiscounts": [ # Amount Discount Specific
{
"type": "amount",
"value": 3
}
],
"serviceMode": "TAKEOUT",
"storeId": "48002"
}
|
Percentage discount
 Same case here, I added a 20% discount code and I choose an extra Chicken Sandwich  | {
"callbackUrl": "https://euc1-staging-plk-partners-api.rbictg.com/api/v1/orders/390d643e-3a45-4962-972b-fb4fe8488a3c/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "3001001",
"id": "690f1bc2-f254-4ec6-b5be-8215ee023a6f",
"menuSelections": [],
"price": {
"amount": 1995,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "2001",
"id": "f63248d2-f817-4c2b-8591-839809341ac6",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "PLN"
},
"quantity": 1,
"type": "OfferDiscount"
}
]
},
"channel": "WHITELABEL_IN_STORE",
"fees": [],
"id": "390d643e-3a45-4962-972b-fb4fe8488a3c",
"instructions": [],
"number": "M352",
"orderDiscounts": [
{
"type": "percentage",
"value": 20
}
],
"serviceMode": "TAKEOUT",
"storeId": "48002"
}
|
Reward | |
|---|---|
Item 
| {
"callbackUrl": "https://euc1-staging-plk-partners-api.rbictg.com/api/v1/orders/773c6655-a9ad-4e5b-9581-143d43c4f463/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "3005019",
"id": "31049d5a-4047-4965-8780-8ff2f37775dc",
"menuSelections": [
{
"externalReferenceId": "3004004",
"id": "ba322af6-a956-4c6b-8bf2-d6fea3c351fd",
"menuSelections": [],
"price": {
"amount": 2495,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
}
],
"price": {
"amount": 0,
"currency": "PLN"
},
"quantity": 1,
"type": "OfferCombo" ############ OfferCombo???
}
]
},
"channel": "WHITELABEL_IN_STORE",
"fees": [],
"id": "773c6655-a9ad-4e5b-9581-143d43c4f463",
"instructions": [],
"number": "M360",
"orderDiscounts": [],
"serviceMode": "TAKEOUT",
"storeId": "48002"
}
|
Combo 
| {
"callbackUrl": "https://euc1-staging-plk-partners-api.rbictg.com/api/v1/orders/1f4022f9-f825-430c-ac05-8aa6673731e2/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "3005019",
"id": "a943b901-b05c-4a02-ac34-40e7c403a214",
"menuSelections": [
{
"externalReferenceId": "3011005",
"id": "074cdc86-6c51-4554-9579-ac6e1301ba58",
"menuSelections": [],
"price": {
"amount": 295,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "3011005",
"id": "074cdc86-6c51-4554-9579-ac6e1301ba58",
"menuSelections": [],
"price": {
"amount": 295,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "3011005",
"id": "074cdc86-6c51-4554-9579-ac6e1301ba58",
"menuSelections": [],
"price": {
"amount": 295,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "3011005",
"id": "074cdc86-6c51-4554-9579-ac6e1301ba58",
"menuSelections": [],
"price": {
"amount": 295,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "3011005",
"id": "074cdc86-6c51-4554-9579-ac6e1301ba58",
"menuSelections": [],
"price": {
"amount": 295,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
}
],
"price": {
"amount": 0,
"currency": "PLN"
},
"quantity": 1,
"type": "OfferCombo"
}
]
},
"channel": "WHITELABEL_IN_STORE",
"fees": [],
"id": "1f4022f9-f825-430c-ac05-8aa6673731e2",
"instructions": [],
"number": "M361",
"orderDiscounts": [],
"serviceMode": "TAKEOUT",
"storeId": "48002"
}
|
Combo with item with modifier   | {
"callbackUrl": "https://euc1-staging-plk-partners-api.rbictg.com/api/v1/orders/1f4022f9-f825-430c-ac05-8aa6673731e2/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "3005019",
"id": "a943b901-b05c-4a02-ac34-40e7c403a214",
"menuSelections": [
{
"externalReferenceId": "3011005",
"id": "074cdc86-6c51-4554-9579-ac6e1301ba58",
"menuSelections": [],
"price": {
"amount": 295,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "3011005",
"id": "074cdc86-6c51-4554-9579-ac6e1301ba58",
"menuSelections": [],
"price": {
"amount": 295,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "3011005",
"id": "074cdc86-6c51-4554-9579-ac6e1301ba58",
"menuSelections": [],
"price": {
"amount": 295,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "3011005",
"id": "074cdc86-6c51-4554-9579-ac6e1301ba58",
"menuSelections": [],
"price": {
"amount": 295,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "3011005",
"id": "074cdc86-6c51-4554-9579-ac6e1301ba58",
"menuSelections": [],
"price": {
"amount": 295,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
}
],
"price": {
"amount": 0,
"currency": "PLN"
},
"quantity": 1,
"type": "OfferCombo"
}
]
},
"channel": "WHITELABEL_IN_STORE",
"fees": [],
"id": "1f4022f9-f825-430c-ac05-8aa6673731e2",
"instructions": [],
"number": "M361",
"orderDiscounts": [],
"serviceMode": "TAKEOUT",
"storeId": "48002"
}
|
Difference between Combo Offer and Combo
Combo Offer
Sanity:
Test - Offer Combo - 05d1888d-789e-4517-8ca9-506ff1bb2c2d
vendorConfigs>partner> 4017incentives>24f239c0-e8de-4d13-9967-bb96b8aef2b4(ComboOffer Test Combo with just one Ck. Sandwich)vendorConfigs>partner> 3001001options>12172b84-ff62-43fd-af6e-33a4a297711f(comboSlot Test - Combo Slot Chicken Sandwich)options>option>74c5465d-bd85-413b-b730-e1eece111125(item Test Chicken Sandwich)
{
"externalReferenceId": "4017", # This number is the Systemwide Offer Vendor Plu
"id": "24f239c0-e8de-4d13-9967-bb96b8aef2b4", # This number is the Inner Item (ComboOffer) Sanity Id
"menuSelections": [
{
"externalReferenceId": "3001001", # This number is the ComboOffer Vendor Plu
"id": "74c5465d-bd85-413b-b730-e1eece111125" # This is the inner Item id
"menuSelections": [],
"price": { "amount": 1995, "currency": "PLN" },
"quantity": 1,
"type": "Item"
}
],
"price": { "amount": 1895, "currency": "PLN" },
"quantity": 1,
"type": "OfferCombo"
},
Combo
Sanity:
A. Supreme Chicken Sandwich Meal (Combo)
vendorConfigs>partner> 3001020id>8adbaec9-48ee-48f9-b733-04cba561c629mainItem>0ba8ec59-9f2b-4011-a5cb-9974a9c0f26fvendorConfigs>partner> 3001019
{
"externalReferenceId": "3001020", # This number is the Combo Vendor Plu
"id": "8adbaec9-48ee-48f9-b733-04cba561c629", # This number is the combo Sanity Id
"menuSelections": [
{
"externalReferenceId": "3001019", # This number is the Main Item Vendor Plu
"id": "0ba8ec59-9f2b-4011-a5cb-9974a9c0f26f", # This number is the Main Item Sanity Id
"menuSelections": [],
"price": { "amount": 2495, "currency": "PLN" },
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "3500001",
"id": "aec9dc8a-afc1-420d-bfc4-fd7c004e6c16",
"menuSelections": [
{
"externalReferenceId": "8002001",
"id": "406f327f8d6f",
"menuSelections": [],
"price": { "amount": 25, "currency": "PLN" },
"quantity": 1,
"type": "ItemOptionModifier"
}
],
"price": { "amount": 995, "currency": "PLN" },
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "3010006",
"id": "6de63121-74dd-4f6b-80b9-6283b391f2e8",
"menuSelections": [],
"price": { "amount": 895, "currency": "PLN" },
"quantity": 1,
"type": "Item"
}
],
"price": { "amount": 3295, "currency": "PLN" },
"quantity": 1,
"type": "Combo"
}