Oracle API - Offers
- Benet, Anton
Analytics
Payloads in this section refer to the examples documented here: Oracle Config - Offers
Payloads
The structure of order payloads sent to Khumbu is the same, regardless of whether offers are configured as discounts or combos. If configured as discounts, the externalReferenceId field will have a D- suffix, for example D-129.
Scenario | Payload |
|---|---|
Offer items
 | {
"callbackUrl": "https://euc1-staging-plk-partners-api.rbictg.com/api/v1/orders/773c6655-a9ad-4e5b-9581-143d43c4f463/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "D-105", // offer discount id
"id": "31049d5a-4047-4965-8780-8ff2f37775dc",
"menuSelections": [
{
"externalReferenceId": "100-1-1", // item PLU
"id": "ba322af6-a956-4c6b-8bf2-d6fea3c351fd",
"menuSelections": [],
"price": {
"amount": 2495,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
}
],
"price": {
"amount": 200, // offer price
"currency": "PLN"
},
"quantity": 1,
"type": "Offer"
},
{
"externalReferenceId": "200-1-1", // item PLU
"id": "31049d5a-4047-4965-8780-8ff2f37775dc",
"price": {
"amount": 2400,
"currency": "PLN"
},
"quantity": 1,
"type": "Item"
}
]
},
"channel": "WHITELABEL_IN_STORE",
"fees": [],
"id": "773c6655-a9ad-4e5b-9581-143d43c4f463",
"instructions": [],
"number": "M360",
"orderDiscounts": [],
"serviceMode": "TAKEOUT",
"storeId": "48002"
} |
Offer combos
| "cart": {
"menuSelections": [
{
"externalReferenceId": "105", // offer discount id
"id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f",
"menuSelections": [
{
"externalReferenceId": "100-1-1", // combo plu
"id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //combo sanity id
"menuSelections": [
{
"externalReferenceId": "101-1-1", // item 1 plu
"id": "item_1852",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "SAR"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "102-1-1", // item 2 plu
"id": "4f99db1e-128a-4e53-b23b-dffc0fedf636",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "SAR"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "103-1-1", // item 3 plu
"id": "16f482db-2f13-4476-88d3-d2eec26057f3",
"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": 100, // final price of the offer
"currency": "SAR"
},
"quantity": 1,
"type": "Offer"
}
]
}, |
Offer cart level discount20% off in the total value of the cart
| {
"callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/b311434d-e4ee-4bfb-a3b7-c84bb5bcfb1d/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "100-1-1",
"id": "7403727e-949c-42b6-a544-5f2124e17c5c",
"menuSelections": [
{
"externalReferenceId": "101-1-1",
"id": "item_11177",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "102-1-1",
"id": "2d874c0a-37da-406e-a50e-cd3cd9c5c710",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
}
],
"price": {
"amount": 425,
"currency": "EUR"
},
"quantity": 1,
"type": "Combo"
},
{
"externalReferenceId": "D-107", // Oracle Discount ID
"id": "08e4ccf5-23fc-4bc7-a800-a7703e7228c6",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Offer"
}
]
},
"channel": "WHITELABEL_IN_STORE",
"fees": [
{
"total": {
"amount": 48,
"currency": "EUR"
},
"type": "BAG_FEE"
}
],
"id": "b311434d-e4ee-4bfb-a3b7-c84bb5bcfb1d",
"instructions": [],
"number": "6406",
"orderDiscounts": [
{
"type": "amount",
"value": 200
}
],
"serviceMode": "DRIVE_THRU",
"storeId": "12349"
} |
Offer product discountThis will not be in scope for first Oracle rollout and release (BK UK, BK DE, CEE, etc.) 50% off only in the Whopper a la carte product
|