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.
Promotion Details
Output representation of the details of an eligible promotion.
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| additionalPromotionFields | Map<String, Object> | Values of the promotion fields that are mapped in the context definition. | Big, 60.0 | 60.0 |
| couponDetails | Promotion Coupon Availability | Provides the details of the coupon eligible for the recommended promotion or specifies the reason why there isn’t an eligible coupon for the promotion. | Big, 60.0 | 60.0 |
| currencyIsoCode | String | Three-letter ISO 4217 code of the active monetary currency associated with the promotion. | Small, 60.0 | 60.0 |
| description | String | The description of the promotion. | Big, 60.0 | 60.0 |
| displayName | String | Name of the eligible promotion. | Small, 60.0 | 60.0 |
| endDateTime | String | End date and time of the promotion. | Big, 60.0 | 60.0 |
| enrollmentDetails | Enrollment Details[] | Details of a customer’s enrollment in a promotion. | Big, 60.0 | 60.0 |
| isAutomatic | Boolean | Indicates whether the promotion is automatically applied for eligible carts (true) or not (false). The default value is false. | Small, 63.0 | 63.0 |
| priorityNumber | Integer | Number that determines the priority of the promotion in a list of eligible
promotions. Multiple promotions can have the same priority number. |
Small, 60.0 | 60.0 |
| promotionCode | String | Code of the eligible promotion. | Small, 60.0 | 60.0 |
| promotionEligibleRules | Promotion Rules List[] | List of promotion rules that are eligible for the customer's cart. | Big, 60.0 | 60.0 |
| promotionId | String | ID of the eligible promotion. | Big, 60.0 | 60.0 |
| promotionLimits | Promotion Limit[] | List of the promotion's cart level and cart item level limits. | Big, 60.0 | 60.0 |
| startDateTime | String | Start date and time of the promotion. | Big, 60.0 | 60.0 |
| termsAndCondition | String | Terms and condition of the promotion. | Big, 60.0 | 60.0 |