Orders API - Cart Structure Examples

Contents

Cart Structures

Item

Item

Item

Screenshot 2024-08-07 at 15.22.25.png
{ "callbackUrl": "https://euw3-staging-plk-partners-api.rbictg.com/api/v1/orders/c5412daa-f7e9-455c-9bf6-e1c1bb8d16c7/price/callback", "cart": { "menuSelections": [ { "externalReferenceId": "801500", "id": "item_67165", "menuSelections": [], "price": { "amount": 649, "currency": "EUR" }, "quantity": 1, "type": "Item" } ] }, "channel": "WHITELABEL_DELIVERY", "fees": [], "id": "c5412daa-f7e9-455c-9bf6-e1c1bb8d16c7", "instructions": [], "number": "4999", "orderDiscounts": [], "serviceMode": "DELIVERY", "storeId": "1111" }

Item w/ modifiers

image-20240807-132503.png
{ "callbackUrl": "https://euw3-staging-plk-partners-api.rbictg.com/api/v1/orders/6e9d20f9-e3ae-47b4-87cd-3f9e3637f20a/price/callback", "cart": { "menuSelections": [ { "externalReferenceId": "801500", "id": "item_67165", "menuSelections": [ { "externalReferenceId": "940289", "id": "34933841d0e7", "menuSelections": [], "price": { "amount": 0, "currency": "EUR" }, "quantity": 1, "type": "ItemOptionModifier" }, { "externalReferenceId": "940294", "id": "2fb34e217cf2", "menuSelections": [], "price": { "amount": 0, "currency": "EUR" }, "quantity": 1, "type": "ItemOptionModifier" } ], "price": { "amount": 649, "currency": "EUR" }, "quantity": 1, "type": "Item" } ] }, "channel": "WHITELABEL_DELIVERY", "fees": [], "id": "6e9d20f9-e3ae-47b4-87cd-3f9e3637f20a", "instructions": [], "number": "5498", "orderDiscounts": [], "serviceMode": "DELIVERY", "storeId": "7777" }

Combo

Combo

Combo

{ "callbackUrl": "https://euw3-staging-plk-partners-api.rbictg.com/api/v1/orders/b1f2302b-723b-416f-bdc6-1e2f9659caaf/price/callback", "cart": { "menuSelections": [ { "externalReferenceId": "940269", "id": "3ffc8d3e-7c67-4410-8fbd-cd1b366fbf20", "menuSelections": [ { "externalReferenceId": "801500", "id": "item_67165", "menuSelections": [], "price": { "amount": 0, "currency": "EUR" }, "quantity": 1, "type": "Item" }, { "externalReferenceId": "942214", "id": "item_50929", "menuSelections": [], "price": { "amount": 0, "currency": "EUR" }, "quantity": 1, "type": "Item" }, { "externalReferenceId": "942215", "id": "item_66018", "menuSelections": [], "price": { "amount": 0, "currency": "EUR" }, "quantity": 1, "type": "Item" }, { "externalReferenceId": "940325", "id": "45adf5bb-2f3d-4c40-a735-cf59d5a661ef", "menuSelections": [], "price": { "amount": 0, "currency": "EUR" }, "quantity": 1, "type": "Item" } ], "price": { "amount": 849, "currency": "EUR" }, "quantity": 1, "type": "Combo" } ] }, "channel": "WHITELABEL_DELIVERY", "fees": [], "id": "b1f2302b-723b-416f-bdc6-1e2f9659caaf", "instructions": [], "number": "5495", "orderDiscounts": [], "serviceMode": "DELIVERY", "storeId": "7777" }

Combo with items with modifiers

 

 

Systemwide Offer

Systemwide Offer

Item

 

 

Currently not supported.

Combo

Combo w/ modifier

Promo Codes (Config Offers)

Promo Codes (Config Offers)

Amount discount

Percentage discount

 

 

Reward

Reward

Item

Combo

Combo with item with modifier

 

 

Difference between Combo Offer and Combo

Combo Offer

Sanity:

Combo

Sanity:

  • A. Supreme Chicken Sandwich Meal (Combo)

    • vendorConfigs > partner > 3001020

    • id > 8adbaec9-48ee-48f9-b733-04cba561c629

    • mainItem > 0ba8ec59-9f2b-4011-a5cb-9974a9c0f26f

      • vendorConfigs > partner > 3001019