Contents

Table of Contents

minLevel	1
maxLevel	6
outline	false
style	none

Info
Please read the Orders API - Overview document first to understand how these endpoints are meant to be used.

Calculate basket price

Price order webhook documented here
See details about offer and reward payload format inside the cart object in the Payload Format section below
Price webhook callback documented here

Place order

Fire order webhook documented here
Fire webhook callback documented here
Commit order webhook documented here
Commit webhook callback documented here
Order event webhook documented here

Payload format

Info
This section explains changes to the format of the `cart` object used to make a request to `Price Order Webhook`. It will be moved to the Partner API Reference Documentation soon.

Reward with an item

...

type	list
printable	true

Payload format

Info
This section explains changes to the format of the `cart` object used to make a request to `Price Order Webhook`. It will be moved to the Partner API Reference Documentation soon.

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": [
      {
        "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 a combo

Code Block

"cart": {
  "menuSelections": [
    {
      "externalReferenceId": "8351", // reward plu
      "id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //reward sanity id
        "menuSelections": [
            {
                "externalReferenceId": "8350", // combo plu
                "id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //combo sanity id
                "menuSelections": [
                    {
                        "externalReferenceId": "10059",
                        "id": "item_1852",
                        "menuSelections": [],
                        "price": {
                            "amount": 0,
                            "currency": "SAR"
                        },
                        "quantity": 1,
                        "type": "Item"
                    },
                    {
                        "externalReferenceId": "80007",
                        "id": "4f99db1e-128a-4e53-b23b-dffc0fedf636",
                        "menuSelections": [],
                        "price": {
                            "amount": 0,
                            "currency": "SAR"
                        },
                        "quantity": 1,
                        "type": "Item"
                    },
                    {
                        "externalReferenceId": "80001",
                        "id": "16f482db-2f13-4476-88d3-d2eec26057f3",
                        "menuSelections": [],
                        "price": {
                            "amount": 0,
                            "currency": "SAR"
                        },
                        "quantity": 1,
                        "type": "Item"
                    },
                    {
                        "externalReferenceId": "141139",
                        "id": "141139",
                        "menuSelections": [],
                        "price": {
                            "amount": 0,
                            "currency": "SAR"
                        },
                        "quantity": 1,
                        "type": "Item"
                    }
                ],
                "price": {
                "amount": 300, // original price of combo
                "currency": "SAR"
                 },
                 "quantity": 1,
                 "type": "Combo"
                 }
              ],
              "price": {
              "amount": 0, // final price of the reward
              "currency": "SAR"
              },
              "quantity": 1,
              "type": "Reward"
            }
        ]
    },

Reward with a combo + premium modifier

Code Block

{
    "payload": {
        "number": "5848",
        "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/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 `plu` inside the `orderDiscounts` object. Please refer to “Reward with a product discount” section for an example.

Reward with a product discount

Code Block

{
    "payload": {
        "number": "5807",
        "fees": [
            {
                "total": {
                    "amount": 19,
                    "idcurrency": "7ee7338a-a016-47c6-aef6-3783d40c003e", // Reward Sanity idEUR"
               "externalReferenceId": "123" },
//  Reward constant plu defined in Sanity         "quantitytype": 1, "BAG_FEE"
            }
     "price": {  ],
        "amountserviceMode": 0"DELIVERY",

         "currencychannel": "SARWHITELABEL_DELIVERY",
        }"callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/781f28e9-d6bb-4c8e-9ea6-e65a2e7c3764/price/callback",
        "typeid": "reward781f28e9-d6bb-4c8e-9ea6-e65a2e7c3764", // OfferCombo
        "menuSelectionsorderDiscounts": [
            {
                "externalReferenceIdplu": "51056948348",
// item constant plu             "idtype": "item_1862percentage",
// item Sanity id             "menuSelectionsvalue": [],50
            "price":}
{        ],
        "amountstoreId": 2495"12349",
//   normal price    "cart": {
            "currencymenuSelections": "SAR"[
          },      {
      "quantity": 1,             "typeexternalReferenceId": "Item948348",
          }         ]       }"quantity": 1,
    ]   }
]

Reward with a combo

Code Block

"cart": {             "menuSelections": [
                {        {
        "externalReferenceId": "8350",                    "idexternalReferenceId": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f502633",
                "menuSelections": [            "quantity": 1,
           {                 "price": {
      "externalReferenceId": "10059",                         "idamount": "item_1852",0,
                                "menuSelectionscurrency": [],"EUR"
                           "price": { },
                            "amountid": 0"item_11107",
                            "currencytype": "SARItem"
                        },
                        "quantity": 1,
  ],
                     "typeprice": "Item"{
                     },   "amount": 645,
                {        "currency": "EUR"
               "externalReferenceId": "80007",    },
                    "id": "4f99db1efbdead97-128a5acb-4e534d1c-b23ba5fe-dffc0fedf6365794ece61aaa",
   
                    "menuSelectionstype": [],
         "Reward"
               "price": {}
            ]
        }
      "amount": 0,
    }
}

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
       "currencyid": "SAR"
  43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //offer sanity id
        "menuSelections": [
           },
        {
                "quantityexternalReferenceId": 1"8167", // combo plu
                     "typeid": "Item"
  d90a7113-0620-44d9-b678-743330a2f207", //combo sanity id
                 },"menuSelections": [
                    {
                        "externalReferenceId": "8000180003",
                        "id": "16f482dbce847c79-2f139eb5-44764be3-88d38a1e-d2eec26057f3842919aa5ba0",
                        "menuSelections": [],
                        "price": {
                            "amount": 0,
                            "currency": "SAR"
                        },
                        "quantity": 1,
                        "type": "Item"
                    },
                    {
                        "externalReferenceId": "141139142538",
                        "id": "141139142538",
                        "menuSelections": [],
                        "price": {
                            "amount": 0,
                            "currency": "SAR"
                        },
                        "quantity": 1,
                        "type": "Item"
                    }
                ],
                "price": {
                    "amount": 0,
          
         "currency": "SAR"             "price": {
   },                 "quantityamount": 1,500, //price of the combo
                    "typecurrency": "rewardSAR"
             }   },
     ]     },

Offer with a combo

Code Block

"cart": {     ],
   "menuSelections": [            "price": {
                "externalReferenceIdamount": "8167",
100, // final price of the offer
                "idcurrency": "d90a7113-0620-44d9-b678-743330a2f207",SAR"
                },
    "menuSelections": [           "quantity": 1,
        {        "type": "Offer"
            }
  "externalReferenceId": "80003",     ]
    },

Offer with a cart discount

Code Block

{
    "payload": {
        "idnumber": "ce847c79-9eb5-4be3-8a1e-842919aa5ba05814",
        "fees": [
            {
    "menuSelections": [],           "total": {
            "price": {       "amount": 19,
                    "amountcurrency": 0,"EUR"
                },
                "currencytype": "SARBAG_FEE"
            }
        ],
  },      "serviceMode": "DELIVERY",
        "channel": "WHITELABEL_DELIVERY",
        "quantitycallbackUrl": 1,
        "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/6d66a02e-810f-478f-bf0d-b69bfcb56d51/price/callback",
               "type"id": "Item"6d66a02e-810f-478f-bf0d-b69bfcb56d51",
                    },
       "orderDiscounts": [
            {
                        "externalReferenceId"type": "142538percentage",
                "value": 20
      "id": "142538",     }
         ],
         "menuSelectionsstoreId": []"12349",
        "cart":  {
             "pricemenuSelections": {[
                {
            "amount": 0,       "externalReferenceId": "502633",
                    "currencyquantity": "SAR"1,
                    "price": {
  },                         "quantityamount": 1645,
                        "typecurrency": "ItemEUR"
                    },
                  ],  "id": "item_11107",
                    "pricetype": { "Item"
                }
         "amount": 500,
   ]
        }
    }
}

Offer with a product discount

Code Block
{ "currencypayload": "SAR"{ "number": "5821", }, "fees": [ { "quantity": 1, "typetotal": "offer" { } ] },

Offer with a picker

Code Block

"cart"amount": {19,
        "menuSelections": [           "currency": "EUR"
{                 "externalReferenceId": "8168" },
                "idtype": "3318d2c2-99d3-40f9-92d2-1798d9c5e987",BAG_FEE"
            }
   "menuSelections": [    ],
        "serviceMode": "DELIVERY",
      {  "channel": "WHITELABEL_DELIVERY",
           "callbackUrl": "https://euw3-staging-bk-partners-api.rbictg.com/api/v1/orders/ed50be10-cf7c-4b1c-8bb1-0c2625cbf3be/price/callback",
         "externalReferenceIdid": "20001ed50be10-cf7c-4b1c-8bb1-0c2625cbf3be",
        "orderDiscounts": [
              "id": "item_61936",{
                        "menuSelections"plu": [],
       "502617",
                "pricetype": {
           "percentage",
                "amountvalue": 0,
           20
            }
   "currency": "SAR"    ],
        "storeId": "12349",
        "cart": {
},            "menuSelections": [
           "quantity": 1,    {
                    "typeexternalReferenceId": "Item502617",
                    "quantity": }1,
                    "menuSelections": [
  {                      {
  "externalReferenceId": "80002",                         "idexternalReferenceId": "865a632f-e2f7-4e2b-8fcc-9281aa3f5868502633",
                            "menuSelectionsquantity": [], 1,
                            "price": {
                                "amount": 0,
                                "currency": "SAREUR"
                            },
                            "quantityid": 1,"item_11107",
                            "type": "Item"
                    },     },
               {                   {
     "externalReferenceId": "80008",                         "idexternalReferenceId": "04462c22-bf58-4eee-842a-213e3d17a072942258",
                            "menuSelectionsquantity": []1,
                            "price": {: {
                                "amount": 0,
                                "currency": "SAREUR"
                            },
                            "quantityid": 1,"item_11126",
                            "type": "Item"

                   },     },
               {                     {
   "externalReferenceId": "142538",                         "idexternalReferenceId": "142538527646",
                            "menuSelectionsquantity": [],1,
                            "price": {
                                "amount": 0,
                                "currency": "SAREUR"
                          },  },
                            "quantityid": 1,"9aac0a46-5a73-431d-937c-8848ca01ac86",
                            "type": "Item"
                        }
                    ],
                    "price": {
                        "amount": 1000875,
                        "currency": "SAREUR"
                    },
                    "quantityid": 1,"a2e73fd9-5f3d-4afc-9585-43ebd7bbc6dc",
                    "type": "offerOffer"
                }
            ]
    },    }
    }
}

Versions Compared

Old Version 3

New Version Current

Key

Calculate basket price

Place order

Payload format

Reward with an item

Payload format

Rewards Structure

Reward with an item

Reward with an item + premium modifier

Reward with a combo

Reward with a combo + premium modifier

Reward with a cart discount

Reward with a product discount

Reward with a combo

Offers Structure

Offer with a combo

Offer with a combo

Offer with a cart discount

Offer with a product discount

Offer with a picker

Page Comparison

Versions Compared

Old Version 3

New Version Current

Key

Calculate basket price

Place order

Payload format

Reward with an item

Payload format

Rewards Structure

Reward with an item

Reward with an item + premium modifier

Reward with a combo

Reward with a combo + premium modifier

Reward with a cart discount

Reward with a product discount

Reward with a combo

Offers Structure

Offer with a combo

Offer with a combo

Offer with a cart discount

Offer with a product discount

Offer with a picker