Requirements for Offer and Reward setup.
Contents
Reward payload structures
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
"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
"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 cart discount
Reward with a product discount
Offer Payload 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
"cart": {
"menuSelections": [
{
"externalReferenceId": "8351", // offer plu
"id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //offer sanity id
"menuSelections": [
{
"externalReferenceId": "8167", // combo plu
"id": "d90a7113-0620-44d9-b678-743330a2f207", //combo sanity id
"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, //price of the combo
"currency": "SAR"
},
],
"price": {
"amount": 100, // final price of the offer
"currency": "SAR"
},
"quantity": 1,
"type": "Offer"
}
]
},
Offer with a picker
"cart": {
"menuSelections": [
{
"externalReferenceId": "8351", // offer plu
"id": "43b4cf07-79c9-4aff-98d1-bce9cf2d890f", //offer sanity id
"menuSelections": [
{
"externalReferenceId": "8168", //combo plu
"id": "3318d2c2-99d3-40f9-92d2-1798d9c5e987", //combo sanity id
"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": 500, //price of the combo
"currency": "SAR"
},
],
"price": {
"amount": 100, // final price of the offer
"currency": "SAR"
},
"quantity": 1,
"type": "Offer"
}
]
},
Offer with a cart discount
Offer with a product discount
Reference
NMS guides on how to set up offers and rewards in Sanity for Oracle: /wiki/spaces/MS/pages/4057661622