Promotion Details (GET, PUT)

Retrieve the details of a promotion. Update a promotion record.

To update an existing promotion, you must first deactivate the promotion in the org.

Note

Resource

1/global-promotions-management/promotions/PROMOTION_ID

Resource Example

1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/global-promotions-management/promotions/PROMOTION_ID

Available Version

60.0

HTTP Methods

GET, PUT

Request Body for PUT

Root XML Tag

unifiedPromotionsInputRepresentation

JSON Example for POST and PUT

1{
2  "promotionDetails": {
3    "name": "Sample Promotion 6",
4    "displayName": "Sample Promotion",
5    "priorityNumber": 1,
6    "description": "Sample promotion description",
7    "promotionCode": "XYZ",
8    "startDateTime": "2023-06-30T00:00:00.000Z",
9    "endDateTime": "2023-12-30T00:00:00.000Z",
10    "objective": "To increase sales",
11    "isAutomatic": true,
12    "loyaltyProgram": {
13      "name": "NTO"
14    },
15    "additionalFieldValues": {
16      "attributes": {
17        "isUnifiedPromotion__c": true
18      }
19    },
20    "promotionEligibility": {
21      "productCatalog": {
22        "id": "0ZSxx000000001dGAA"
23      },
24      "eligibleProductCategories": [
25        {
26          "id": "0ZGxx0000000001GAA"
27        }
28      ],
29      "eligibleProducts": [
30        {
31          "name": "someProduct"
32        }
33      ],
34      "eligibleChannels": [
35        {
36          "channelType": "***",
37          "channel": {
38            "id": "***",
39            "name": "***"
40          },
41          "store": {
42            "id": "***",
43            "name": "***"
44          },
45          "retailLocationGroup": {
46            "name": "***"
47          }
48        }
49      ],
50      "eligibleCampaign": {
51        "name": "***"
52      },
53      "eligibleSegments": [
54        {
55          "name": "someSegment"
56        }
57      ],
58      "eligibleCustomerEvents": {
59        "event": "MemberBirthday",
60        "eventPeriodUnit": ""
61      },
62      "eligibleEnrollmentPeriod": {
63        "isEnrollmentRequired": true,
64        "enrollmentStartDate": "",
65        "enrollmentEndDate": ""
66      },
67      "eligibleLoyaltyPartnerProducts": [
68        {
69          "name": "",
70          "id": ""
71        }
72      ],
73      "eligibleLoyaltyTiers": [
74        {
75          "tierGroup": {
76            "name": "",
77            "id": ""
78          },
79          "tier": {
80            "name": "",
81            "id": ""
82          }
83        }
84      ],
85      "eligibleCoupons": [
86        {
87          "couponCode": "",
88          "status": "",
89          "description": "",
90          "startDateTime": "",
91          "endDateTime": "",
92          "redemptionLimitOverall": "",
93          "redemptionLimitPerCustomer": ""
94        }
95      ]
96    },
97    "promotionLimits": {
98      "perLineItemLimit": 10,
99      "pointsPerCustomerLimit": 5,
100      "vouchersPerCustomerLimit": 5,
101      "perCartLimit": 5,
102      "usePerCustomerLimit": 5,
103      "totalUseLimit": 25,
104      "pointsLimit": 1000,
105      "vouchersLimit": 100,
106      "liabilityLimit": 10000,
107      "loyaltyProgramCurrency": {
108        "id": "0lcxx0000000001AAA"
109      }
110    }
111  }
112}

Properties

Name	Type	Description	Required or Optional	Available Version
`additionalFieldValues`	Map<String, String>	Custom, and additional field values that provide more details about the promotion.	Optional	60.0
`businessUnit`	Name And Id Input []	ID or name of the Marketing Cloud business unit associated with the promotion. To specify a business unit, you must have the Marketing Cloud license.	Optional	60.0
`currencyIsoCode`	String	ISO code of the active currency associated with the promotion. Before specifying the currency ISO code, make sure that your org supports multiple currencies.	Optional	60.0
`description`	String	Description of the promotion.	Optional	60.0
`displayName`	String	Display name of the promotion.	Optional	60.0
`endDateTime`	String	Date and time until which the promotion can be applied for customers.	Optional	60.0
`isAutomatic`	Boolean	Indicates whether the promotion is automatically applied for eligible carts (true) or not (false).	Optional	63.0
`isEmailActivated`	Boolean	Indicates whether the promotion’s email is activated (`true`) or not (`false`). If set to true, an email template is created for the promotion’s email in the org. The default value is `false`.	Optional	Small, 60.0
`loyaltyProgram`	Name And Id Input []	ID or name of the active loyalty program the promotion applies to. You can’t change the loyalty program of an existing promotion.	Optional	60.0
`name`	String	Unique name of the promotion.	Required	60.0
`objective`	String	Objective of the promotion.	Optional	60.0
`priorityNumber`	Integer	Number that determines the priority of the promotion in a list of eligible promotions. Priority number must be greater than zero.	Optional	60.0
`promotionCode`	String	Unique code of the promotion.	Optional	60.0
`promotionEligibility`	Promotion Eligibility Input	Eligibility criteria of the promotion.	Optional	60.0
`promotionLimits`	Promotion Limit Input	Limits of the promotion, including the number of times the promotion can be applied for customers. A promotion limit must be greater than zero.	Optional	60.0
`ruleLibrary`	String	Rule library associated with the promotion.	Optional	62.0
`startDateTime`	String	Date and time from which the promotion can be applied for customers.	Required	60.0
`termsAndConditions`	String	Terms and conditions which are applied to the promotion.	Optional	63.0