Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Unified Promotions

Output representation of the promotion details.

JSON example

1{
2   "additionalFieldValues":{
3      "attributes":{
4         "isUnifiedPromotion__c":"true"
5      }
6   },
7   "description":"Buy 2 Get 1 free",
8   "displayName":"Sample Promotion",
9   "endDateTime":"2023-12-30T00:00:00.000Z",
10   "id":"0c8SB0000000rCPYAY",
11   "loyaltyProgram":{
12      "id":"0lpSB00000001If",
13      "name":"Program-001"
14   },
15   "name":"Free Beverage",
16   "objective":"To increase sales",
17   "priorityNumber":1,
18   "promotionEligibility":{
19      "eligibleChannels":[
20         {
21            "channelType":"Offline",
22            "retailLocationGroup":{
23               "id":"0Y2SB000000004r",
24               "name":"test"
25            },
26            "store":{
27               "id":"0YQSB000000006T",
28               "name":"test Store"
29            }
30         }
31      ],
32      "eligibleCustomerEvents":{
33         "event":"MemberBirthday",
34         "eventPeriodUnit":"Date"
35      },
36      "eligibleEnrollmentPeriod":{
37         "enrollmentEndDate":"2023-12-30T00:00:00.000Z",
38         "enrollmentStartDate":"2023-06-30T00:00:00.000Z",
39         "isEnrollmentRequired":true
40      },
41      "eligibleLoyaltyTiers":[
42         {
43            "tier":{
44               "id":"0lgSB00000000srYAA",
45               "name":"Silver"
46            },
47            "tierGroup":{
48               "id":"0ltSB00000000T3YAI",
49               "name":"Group-001"
50            }
51         }
52      ],
53      "eligibleProductCategories":[
54         {
55            "id":"0ZGSB0000002td7",
56            "name":"Beverages"
57         }
58      ],
59      "eligibleProducts":[
60         {
61            "id":"01tSB0000008Lth",
62            "name":"Coke"
63         }
64      ]
65   },
66   "promotionLimits":{
67      "liabilityLimit":10000,
68      "loyaltyProgramCurrency":{
69         "id":"NQP",
70         "name":"0lcSB00000001Tx"
71      },
72      "perCartLimit":5,
73      "perLineItemLimit":10,
74      "pointsPerCustomerLimit":5,
75      "usePerCustomerLimit":5,
76      "vouchersLimit":100,
77      "vouchersPerCustomerLimit":5
78   },
79   "startDateTime":"2023-06-30T00:00:00.000Z"
80}

Property Name	Type	Description	Filter Group and Version	Available Version
`additionalFieldValues`	Additional Attributes Output	Additional details of the promotion.	Small, 60.0	60.0
`businessUnit`	Name And Id Output []	ID or name of the Marketing Cloud business unit associated with the promotion.	Small, 60.0	60.0
`currencyIsoCode`	String	ISO code of the active currency associated with the promotion.	Small, 60.0	60.0
`description`	String	Description of the promotion.	Small, 60.0	60.0
`displayName`	String	Display name of the promotion.	Small, 60.0	60.0
`endDateTime`	String	Date and time until which the promotion can be applied for customers.	Small, 60.0	60.0
`id`	String	ID of the promotion.	Small, 60.0	60.0
`isAutomatic`	Boolean	Indicates whether the promotion is automatically applied for eligible carts (`true`) or not (`false`).	Small, 63.0	63.0
`isEmailActivated`	Boolean	Indicates whether the promotion's email has been activated (`true`) or not (`false`).	Small, 60.0	Small, 60.0
`loyaltyProgram`	String	Loyalty program associated with the promotion.	Small, 60.0	60.0
`name`	String	Unique name of the promotion.	Small, 60.0	60.0
`objective`	String	Objective of the promotion.	Small, 60.0	60.0
`priorityNumber`	Integer	Number that determines the priority of the promotion in a list of eligible promotions.	Small, 60.0	60.0
`promotionCode`	String	Promotion code of the promotion.	Small, 60.0	60.0
`promotionEligibility`	Promotion Eligibility Output	Eligibility criteria of the promotion.	Small, 60.0	60.0
`promotionLimits`	Promotion Limit Output	Limits for the promotion.	Small, 60.0	60.0
`ruleLibrary`	String	Rule library associated with the promotion.	Small, 62.0	62.0
`startDateTime`	String	Start date and time of the promotion	Small, 60.0	60.0
`termsAndConditions`	String	Terms and conditions which are applied to the promotion.	Small, 63.0	63.0

Loyalty Management Developer Guide

Unified Promotions