Orders API - Cart Structure Examples
This page contains examples of all possible cart structures that are sent in the price webhook and get order endpoint.
Contents
- 1 Cart Structures
- 1.1 Item
- 1.1.1 Item
- 1.1.2 Item with modifiers
- 1.2 Combo
- 1.2.1 Combo
- 1.2.2 Combo with items with modifiers
- 1.3 Offer
- 1.3.1 Item
- 1.3.2 Combo
- 1.3.3 Bundle (combo with 3 burger items)
- 1.4 Offer Discount
- 1.4.1 Amount cart discount
- 1.4.2 Percentage cart discount
- 1.4.3 Amount Product Discount
- 1.4.4 Percentage Product Discount
- 1.5 Reward
- 1.5.1 Item
- 1.5.2 Item with modifier
- 1.5.3 Combo
- 1.5.4 Combo with item with modifier
- 1.6 Reward Discount
- 1.6.1 Amount cart discount
- 1.6.2 Percentage cart discount
- 1.6.3 Amount Product Discount
- 1.6.4 Percentage Product Discount
- 1.1 Item
Cart Structures
Item | |
---|---|
Item |
"callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/8ba76472-c1c7-4585-bfe8-be35dc884ff8/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "946417", // Item PLU
"id": "item_68399",
"menuSelections": [],
"price": {
"amount": 675,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
}
]
},
"channel": "WHITELABEL_DELIVERY",
"fees": [
{
"total": {
"amount": 19,
"currency": "EUR"
},
"type": "BAG_FEE"
}
],
"id": "8ba76472-c1c7-4585-bfe8-be35dc884ff8",
"instructions": [],
"number": "2647",
"orderDiscounts": [],
"serviceMode": "DELIVERY",
"storeId": "1111"
|
Item with modifiers | {
"callbackUrl":"https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/73bcecac-671e-4960-89ef-867c74be2554/price/callback",
"cart":{
"menuSelections":[
{
"externalReferenceId":"521289", // Item PLU
"id":"item_18638",
"menuSelections":[
{
"externalReferenceId":"503370", // Modifier PLU
"id":"db3447ccd50b",
"menuSelections":[
],
"price":{
"amount":0,
"currency":"EUR"
},
"quantity":1,
"type":"ItemOptionModifier"
},
{
"externalReferenceId":"503378",
"id":"5a5eadaff04a",
"menuSelections":[
],
"price":{
"amount":0,
"currency":"EUR"
},
"quantity":1,
"type":"ItemOptionModifier"
}
],
"price":{
"amount":625,
"currency":"EUR"
},
"quantity":1,
"type":"Item"
}
]
},
"channel":"WHITELABEL_DELIVERY",
"fees":[
{
"total":{
"amount":19,
"currency":"EUR"
},
"type":"BAG_FEE"
}
],
"id":"73bcecac-671e-4960-89ef-867c74be2554",
"instructions":[
],
"number":"2645",
"orderDiscounts":[
],
"serviceMode":"DELIVERY",
"storeId":"1111"
} |
Combo | |
---|---|
Combo | "callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/0f4c860b-e7dc-4d92-b66b-fd478d6e7c1e/price/callback",
"cart": {
"menuSelections": [
{
"externalReferenceId": "946420", // Combo PLU
"id": "a2a04696-8554-4902-b25f-2ea3185ec62f",
"menuSelections": [
{
"externalReferenceId": "946417", // Main item PLU (CBK)
"id": "item_68399",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "942258", // Fries PLU
"id": "item_11126",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
},
{
"externalReferenceId": "527646", // Drinks PLU
"id": "9aac0a46-5a73-431d-937c-8848ca01ac86",
"menuSelections": [],
"price": {
"amount": 0,
"currency": "EUR"
},
"quantity": 1,
"type": "Item"
}
],
"price": {
"amount": 875,
"currency": "EUR"
},
"quantity": 1,
"type": "Combo"
}
]
},
"channel": "WHITELABEL_DELIVERY",
"fees": [
{
"total": {
"amount": 19,
"currency": "EUR"
},
"type": "BAG_FEE"
}
],
"id": "0f4c860b-e7dc-4d92-b66b-fd478d6e7c1e",
"instructions": [],
"number": "2650",
"orderDiscounts": [],
"serviceMode": "DELIVERY",
"storeId": "1111" |
Combo with items with modifiers |
Offer | |
---|---|
Item | |
Combo | |
Bundle (combo with 3 burger items)An example of this type of bundle offer are markets that would like to sell an 3 for 2 offer where they sell 3 burgers for the price of 2. |
Offer Discount | |
---|---|
Amount cart discount
| Note: the cart discount can be also sent with a |
Percentage cart discount
| Note: the cart discount can be also sent with a |
Amount Product Discount | |
Percentage Product Discount |
Reward | |
---|---|
Item
| Example 1: |
Item with modifier | |
Combo
| |
Combo with item with modifier
|
Reward Discount | |
---|---|
Amount cart discount
| |
Percentage cart discount
| |
Amount Product Discount | |
Percentage Product Discount |