Loyalty Management Developer Guide

Loyalty Management Standard Objects
Loyalty Management Fields on Standard Objects
Coupon Objects in Loyalty Management
Loyalty Management Associated Objects
Apex Reference
Loyalty Management Business APIs
REST Reference
Resources
Request Bodies
Cart Input
Cart Input Map
Channel Input
Clone Promotion Input
Club Member Enrollment Input
Club Membership Renewal Input
Corporate Member Enrollment Input
Coupon Usage Input
Eligible Clubs Input
Eligible Coupon Input
Eligible Enrollment Period Input
Eligible Loyalty Tiers Input
Events Detail Input
Individual Member Enrollment Input
Loyalty Engine Input
Loyalty Engine Input Map
Loyalty Engine Run Settings Input
Loyalty Account Input
Loyalty Contact Input
Loyalty Process Input
Loyalty Process Input Options
Loyalty Process Parameter Map Input
Loyalty View Transaction Journal History Input
Name and ID Input
Product Details
Promotion Eligible Channel Input
Promotion Eligibility Input
Promotion Input
Promotion Limit Input
Promotion Recommendation Input
Redeem Voucher Input
Related Promotion Records Input
Unified Promotions Input
Unified Promotion Template Input
Promotion Reward Application Input
Response Bodies
Loyalty Management Connect API Interchangeable Request Fields
Loyalty Management Standard Invocable Actions
Loyalty Management Custom Invocable Actions
Loyalty Management Metadata API Types
Loyalty Management Tooling API Objects
Loyalty Management Mobile SDK
Gamification Mobile SDK
Data Processing Engine, Batch Management, and Monitor Workflow Services
StandardValueSet Names and Standard Picklist Fields for Loyalty Management
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Unified Promotion Template Input

Input representation of the unified promotion template.
JSON example for POST and PUT
1{
2  "rules": [
3    {
4      "templateName": "BuyXToGetRewards",
5      "ruleName": "123",
6      "priority": 1,
7      "eventConfiguration": [
8        {
9          "allOf": [
10            {
11              "anyOf": {
12                "purchaseType": "Product",
13                "applicablePurchaseList": [
14                  {
15                    "name": "Veg Burger"
16                  }
17                ],
18                "purchaseCriteria": {
19                  "type": "Quantity",
20                  "value": 1
21                }
22              }
23            }
24          ]
25        }
26      ],
27      "rewardConfiguration": [
28        {
29          "type": "ProvideDiscount",
30          "rewardDetails": {
31            "discountValue": "100",
32            "discountType": "PercentageOff"
33          },
34          "targetAudience": {
35            "audienceType": "LoyaltyTierMembers",
36            "audienceDetails": {
37              "tierGroup": {
38                "name": "Default"
39              },
40              "tier": {
41                "name": "Silver"
42              }
43            }
44          }
45        },
46        {
47          "type": "IssueVoucher",
48          "rewardDetails": {
49            "voucherDefinition": {
50              "name": "GET 10% OFF"
51            },
52            "voucherExpirationDate": "2020-10-10"
53          },
54          "targetAudience": {
55            "audienceType": "AllLoyaltyMembers"
56          }
57        }
58      ]
59    }
60  ]
61}
Properties
Name Type Description Required or Optional Available Version
event​Configuration Map<String, Object>[] List of criteria that decides when customers are eligible for the rewards of the promotion rule. 60.0
journalSubType String ID of the journal sub type. 60.0
journalSub​TypeName String Name of the journal sub type. 64.0
journalType String Name of the journal sub type. 60.0
priority Integer Priority number of the rule in the promotion. 60.0
promotionLimit Integer Milestone limit of the promotion. 63.0
reward​Configuration Map<String, Object>[] List of rewards that members get when their activity meets the rule's eligibility criteria. 60.0
ruleName String Name of the promotion rule. 60.0
templateName String Name of the promotion template that's used in a promotion rule. 60.0