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

Cart Structures

Item

Item

Item

image-20241202-131322.png
"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

3C679586-21F4-425C-89FC-837D643AED4E_4_5005_c-20241202-135022.jpeg
{ "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

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

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

Offer Discount

Amount cart discount

Note: the cart discount can be also sent with a plu inside the orderDiscounts object. Please refer to “Amount product discount” or “Percentage product discount” for an example.

Percentage cart discount

 

Note: the cart discount can be also sent with a plu inside the orderDiscounts object. Please refer to “Amount product discount” or “Percentage product discount” for an example.

Amount Product Discount

Percentage Product Discount

 

Reward

Reward

Item

Example 1:

Item with modifier

Combo

Combo with item with modifier

 

Reward Discount

Reward Discount

Amount cart discount

Percentage cart discount

 

Amount Product Discount

Percentage Product Discount