...
| Table of Contents | ||
|---|---|---|
|
| Info |
|---|
Please read the Orders API - Overview document first to understand how these endpoints are meant to be used. |
Calculate basket price
Price order webhookdocumented hereSee details about offer and reward payload format inside the
cartobject in the Payload Format section belowPrice webhook callbackdocumented here
Place order
Payload format
| Info |
|---|
This section explains changes to the format of the |
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": "OfferComboreward", // OfferCombo
"menuSelections": [
{
"externalReferenceId": "51056", // item constant plu
"id": "item_1862", // item Sanity id
"menuSelections": [],
"price": {
"amount": 2495, // normal price
"currency": "SAR"
},
"quantity": 1,
"type": "Item"
}
],
// item 51056 }
]
}
] |
Reward with a combo
| Code Block |
|---|
"cart": {
"menuSelections": [
{
"externalReferenceId": "8350",
"id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f",
"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": 0,
"currency": "SAR"
},
"quantity": 1,
"type": "OfferComboreward"
}
]
}, |
Offer with a combo
| Code Block |
|---|
"cart": {
"menuSelections": [
{
"externalReferenceId": "8167",
"id": "d90a7113-0620-44d9-b678-743330a2f207",
"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,
"currency": "SAR"
},
"quantity": 1,
"type": "OfferCombooffer"
}
]
}, |
Offer with a picker
| Code Block |
|---|
"cart": {
"menuSelections": [
{
"externalReferenceId": "8168",
"id": "3318d2c2-99d3-40f9-92d2-1798d9c5e987",
"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": 1000,
"currency": "SAR"
},
"quantity": 1,
"type": "OfferCombooffer"
}
]
}, |