Oracle API - Rewards
- Benet, Anton
Payloads in this section refer to the examples documented here: Oracle Config - Rewards
Payloads
The structure of order payloads sent to Khumbu is the same, regardless of whether rewards are configured as discounts or combos. If configured as discounts, the externalReferenceId field will have a D- suffix, for example D-129.
Scenario | Payload |
|---|---|
Reward 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", // Oracle Discount ID
"id": "31049d5a-4047-4965-8780-8ff2f37775dc", // Sanity Discount ID
"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": 0, // reward price
"currency": "PLN"
},
"quantity": 1,
"type": "Reward"
},
{
"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"
} |
Reward combos
| "cart": {
"menuSelections": [
{
"externalReferenceId": "D-105", // Oracle Discount ID
"id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", // Sanity Discount ID
"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": 0, // final price of the reward
"currency": "SAR"
},
"quantity": 1,
"type": "Reward"
}
]
}, |
Reward with pricesReward that costs $3 and 1,000 loyalty points This will not be in scope for first Oracle rollout and release (BK UK, BK DE, CEE, etc.)
| {
"callbackUrl": "https://euc1-staging-plk-partners-api.rbictg.com/api/v1/orders/773c6655-a9ad-4e5b-9581-143d43c4f463/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "D-106", // Oracle Discount ID
"id": "31049d5a-4047-4965-8780-8ff2f37775dc", // Sanity Discount ID
"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": 300, // reward price
"currency": "PLN"
},
"quantity": 1,
"type": "Reward"
}
]
},
"channel": "WHITELABEL_IN_STORE",
"fees": [],
"id": "773c6655-a9ad-4e5b-9581-143d43c4f463",
"instructions": [],
"number": "M360",
"orderDiscounts": [],
"serviceMode": "TAKEOUT",
"storeId": "48002"
} |
Reward cart level discountIf guests spend 200 loyalty points, they can unlock a 20% off in the total value of the cart discount.
| |
Reward product discountIf guests spend 200 loyalty points, they can unlock a 50% off only in the Whopper a la carte product.
|