...
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"
}
]
}
}
} |
Offer Payload 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 picker
| Code Block | ||
|---|---|---|
| ||
"cart": {
"menuSelections": [
{
"externalReferenceId": "8351", // offer plu
"id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //offer sanity id
"menuSelections": [
{
"externalReferenceId": "8168", //combo plu
"id": "3318d2c2-99d3-40f9-92d2-1798d9c5e987", //combo sanity id
"menuSelections": [
{
"externalReferenceId": "20001",
"id": "item_61936",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "SAR"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "80002",
"id": "865a632f-e2f7-4e2b-8fcc-9281aa3f5868",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "SAR"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "80008",
"id": "04462c22-bf58-4eee-842a-213e3d17a072",
"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 | ||
|---|---|---|
| ||
{
"payload": {
"number": "5814",
"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/6d66a02e-810f-478f-bf0d-b69bfcb56d51/price/callback",
"id": "6d66a02e-810f-478f-bf0d-b69bfcb56d51",
"orderDiscounts": [
{
"type": "percentage",
"value": 20
}
],
"storeId": "12349",
"cart": {
"menuSelections": [
{
"externalReferenceId": "502633",
"quantity": 1,
"price": {
"amount": 645,
"currency": "EUR"
},
"id": "item_11107",
"type": "Item"
}
]
}
}
} |
...