Contents
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Payload format
| Info |
|---|
This section explains changes to the format of the |
Rewards Structure
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
| 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"
}
]
}
]
}
] |
Reward with
...
an item + premium modifier
| Code Block |
|---|
"cart": [ { "menuSelections": [ { "externalReferenceIdid": "8351",7ee7338a-a016-47c6-aef6-3783d40c003e", // Reward Sanity id reward plu "idexternalReferenceId": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f123", //reward sanity id Reward constant plu defined in Sanity "menuSelectionsquantity": 1, [ "price": { { "amount": 0, "externalReferenceIdcurrency": "8350SAR", // combo plu } "idtype": "43b4cf07-79c9-4aff-98d1-bce9cf2d890fReward", //combo sanity id "menuSelections": [ "menuSelections": [ { "externalReferenceId": "51056", // item constant plu { "id": "item_1862", // item Sanity id "externalReferenceIdmenuSelections": "10059"[], "price": { "id": "item_1852", "amount": 2495, // normal price "menuSelectionscurrency": [],"SAR" }, "pricequantity": {1, "type": "Item" } "amount": 0, ] } ] } ] |
Reward with a combo
| Code Block |
|---|
"cart": { "menuSelections": [ { "currencyexternalReferenceId": "SAR8351", // reward plu "id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //reward sanity id "menuSelections": [ }, { "quantityexternalReferenceId": 1"8350", // combo plu "type"id": "Item" 43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //combo sanity id },"menuSelections": [ { "externalReferenceId": "8000710059", "id": "4f99db1e-128a-4e53-b23b-dffc0fedf636item_1852", "menuSelections": [], "price": { "amount": 0, "currency": "SAR" }, "quantity": 1, "type": "Item" }, { "externalReferenceId": "8000180007", "id": "16f482db4f99db1e-2f13128a-44764e53-88d3b23b-d2eec26057f3dffc0fedf636", "menuSelections": [], "price": { "amount": 0, "currency": "SAR" }, "quantity": 1, "type": "Item" }, { "externalReferenceId": "14113980001", "id": "14113916f482db-2f13-4476-88d3-d2eec26057f3", "menuSelections": [], "price": { "amount": 0, "currency": "SAR" }, "quantity": 1, "type": "Item" }, ], { "price": { "amountexternalReferenceId": 300"141139", // original price of combo "currencyid": "SAR141139", }, "menuSelections": [], "quantity": 1, "typeprice": "Combo"{ } ]"amount": 0, "price": { "amountcurrency": 0, // final price of the reward"SAR" "currency": "SAR" }, }, "quantity": 1, "type": "RewardItem" } } ] }, |
Offer with a combo
| Code Block |
|---|
"cart": { "menuSelections": [ {], "externalReferenceId": "8351", // offer plu "idprice": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //offer sanity id{ "menuSelections": [ "amount": 300, // original price of {combo "externalReferenceIdcurrency": "8167SAR", // combo plu }, "id": "d90a7113-0620-44d9-b678-743330a2f207", //combo sanity id "quantity": 1, "menuSelections": [ "type": "Combo" { } ], "externalReferenceId": "80003", "price": { "idamount": "ce847c79-9eb5-4be3-8a1e-842919aa5ba0"0, // final price of the reward "currency": "SAR" "menuSelections": [], }, "pricequantity": {1, "type": "Reward" "amount": 0,} ] }, |
Reward with a combo + premium modifier
| Code Block |
|---|
{ "payload": { "currencynumber": "SAR5848", "fees": [ }, { "quantitytotal": 1, { "typeamount": "Item"19, }, "currency": "EUR" }, { "type": "BAG_FEE" } ], "serviceMode": "DELIVERY", "channel": "WHITELABEL_DELIVERY", "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", "cart": { "menuSelections": [ { "externalReferenceId": "948351", "quantity": 1, "menuSelections": [ { "externalReferenceId": "502617", "quantity": 1, "menuSelections": [ { "externalReferenceId": "502633", "quantity": 1, "menuSelections": [ { "externalReferenceId": "528232", "quantity": 1, "price": { "amount": 90, "currency": "EUR" }, "id": "8ba0df7b35df", "type": "ItemOptionModifier" } ], "price": { "amount": 0, "currency": "EUR" }, "id": "item_11107", "type": "Item" }, { "externalReferenceId": "942258", "quantity": 1, "price": { "amount": 0, "currency": "EUR" }, "id": "item_11126", "type": "Item" }, { "externalReferenceId": "527646", "quantity": 1, "price": { "amount": 0, "currency": "EUR" }, "id": "9aac0a46-5a73-431d-937c-8848ca01ac86", "type": "Item" } ], "price": { "amount": 875, "currency": "EUR" }, "id": "a2e73fd9-5f3d-4afc-9585-43ebd7bbc6dc", "type": "Combo" } ], "price": { "amount": 450, "currency": "EUR" }, "id": "024f9096-e3ee-45fc-8f76-d75e272ff9e9", "type": "Reward" } ] } } } |
Reward with a cart discount
| Code Block |
|---|
"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 |
Reward with a product discount
| Code Block |
|---|
{
"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"
}
]
}
}
} |
Offers Structure
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 a combo
| Code Block |
|---|
"cart": { "menuSelections": [ { "externalReferenceId": "8351", // offer plu "id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //offer sanity id "menuSelections": [ { "externalReferenceId": "8167", // combo plu "id": "d90a7113-0620-44d9-b678-743330a2f207", //combo sanity id "menuSelections": [ { "externalReferenceId": "80003", "id": "ce847c79-9eb5-4be3-8a1e-842919aa5ba0", "menuSelections": [], "price": { "amount": 0, "currency": "SAR" }, "quantity": 1, "type": "Item" }, { "externalReferenceId": "142538", "id": "142538", "menuSelections": [], "price": { "amount": 0, "currency": "SAR" }, "quantity": 1, "type": "Item" } ], "price": { "amount": 500, //price of the combo "currency": "SAR" }, ], "price": { "amount": 100, // final price of the offer "currency": "SAR" }, "quantity": 1, "type": "Offer" } ] }, |
Offer with a cart discount
| Code Block |
|---|
{ "externalReferenceId"payload": { "number": "1425385814", "fees": [ { "id": "142538", "total": { "menuSelectionsamount": []19, "currency": "EUR" "price": { }, "amounttype": 0, "BAG_FEE" } ], "currencyserviceMode": "SARDELIVERY", "channel": "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", "orderDiscounts": [ "quantity": 1, { "type": "Itempercentage", "value": 20 } } ], "storeId": "12349", "pricecart": { "menuSelections": [ "amount": 500, //price of the combo { "currencyexternalReferenceId": "SAR502633", }, "quantity": 1, ], "price": { "price": { "amount": 100645, // final price of the offer "currency": "SAR"EUR" }, "quantityid": 1,"item_11107", "type": "OfferItem" } ] }, |
Offer with a picker
| Code Block |
|---|
"cart": { "menuSelections":} [ } { } |
Offer with a product discount
| Code Block |
|---|
{ "externalReferenceIdpayload": "8351", // offer plu{ "id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //offer sanity idnumber": "5821", "menuSelectionsfees": [ { "externalReferenceIdtotal": "8168", //combo plu { "idamount": "3318d2c2-99d3-40f9-92d2-1798d9c5e987"19, //combo sanity id "menuSelectionscurrency": ["EUR" { }, "externalReferenceIdtype": "20001BAG_FEE", } "id": "item_61936"], "serviceMode": "DELIVERY", "menuSelectionschannel": []"WHITELABEL_DELIVERY", "callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/ed50be10-cf7c-4b1c-8bb1-0c2625cbf3be/price/callback", "priceid": {"ed50be10-cf7c-4b1c-8bb1-0c2625cbf3be", "orderDiscounts": [ { "amount": 0, "plu": "502617", "currencytype": "SARpercentage", "value": 20 }, } ], "quantitystoreId": 1"12349", "cart": { "typemenuSelections": "Item"[ { }, { "externalReferenceId": "502617", "externalReferenceIdquantity": "80002", 1, "idmenuSelections": "865a632f-e2f7-4e2b-8fcc-9281aa3f5868", [ { "menuSelections": [], "priceexternalReferenceId": {"502633", "amountquantity": 01, "currencyprice": "SAR" { "amount": }0, "quantity": 1, "currency": "EUR" "type": "Item" }, }, "id": "item_11107", { "externalReferenceIdtype": "80008Item", "id": "04462c22-bf58-4eee-842a-213e3d17a072",}, { "menuSelections": [], "priceexternalReferenceId": {"942258", "amountquantity": 01, "currencyprice": "SAR"{ "amount": }0, "quantity": 1, "currency": "EUR" "type": "Item" }, }, "id": "item_11126", { "externalReferenceIdtype": "142538Item", "id": "142538",}, { "menuSelections": [], "priceexternalReferenceId": {"527646", "amountquantity": 01, "currencyprice": "SAR"{ }, "amount": 0, "quantity": 1, "currency": "EUR" "type": "Item" }, } ], "id": "9aac0a46-5a73-431d-937c-8848ca01ac86", "price": { "amounttype": 500, //price of the combo"Item" } "currency": "SAR" }], ], "price": { "price": { "amount": 100875, // final price of the offer "currency": "SAR"EUR" }, "quantityid": 1"a2e73fd9-5f3d-4afc-9585-43ebd7bbc6dc", "type": "Offer" } ] }, } } } |