Creating Campaigns via API - Types & Offers
Overview
This documentation will cover the unique attributes to create campaigns using the Create Campaign API (here). Calling this API will allow you to quickly build a campaign, especially helpful when creating multiple campaigns at once.
Type & offerType
There are many objects that are required in the Create Campaign API, but two objects in particular that will determine what campaign is created: type and offerType.
typerefers to the high-level campaign category defining the qualification and rewardofferTypedefines the qualification and reward for the campaign
Points Campaigns
| Campaign Features | type | offerType |
|---|---|---|
| Points Fixed - Basket Qualification | POINTS_FIXED | FIXED_POINTS_BASKET |
| Points Fixed - Product Qualification | POINTS_FIXED | FIXED_POINTS_PRODUCTS |
| Basket Points Multiplier - Basket Qualification | BASKET_POINTS_MULTIPLIER | VARIABLE_POINTS_BASKET |
| Basket Points Multiplier - Product Qualification | BASKET_POINTS_MULTIPLIER | VARIABLE_POINTS_PRODUCTS |
| Product Points Multiplier | PRODUCT_POINTS_MULTIPLIER | VARIABLE_POINTS_PRODUCTS |
| Basket Spend Points Variable | BASKET_SPEND_POINTS_VARIABLE | VARIABLE_POINTS_BASKET |
| Product Spend Points Variable | PRODUCT_SPEND_POINTS_VARIABLE | VARIABLE_POINTS_PRODUCTS |
| Tiered Spend for Points - Basket Qualification | TIERED_SPEND_FOR_POINTS | VARIABLE_POINTS_BASKET |
| Tiered Spend for Points - Product Qualification | TIERED_SPEND_FOR_POINTS | VARIABLE_POINTS_PRODUCTS |
| Continuity - All | CONTINUITY | CONTINUITY |
| Product Units Points Variable | PRODUCT_UNITS_POINTS_VARIABLE | VARIABLE_POINTS_PRODUCTS |
| Quest | QUEST | QUEST_FIXED_POINTS |
type and offer container per Points Campaign
The examples below show the minimum body params required within the offer container. Additional rules can be included, such as location restrictions, identityType and tenders. Refer to the API Reference here for a complete list of body params.
Points Fixed
Each tab below represents the desired features based on the qualification within this campaign type.
//Get 500 points when you spend 75.00 or more on your basket.
"type": "POINTS_FIXED",
"offer": {
"offerType": "FIXED_POINTS_BASKET",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
},
"banner2": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"basket": {
"minimumBasketSpend": 7500,
"minimumUnits": null
}
},
"reward": {
"standard": {
"points": {
"schemeId": "{{schemeId}}",
"creditAmount": 500
}
}
}
}//Get 250 points when you spend 5.00 or more on bananas.
"type": "POINTS_FIXED",
"offer": {
"offerType": "FIXED_POINTS_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
},
"banner2": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": null,
"tags": null,
"items": [
"245874",
"245878"
],
"skus": null
},
"excluded": null
},
"minimumProductSpend": 500,
"minimumUnits": 1
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": null,
"tags": null,
"items": [
"245874",
"245878"
],
"skus": null
},
"excluded": null
},
"minimumProductSpend": 500,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"standard": {
"points": {
"schemeId": "{{schemeId}}",
"creditAmount": 250
}
}
}
}Basket Points Multiplier
Each tab below represents the desired features based on the qualification within this campaign type.
//Get 10x points on your basket spend when you purchase 5.00 or more.
"type": "BASKET_POINTS_MULTIPLIER",
"offer": {
"offerType": "VARIABLE_POINTS_BASKET",
"qualification": {
"locations": {
"purplebanner1007": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": null,
"basket": {
"minimumBasketSpend": 500,
"minimumUnits": null
}
},
"reward": {
"standard": {
"points": {
"schemeId": "101217384",
"multiplierValue": 10,
"creditAmount": null
}
}
}
}//Get 10x points when you spend 2.00 or more on one or more canned soup products.
"type": "BASKET_POINTS_MULTIPLIER",
"offer": {
"offerType": "VARIABLE_POINTS_BASKET",
"qualification": {
"locations": {
"banner1": {},
"banner2": {}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"included": {
"items": [
"245865",
"245869"
]
}
},
"minimumProductSpend": 200,
"minimumUnits": 1
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"included": {
"items": [
"245865",
"245867"
]
}
},
"minimumProductSpend": 200,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"standard": {
"points": {
"schemeId": "{{schemeId}}",
"creditAmount": null,
"multiplierValue": 10
}
}
}
}Product Points Multiplier
//Get 15x points when you spend at least 0.01 on 1 one or more canned vegetable products.
"type": "PRODUCT_POINTS_MULTIPLIER",
"offer": {
"offerType": "VARIABLE_POINTS_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {},
"excluded": {}
},
"banner2": {
"included": {},
"excluded": {}
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245874",
"245877"
]
}
},
"minimumProductSpend": 1,
"minimumUnits": 1
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245876",
"245877",
"245878"
]
}
},
"minimumProductSpend": 1,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245874",
"245877"
]
}
},
"points": {
"standard": {
"schemeId": "{{schemeId}}",
"multiplierValue": 15,
"creditAmount": null
}
}
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245876",
"245877",
"245878"
]
}
},
"points": {
"standard": {
"schemeId": "{{schemeId}}",
"multiplierValue": 15,
"creditAmount": null
}
}
}
]
}
}
}
}Basket Spend Points Variable
//Starting at 50.00, for every 10.00 you spend up to 200.00, get 100 points.
"type": "BASKET_SPEND_POINTS_VARIABLE",
"offer": {
"offerType": "VARIABLE_POINTS_BASKET",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null
}
},
"banner2": {
"included": {
"locationIdentifiers": null
}
}
},
"basket": {
"minimumBasketSpend": 5000
}
},
"reward": {
"basket": {
"points": {
"interval": {
"decider": "TOTAL",
"step": 1000,
"creditAmount": 100,
"floor": 5000,
"ceiling": 20000,
"schemeId": "{{schemeId}}"
}
}
}
}
}Product Spend Points Variable
//For every 1.00 spent on banana bread, starting at 1.00, up to 10.00, get 10 points.
"type": "PRODUCT_SPEND_POINTS_VARIABLE",
"offer": {
"offerType": "VARIABLE_POINTS_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
},
"banner2": {
"included": null,
"excluded": null
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245887"
]
}
},
"minimumProductSpend": 1,
"minimumUnits": 1
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245886"
]
}
},
"minimumProductSpend": 1,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245887"
]
}
},
"points": {
"interval": {
"decider": "SPEND",
"step": 100,
"creditAmount": 10,
"floor": 100,
"ceiling": 1000,
"schemeId": "100128379"
}
}
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245886"
]
}
},
"points": {
"interval": {
"decider": "SPEND",
"step": 100,
"creditAmount": 10,
"floor": 100,
"ceiling": 1000,
"schemeId": "{{schemeId}}"
}
}
}
]
}
}
}
}Tiered Spend for Points
Each tab below represents the desired features based on the qualification within this campaign type.
//For your 50.00+ basket spend get extra points. Earn 1,000 points with a 50.00-74.99 basket spend; 1,500 points with a 75.00-99.99 basket spend; 2,500 points with a 100.00-149.99 basket spend or 3,000 points when you spend 150.00-999.99.
"type": "TIERED_SPEND_FOR_POINTS",
"offer": {
"offerType": "VARIABLE_POINTS_BASKET",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": {
"banner1": [
"outlet1",
"outlet2"
]
}
},
"excluded": null
},
"banner2": {
"included": {
"locationIdentifiers": {
"banner2": [
"outlet6"
]
}
},
"excluded": null
}
},
"product": null,
"basket": {
"minimumBasketSpend": 5000
}
},
"reward": {
"basket": {
"value": {
"points": {
"tier": {
"values": [
{
"floor": 0,
"ceiling": 0,
"creditAmount": 0,
"schemeId": "{{schemeId}}",
"multiplier": 0,
"bonus": 0
}
],
"decider": "SPEND"
}
}
},
"points": {
"tier": {
"values": [
{
"floor": 5000,
"ceiling": 7499,
"creditAmount": 1000,
"schemeId": "{{schemeId}}"
},
{
"floor": 7500,
"ceiling": 9999,
"creditAmount": 1500,
"schemeId": "{{schemeId}}"
},
{
"floor": 10000,
"ceiling": 14999,
"creditAmount": 2500,
"schemeId": "{{schemeId}}"
},
{
"floor": 15000,
"ceiling": 99999,
"creditAmount": 3000,
"schemeId": "{{schemeId}}"
}
],
"decider": "TOTAL"
}
}
}
}
}//Earn 50 points when you spend 2.00-4.99 on hand sanitiser; 100 points for spending 5.00-9.99 or 200 points when you buy 10.00-999.99 worth of hand sanitiser.
"type": "TIERED_SPEND_FOR_POINTS",
"offer": {
"offerType": "VARIABLE_POINTS_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
},
"banner2": {
"included": null,
"excluded": null
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245885"
]
},
"excluded": null
},
"minimumProductSpend": 1,
"minimumUnits": 1
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245885"
]
},
"excluded": null
},
"minimumProductSpend": 1,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245885"
]
},
"excluded": null
},
"value": null,
"points": {
"tier": {
"values": [
{
"floor": 200,
"ceiling": 499,
"creditAmount": 50,
"schemeId": "{{schemeId}}",
"multiplier": 0
},
{
"floor": 500,
"ceiling": 999,
"creditAmount": 100,
"schemeId": "{{schemeId}}",
"multiplier": 0
},
{
"floor": 1000,
"ceiling": 99999,
"creditAmount": 200,
"schemeId": "{{schemeId}}",
"multiplier": 0
}
],
"decider": "SPEND"
}
}
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245885"
]
},
"excluded": null
},
"value": null,
"points": {
"tier": {
"values": [
{
"floor": 200,
"ceiling": 499,
"creditAmount": 50,
"schemeId": "{{schemeId}}",
"multiplier": 0
},
{
"floor": 500,
"ceiling": 999,
"creditAmount": 100,
"schemeId": "{{schemeId}}",
"multiplier": 0
},
{
"floor": 1000,
"ceiling": 99999,
"creditAmount": 200,
"schemeId": "{{schemeId}}",
"multiplier": 0
}
],
"decider": "SPEND"
}
}
}
]
}
}
}
}Continuity
Each tab below represents the desired features based on the qualification within this campaign type.
//This example will require five transactions, where each individual transaction requires a minimum basket spend of 25.00 or more. The customer will be rewarded with 500 points.
"type": "CONTINUITY",
"offer": {
"offerType": "CONTINUITY",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
}
},
"basket": {
"minimumBasketSpend": 2500
}
},
"reward": {
"standard": {
"points": {
"schemeId": "{{schemeId}}
",
"creditAmount": 500,
"multiplierValue": null
}
}
},
"continuity": {
"qualification": {
"totalTransactionCount": 5,
"totalTransactionSpend": null,
"totalTransactionUnits": null
}
}
}//This example will require three transactions, where each individual transaction requires a minimum spend of 50.00 or more on CLOTHING department products.
"type": "CONTINUITY",
"offer": {
"offerType": "CONTINUITY",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": {
"CLOTHING": [
"10"
]
}
},
"excluded": null
},
"minimumProductSpend": 5000,
"minimumUnits": 1
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": {
"CLOTHING": [
"10"
]
}
},
"excluded": null
},
"minimumProductSpend": 5000,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"standard": {
"points": {
"schemeId": "{{schemeId}}",
"creditAmount": 2500,
"multiplierValue": null
}
}
},
"continuity": {
"qualification": {
"totalTransactionCount": 3,
"totalTransactionSpend": null,
"totalTransactionUnits": null
}
}
}//Spend 30.00 or more over 1+ transaction where the basket spend is 0.01 or more, and get 400 points.
"type": "CONTINUITY",
"offer": {
"offerType": "CONTINUITY",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
}
},
"basket": {
"minimumBasketSpend": 1
}
},
"reward": {
"standard": {
"points": {
"schemeId": "{{schemeId}",
"creditAmount": 400,
"multiplierValue": null
}
}
},
"continuity": {
"qualification": {
"totalTransactionCount": null,
"totalTransactionSpend": 3000,
"totalTransactionUnits": null
}
}
}//Spend 30.00 or more over 1+ transaction where the product spend is 5.00 or more on a single transaction, and get 750 points.
"type": "CONTINUITY",
"offer": {
"offerType": "CONTINUITY",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245894",
"245895",
"245905"
]
},
"excluded": null
},
"minimumProductSpend": 500,
"minimumUnits": 1
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245894",
"245895",
"245905"
]
},
"excluded": null
},
"minimumProductSpend": 500,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"standard": {
"points": {
"schemeId": "{{schemeId}}",
"creditAmount": 750,
"multiplierValue": null
}
}
},
"continuity": {
"qualification": {
"totalTransactionCount": null,
"totalTransactionSpend": 3000,
"totalTransactionUnits": null
}
}
}//Buy 100 products and get 1,000 points. Qualifying transactions must have a basket spend of 25.00 or more to count towards the 100 units.
"type": "CONTINUITY",
"offer": {
"offerType": "CONTINUITY",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
},
"banner2": {
"included": null,
"excluded": null
}
},
"basket": {
"minimumBasketSpend": 2500
}
},
"reward": {
"standard": {
"points": {
"schemeId": "{{schemeId}}",
"creditAmount": 1000,
"multiplierValue": null
}
}
},
"continuity": {
"qualification": {
"totalTransactionCount": null,
"totalTransactionSpend": null,
"totalTransactionUnits": 100
}
}
}//In this campaign, get 1,000 points after you buy 10 units of dog food in 1+ transactions. Each indiviudal transaction requires 0.01 to be spent with at least 1 product purchased.
"type": "CONTINUITY",
"offer": {
"offerType": "CONTINUITY",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
},
"banner2": {
"included": null,
"excluded": null
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245891"
]
},
"excluded": null
},
"minimumProductSpend": 1,
"minimumUnits": 1
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245891"
]
},
"excluded": null
},
"minimumProductSpend": 1,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"standard": {
"points": {
"schemeId": "{{schemeId}}",
"creditAmount": 1000,
"multiplierValue": null
}
}
},
"continuity": {
"qualification": {
"totalTransactionCount": null,
"totalTransactionSpend": null,
"totalTransactionUnits": 10
}
}
}Product Units Points Variable
//This campaign rewards customer with 100 points per 2.50 spent on qualifyiung products, beginning at 5.00 and rewarding the 100 points up to 50.00.
"type": "PRODUCT_UNITS_POINTS_VARIABLE",
"offer": {
"offerType": "VARIABLE_POINTS_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
},
"banner2": {
"included": null,
"excluded": null
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245868",
"245869"
]
}
},
"minimumProductSpend": 500,
"minimumUnits": 1
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245868",
"245869"
]
}
},
"minimumProductSpend": 500,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245868",
"245869"
]
}
},
"points": {
"interval": {
"decider": "UNITS",
"step": 250,
"creditAmount": 100,
"floor": 500,
"ceiling": 5000,
"schemeId": "{{schemeId}}"
}
}
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245868",
"245869"
]
}
},
"points": {
"interval": {
"decider": "UNITS",
"step": 250,
"creditAmount": 100,
"floor": 500,
"ceiling": 5000,
"schemeId": "{{schemeId}}"
}
}
}
]
}
}
}
}Quest
//In this campaign the redemption of the three accounts for the listed campaigns will award the customer 1,000 points.
"type": "QUEST",
"offer": {
"offerType": "QUEST_FIXED_POINTS",
"qualification": {
"locations": null,
"product": null,
"basket": null,
"objectives": null
},
"reward": {
"standard": {
"points": {
"schemeId": "{{schemeId}}",
"creditAmount": 1000,
"multiplierValue": null
}
}
}
},
"relationships": {
"objective": {
"campaign": [
{
"campaignId": "100815629"
},
{
"campaignId": "100816659"
},
{
"campaignId": "100819290"
}
]
}
}
Quest also requires a relationships object as well where you can identify the accounts that need to be redeemed to qualify for the reward.
Discounts Campaigns
| Campaign Features | type | offerType |
|---|---|---|
| Discount Basket - Basket Qualification - Fixed Discount Amount Reward | DISCOUNT_BASKET | FIXED_AMOUNT_OFF_BASKET |
| Discount Basket - Basket Qualification - Percent Off Reward | DISCOUNT_BASKET | FIXED_PERCENTAGE_OFF_BASKET |
| Discount Basket - Product Qualification - Fixed Discount Amount Reward | DISCOUNT_BASKET | FIXED_AMOUNT_OFF_BASKET |
| Discount Basket - Product Qualification - Percent Off Reward | DISCOUNT_BASKET | FIXED_PERCENTAGE_OFF_BASKET |
| Discount Products - Fixed Discount Amount Reward | DISCOUNT_PRODUCTS | FIXED_AMOUNT_OFF_PRODUCTS |
| Discount Products - Fixed Price Reward | DISCOUNT_PRODUCTS | VARIABLE_AMOUNT_OFF_PRODUCTS |
| Discount Products - Free Product Reward | DISCOUNT_PRODUCTS | VARIABLE_AMOUNT_OFF_PRODUCTS |
| Discount Products - Percent Off Reward | DISCOUNT_PRODUCTS | FIXED_PERCENTAGE_OFF_PRODUCTS |
| Discount Products - Product Unit Tiers Fixed Discount Amount Reward | DISCOUNT_PRODUCTS | VARIABLE_AMOUNT_OFF_PRODUCTS |
| Discount Products - Product Unit Interval Fixed Discount Reward | DISCOUNT_PRODUCTS | VARIABLE_AMOUNT_OFF_PRODUCTS |
| Discount Products - Product Unit Interval Percent Off Discount Reward | DISCOUNT_PRODUCTS | VARIABLE_AMOUNT_OFF_PRODUCTS |
| Combo Promotion - Basket Qualification - Fixed Discount Amount Reward | COMBO_PROMOTION | FIXED_AMOUNT_OFF_PRODUCTS |
| Combo Promotion - Basket Qualification - Fixed Price Reward | COMBO_PROMOTION | FIXED_PRICE_PRODUCTS |
| Combo Promotion - Basket Qualification - Free Product Reward Reward | COMBO_PROMOTION | FREE_PRODUCTS |
| Combo Promotion - Basket Qualification - Percent Off Reward | COMBO_PROMOTION | FIXED_PERCENTAGE_OFF_PRODUCTS |
| Combo Promotion - Product Qualification - Fixed Discount Amount Reward | COMBO_PROMOTION | FIXED_AMOUNT_OFF_PRODUCTS |
| Combo Promotion - Product Qualification - Fixed Price Reward | COMBO_PROMOTION | FIXED_PRICE_PRODUCTS |
| Combo Promotion - Product Qualification - Free Product Reward | COMBO_PROMOTION | FREE_PRODUCTS |
| Combo Promotion - Product Qualification - Percent Off Reward | COMBO_PROMOTION | FIXED_PERCENTAGE_OFF_PRODUCTS |
| Meal Deal - Fixed Discount Amount Reward | MEAL_DEAL | MEAL_DEAL |
| Meal Deal - Fixed Price Reward | MEAL_DEAL | MEAL_DEAL |
type and offer container per Discounts Campaign
The examples below show the minimum body params required within the offer container. Additional rules can be included, such as location restrictions, identityType and tenders. Refer to the API Reference here for a complete list of body params.
Discount Basket
Each tab below represents the desired features based on the qualification and reward within this campaign type.
//This example rewards 10.00 off a basket spend of 75.00 or more
"type": "DISCOUNT_BASKET",
"offer": {
"offerType": "FIXED_AMOUNT_OFF_BASKET",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
}
},
"basket": {
"minimumBasketSpend": 7500
}
},
"reward": {
"standard": {
"value": {
"discountAmount": 1000,
"percentageAmount": null
}
}
}
}//Use FIXED_PERCENTAGE_OFF_BASKET to setup a campagin for a fixed % off, such as this example where the customer can get 10% off their basket spend when they spend 50.00 or more.
"type": "DISCOUNT_BASKET",
"offer": {
"offerType": "FIXED_PERCENTAGE_OFF_BASKET",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
}
},
"basket": {
"minimumBasketSpend": 5000
}
},
"reward": {
"standard": {
"value": {
"discountAmount": null,
"percentageAmount": 10
}
}
}
}//Spend 20.00 or more on health products and get a 4.00 discount on your basket
"type": "DISCOUNT_BASKET",
"offer": {
"offerType": "FIXED_AMOUNT_OFF_BASKET",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245884",
"245885"
]
},
"excluded": null
},
"minimumProductSpend": 2000,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"standard": {
"value": {
"discountAmount": 400,
"percentageAmount": null
}
}
}
}//Spend 30.00 or more on beverages and get 5% off your basket
"type": "DISCOUNT_BASKET",
"offer": {
"offerType": "FIXED_PERCENTAGE_OFF_BASKET",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245866",
"245874",
"245877",
"245878"
]
},
"excluded": null
},
"minimumProductSpend": 3000,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"standard": {
"value": {
"discountAmount": null,
"percentageAmount": 5
}
}
}
}Discount Products
Each tab below represents the desired features based on the reward within this campaign type.
//Spend 15.00 or more on dairy products and get a 2.00 discount
"type": "DISCOUNT_PRODUCTS",
"offer": {
"offerType": "FIXED_AMOUNT_OFF_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": null,
"excluded": null
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": {
"DEMO": [
"1"
]
}
},
"excluded": null
},
"minimumProductSpend": 1500,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": {
"DEMO": [
"1"
]
},
"items": null
},
"excluded": null
},
"value": {
"standard": {
"percentageAmount": null,
"allFree": false,
"discountAmount": 200,
"finalAmount": null
}
},
"minimumNumberOfUnits": 1
}
]
}
}
}
}//Spend at leaset 3.00 on a dozen eggs and get them for a fixed price of 2.25 on a maximum of one product.
"type": "DISCOUNT_PRODUCTS",
"offer": {
"offerType": "VARIABLE_AMOUNT_OFF_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245867"
]
},
"excluded": null
},
"minimumProductSpend": 300,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245867"
]
},
"excluded": null
},
"value": {
"standard": {
"percentageAmount": null,
"allFree": false,
"discountAmount": null,
"finalAmount": 225
}
},
"minimumNumberOfUnits": 1,
"maximumNumberOfUnits": 1
}
]
}
}
}
}//Get one free coffee with a minimum 0.01 purchase
"type": "DISCOUNT_PRODUCTS",
"offer": {
"offerType": "VARIABLE_AMOUNT_OFF_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245875"
]
},
"excluded": null
},
"minimumProductSpend": 1,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245875"
]
},
"excluded": null
},
"value": {
"standard": {
"percentageAmount": null,
"allFree": true,
"discountAmount": null,
"finalAmount": null
}
},
"minimumNumberOfUnits": 1,
"maximumNumberOfUnits": 1
}
]
}
}
}
}//Spend at least 50.00 on dog food and get 10% off your purchase.
"type": "DISCOUNT_PRODUCTS",
"offer": {
"offerType": "FIXED_PERCENTAGE_OFF_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245891"
]
},
"excluded": null
},
"minimumProductSpend": 5000,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245891"
]
},
"excluded": null
},
"value": {
"standard": {
"percentageAmount": 10,
"allFree": false,
"discountAmount": null,
"finalAmount": null
}
},
"minimumNumberOfUnits": 1,
"maximumNumberOfUnits": 1
}
]
}
}
}
}//Buy 1-10 items in the Toys category and get a 1.00 discount; 2.50 off 11-20 units; 3.75 off 21-30 units or 5.00 off 31-50 units purchased.
"type": "DISCOUNT_PRODUCTS",
"offer": {
"offerType": "VARIABLE_AMOUNT_OFF_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
},
"banner2": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": {
"TOYS": [
"12"
]
},
"items": null
},
"excluded": null
},
"minimumProductSpend": 1,
"minimumUnits": 1
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": {
"TOYS": [
"12"
]
},
"items": null
},
"excluded": null
},
"minimumProductSpend": 1,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": {
"TOYS": [
"12"
]
},
"items": null
},
"excluded": null
},
"value": {
"tier": {
"decider": "UNITS",
"values": [
{
"floor": 1,
"ceiling": 10,
"discountAmount": 100,
"discountPercentage": 0
},
{
"floor": 11,
"ceiling": 20,
"discountAmount": 250,
"discountPercentage": 0
},
{
"floor": 21,
"ceiling": 30,
"discountAmount": 375,
"discountPercentage": 0
},
{
"floor": 31,
"ceiling": 50,
"discountAmount": 500,
"discountPercentage": 0
}
]
}
},
"minimumNumberOfUnits": 1
}
]
},
"banner2": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": {
"TOYS": [
"12"
]
},
"items": null
},
"excluded": null
},
"value": {
"tier": {
"decider": "UNITS",
"values": [
{
"floor": 1,
"ceiling": 10,
"discountAmount": 100,
"discountPercentage": 0
},
{
"floor": 11,
"ceiling": 20,
"discountAmount": 250,
"discountPercentage": 0
},
{
"floor": 21,
"ceiling": 30,
"discountAmount": 375,
"discountPercentage": 0
},
{
"floor": 31,
"ceiling": 50,
"discountAmount": 500,
"discountPercentage": 0
}
]
}
},
"minimumNumberOfUnits": 1
}
]
}
}
}
}//This example gives a 0.50 discount for every 1.00 spent on lemonade, with a minimum spend of 5.00. The unit intervals will stop awarding the 0.50 at 9.99.
"type": "DISCOUNT_PRODUCTS",
"offer": {
"offerType": "VARIABLE_AMOUNT_OFF_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245874"
]
},
"excluded": null
},
"minimumProductSpend": 500,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245874"
]
},
"excluded": null
},
"value": {
"interval": {
"ceiling": 999,
"decider": "UNITS",
"floor": 500,
"step": 100,
"discountValue": 50,
"discountPercentage": null
}
},
"minimumNumberOfUnits": 1
}
]
}
}
}
}//For every 10.00 spent on airmiles, with a minimum of a 10.00 purchase, get 10% off up to 999.99.
"type": "DISCOUNT_PRODUCTS",
"offer": {
"offerType": "VARIABLE_AMOUNT_OFF_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245881"
]
},
"excluded": null
},
"minimumProductSpend": 1000,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245881"
]
},
"excluded": null
},
"value": {
"interval": {
"ceiling": 99999,
"decider": "UNITS",
"floor": 1000,
"step": 1000,
"discountValue": null,
"discountPercentage": 10
}
},
"points": null,
"minimumNumberOfUnits": 1
}
]
}
}
}
}Combo Promotions
Each tab below represents the desired features based on the qualification and reward within this campaign type.
//Spend 40.00 or more on your basket and get a fixed 5.00 discount on the fruit and vegatable categories.
"type": "COMBO_PROMOTION",
"offer": {
"offerType": "FIXED_AMOUNT_OFF_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": null,
"basket": {
"minimumBasketSpend": 4000
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": null,
"groups": {
"DEMO": [
"6",
"18"
]
}
},
"excluded": null
},
"value": {
"standard": {
"percentageAmount": null,
"allFree": false,
"discountAmount": 500,
"finalAmount": null
}
},
"minimumNumberOfUnits": 1
}
]
}
}
}
}//Spend 30.00 or more on your basket and get a litre of lemonade for 1.49.
"type": "COMBO_PROMOTION",
"offer": {
"offerType": "FIXED_PRICE_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": null,
"basket": {
"minimumBasketSpend": 3000,
"minimumUnits": null
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245874"
]
},
"excluded": null
},
"value": {
"interval": null,
"standard": {
"percentageAmount": null,
"allFree": false,
"discountAmount": null,
"finalAmount": 149
}
},
"maximumNumberOfUnits": 1,
"minimumNumberOfUnits": 1
}
]
}
}
}
}//Spend 300.00 on your basket and get a free t-shirt or hat.
"type": "COMBO_PROMOTION",
"offer": {
"offerType": "FREE_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": null,
"basket": {
"minimumBasketSpend": 30000
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "ANYOF",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245892"
]
},
"excluded": null
},
"value": {
"standard": {
"percentageAmount": null,
"allFree": true,
"discountAmount": null,
"finalAmount": null
}
},
"minimumNumberOfUnits": 1
},
{
"products": {
"allRequired": false,
"included": {
"items": [
"245893"
]
},
"excluded": null
},
"value": {
"standard": {
"percentageAmount": null,
"allFree": true,
"discountAmount": null,
"finalAmount": null
}
},
"minimumNumberOfUnits": 1
}
]
}
}
}
}//Spend 75.00 or more and get 15% off your purchase of a glass of beer or wine
"type": "COMBO_PROMOTION",
"offer": {
"offerType": "FIXED_PERCENTAGE_OFF_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": null,
"basket": {
"minimumBasketSpend": 7500
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245871",
"245872"
]
},
"excluded": null
},
"value": {
"standard": {
"percentageAmount": 15,
"allFree": false,
"discountAmount": null,
"finalAmount": null
}
},
"maximumNumberOfUnits": 1,
"minimumNumberOfUnits": 1
}
]
}
}
}
}//Buy peanut butter and jelly and get 2.00 your purchase of a loaf of bread in the bread category
"type": "COMBO_PROMOTION",
"offer": {
"offerType": "FIXED_AMOUNT_OFF_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"basket": null,
"product": {
"banner1": {
"logicalOperator": "AND",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245865",
"245866"
]
},
"excluded": null
},
"minimumProductSpend": 200,
"minimumUnits": 1
},
{
"products": {
"allRequired": false,
"included": {
"items": [
"245867"
]
},
"excluded": null
},
"minimumProductSpend": 300,
"minimumUnits": 1
}
]
}
}
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": {
"DEMO": [
"18"
]
},
"items": null
},
"excluded": null
},
"value": {
"standard": {
"percentageAmount": null,
"allFree": false,
"discountAmount": 200,
"finalAmount": null
}
},
"maximumNumberOfUnits": 1,
"minimumNumberOfUnits": 1
}
]
}
}
}
}//Buy a hamburger for at least 5.00 and fries for at least 2.00 and get a soda for a fixed price of 1.00.
"type": "COMBO_PROMOTION",
"offer": {
"offerType": "FIXED_PRICE_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "AND",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245869"
]
},
"excluded": null
},
"minimumProductSpend": 500,
"minimumUnits": 1
},
{
"products": {
"allRequired": false,
"included": {
"items": [
"245877"
]
},
"excluded": null
},
"minimumProductSpend": 200,
"minimumUnits": 1
}
]
}
},
"basket": null
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245873"
]
},
"excluded": null
},
"value": {
"standard": {
"percentageAmount": null,
"allFree": false,
"discountAmount": null,
"finalAmount": 100
}
},
"maximumNumberOfUnits": 1,
"minimumNumberOfUnits": 1
}
]
}
}
}
}//Spend 12.00 or more on red roses and 3.00 or more on 2+ chocolate bars and get a free greeting card.
"type": "COMBO_PROMOTION",
"offer": {
"offerType": "FREE_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "AND",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245865"
]
},
"excluded": null
},
"minimumProductSpend": 1200,
"minimumUnits": 1
},
{
"products": {
"allRequired": false,
"included": {
"items": [
"245897"
]
},
"excluded": null
},
"minimumProductSpend": 300,
"minimumUnits": 2
}
]
}
},
"basket": null
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245866"
]
},
"excluded": null
},
"value": {
"standard": {
"percentageAmount": null,
"allFree": true,
"discountAmount": null,
"finalAmount": null
}
},
"maximumNumberOfUnits": 1,
"minimumNumberOfUnits": 1
}
]
}
}
}
}//Buy a latte for 5.00 or more and a biscotti for 1.00 or more and get 50% a breakfast sandwich.
"type": "COMBO_PROMOTION",
"offer": {
"offerType": "FIXED_PERCENTAGE_OFF_PRODUCTS",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "AND",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245875"
]
},
"excluded": null
},
"minimumProductSpend": 500,
"minimumUnits": 1
},
{
"products": {
"allRequired": false,
"included": {
"items": [
"245868"
]
},
"excluded": null
},
"minimumProductSpend": 100,
"minimumUnits": 1
}
]
}
},
"basket": null
},
"reward": {
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245881"
]
},
"excluded": null
},
"value": {
"standard": {
"percentageAmount": 50,
"allFree": false,
"discountAmount": null,
"finalAmount": null
}
},
"maximumNumberOfUnits": 1,
"minimumNumberOfUnits": 1
}
]
}
}
}
}Meal Deal
Each tab below represents the desired features based on the reward within this campaign type.
//Buy a sandwich for 5.00 or more and chips for 1.00 or more, get 2.00 off
"type": "MEAL_DEAL",
"offer": {
"offerType": "MEAL_DEAL",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "AND",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245877"
]
},
"excluded": null
},
"minimumProductSpend": 100,
"minimumUnits": 1
},
{
"products": {
"allRequired": false,
"included": {
"items": [
"245885"
]
},
"excluded": null
},
"minimumProductSpend": 500,
"minimumUnits": 1
}
]
}
},
"basket": null
},
"reward": {
"product": {
"banner1": {
"logicalOperator": null,
"collections": [
{
"products": null,
"value": {
"interval": null,
"standard": {
"percentageAmount": null,
"allFree": false,
"discountAmount": 200,
"finalAmount": null
}
},
"points": null,
"maximumNumberOfUnits": null,
"minimumNumberOfUnits": null
}
]
}
}
}
}//Buy a bottle of red wine, a block of gourmet cheese and crackers for a fixed price of 35.00.
"type": "MEAL_DEAL",
"offer": {
"offerType": "MEAL_DEAL",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "AND",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245873"
]
},
"excluded": null
},
"minimumProductSpend": 1,
"minimumUnits": 1
},
{
"products": {
"allRequired": false,
"included": {
"items": [
"245865"
]
},
"excluded": null
},
"minimumProductSpend": 1,
"minimumUnits": 1
},
{
"products": {
"allRequired": false,
"included": {
"items": [
"245867"
]
},
"excluded": null
},
"minimumProductSpend": 1,
"minimumUnits": 1
}
]
}
},
"basket": null
},
"issuanceQualification": null,
"reward": {
"product": {
"banner1": {
"logicalOperator": null,
"collections": [
{
"products": null,
"value": {
"interval": null,
"standard": {
"percentageAmount": null,
"allFree": false,
"discountAmount": null,
"finalAmount": 3500
}
},
"points": null,
"maximumNumberOfUnits": null,
"minimumNumberOfUnits": null
}
]
}
}
}
}Alternative Campaigns
| Campaign Features | type | offerType |
|---|---|---|
| Bounce Back - Basket Qualification | BOUNCE_BACK | BOUNCE_BACK |
| Bounce Back - Product Qualification | BOUNCE_BACK | BOUNCE_BACK |
| Spend Rate Modifier- Basket Qualification | SPEND_RATE_MODIFIER | POINTS_SPEND_RATE |
| Spend Rate Modifier - Product Qualification | SPEND_RATE_MODIFIER | POINTS_SPEND_RATE |
| Stamp Card- Basket Qualification | CAMPAIGN_STAMP_CARD | STAMP_CARD |
| Stamp Card - Product Qualification | CAMPAIGN_STAMP_CARD | STAMP_CARD |
| Zero Reward - Basket Qualification | ZERO_REWARD | ZERO_REWARD |
| Zero Reward - Product Qualification | ZERO_REWARD | ZERO_REWARD |
| Manual | MANUAL | null |
type and offer container per Alternative Campaign
The examples below show the minimum body params required within the offer container. Additional rules can be included, such as location restrictions, identityType and tenders. Refer to the API Reference here for a complete list of body params.
Bounce Back
Each tab below represents the desired features based on the qualification within this campaign type.
//Spend 30.00 or more on your basket and get a coupon account for a free product.
"type": "BOUNCE_BACK",
"offer": {
"offerType": "BOUNCE_BACK",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"basket": {
"minimumBasketSpend": 3000
}
},
"reward": null,
"bounceBack": [
{
"resourceType": "CAMPAIGN",
"resourceId": "{{campaignId}}"
}
]
}//Spend 25.00 or more on t-shirts and get a coupon account added to your wallet for 5.00 off your next basket spend.
"type": "BOUNCE_BACK",
"offer": {
"offerType": "BOUNCE_BACK",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"items": [
"245873",
"245877"
]
},
"excluded": null
},
"minimumProductSpend": 2500,
"minimumUnits": 1
}
]
}
}
},
"reward": null,
"bounceBack": [
{
"resourceType": "CAMPAIGN",
"resourceId": "{{campaignId}}"
}
]
}Spend Rate Modifier
Each tab below represents the desired features based on the qualification within this campaign type.
//Spend 100.00 on your basket and get 2x the points up for every 5,000 points you redeem starting at 10,000 points, up to 50,000 points or 3x the points for every 5,000 points you redeem from 50,001 points to 100,000 points.
"type": "SPEND_RATE_MODIFIER",
"offer": {
"offerType": "POINTS_SPEND_RATE",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"basket": {
"minimumBasketSpend": 10000
}
},
"reward": {
"pointSpendRates": [
{
"floor": 10000,
"ceiling": 50000,
"step": 5000,
"rate": 2,
"bonus": 0,
"pointsBack": 0
},
{
"floor": 50001,
"ceiling": 100000,
"step": 5000,
"rate": 3,
"bonus": 0,
"pointsBack": 0
}
],
"standard": {
"points": {
"schemeId": "{{schemeId}}",
"creditAmount": null,
"multiplierValue": null
}
}
}
}//Buy at least two dozen eggs for 10.00 worth and redeem a minimum of 1,00 points to get a 200 bonus points redeemed for every 1,000 points redeemed, up to 10,000. Redeem 10,001 to 20,000 and get a bonus 300 points redeemed per 1,000 points redeemed.
"type": "SPEND_RATE_MODIFIER",
"offer": {
"offerType": "POINTS_SPEND_RATE",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": null,
"tags": null,
"items": [
"245865",
"245869"
],
"skus": null
},
"excluded": null
},
"minimumProductSpend": 1000,
"minimumUnits": 2,
"maximumUnits": null,
"unitMetric": null
}
]
}
}
},
"reward": {
"pointSpendRates": [
{
"floor": 1000,
"ceiling": 10000,
"step": 1000,
"rate": 0,
"bonus": 200,
"pointsBack": 0
},
{
"floor": 10001,
"ceiling": 20000,
"step": 1000,
"rate": 0,
"bonus": 300,
"pointsBack": 0
}
],
"standard": {
"points": {
"schemeId": "{{schemeId}}",
"creditAmount": null,
"multiplierValue": null
}
}
}
}Stamp Card
Each tab below represents the desired features based on the qualification within this campaign type.
//Spend 30.00 or more and get a stamp. Three Stamps will rotate through a cycle two times while the campaign is active.
"type": "CAMPAIGN_STAMP_CARD",
"offer": {
"offerType": "STAMP_CARD",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"basket": {
"minimumBasketSpend": 3000
}
},
"reward": {
"stampCard": {
"1": [
{
"resourceId": "{{campaignId}}",
"resourceType": "CAMPAIGN"
}
],
"2": [
{
"resourceId": "{{campaignId}}",
"resourceType": "CAMPAIGN"
}
],
"3": [
{
"resourceId": "{{campaignId}}",
"resourceType": "CAMPAIGN"
}
]
}
},
"stampCard": {
"configuration": {
"rotations": {
"active": true,
"value": 2
},
"steps": 3
}
}
}//Spend 25.00 or more on steak and get a stamp. Two stamps will be rewarded and only cycle through once.
"type": "CAMPAIGN_STAMP_CARD",
"offer": {
"offerType": "STAMP_CARD",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": null,
"tags": null,
"items": [
"245873",
"245877"
],
"skus": null
},
"excluded": null
},
"minimumProductSpend": 2500,
"minimumUnits": 1,
"maximumUnits": null,
"unitMetric": null
}
]
}
}
},
"reward": {
"stampCard": {
"1": [
{
"resourceId": "{{campaignId}}",
"resourceType": "CAMPAIGN"
}
],
"2": [
{
"resourceId": "{{campaignId}}",
"resourceType": "CAMPAIGN"
}
]
}
},
"stampCard": {
"configuration": {
"rotations": {
"active": false,
"value": 0
},
"steps": 2
}
}
}Zero Reward
Each tab below represents the desired features based on the qualification within this campaign type.
//Spend 50.00 on your basket to complete an objective on a Stamp Card campaign. No reward is given when the Zero Reward coupon account is redeemed.
"type": "ZERO_REWARD",
"offer": {
"offerType": "ZERO_REWARD",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"basket": {
"minimumBasketSpend": 5000
}
},
"reward": null
}//Spend on 5.00 on cereal. No reward is given.
"type": "ZERO_REWARD",
"offer": {
"offerType": "ZERO_REWARD",
"qualification": {
"locations": {
"banner1": {
"included": {
"locationIdentifiers": null,
"locationTags": null
},
"excluded": {
"locationIdentifiers": null,
"locationTags": null
}
}
},
"product": {
"banner1": {
"logicalOperator": "OR",
"collections": [
{
"products": {
"allRequired": false,
"included": {
"groups": null,
"tags": null,
"items": [
"245892"
],
"skus": null
},
"excluded": null
},
"minimumProductSpend": 500,
"minimumUnits": 1,
"maximumUnits": null,
"unitMetric": null
}
]
}
}
},
"reward": null
}Manual
//Use a POS promo code to earn 1,000 points at checkout.
"type": "MANUAL",
"offer": {
"offerType": "",
"qualification": {
"locations": null
},
"reward": {
"standard": {
"points": {
"schemeId": "{{schemeId}}",
"creditAmount": null,
"multiplierValue": null
}
}
}
}Updated about 4 hours ago
What’s Next
Where's the rest of the POST /campaigns payload? Check out this page for more details: