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 Rule

Output representation of the details of a promotion rule.
Property Name Type Description Filter Group and Version Available Version
apiName String The API name of the promotion rule. Small, 61.0 61.0
description String The description of the promotion rule. Small, 61.0 61.0
hasNo​Qualification​Criteria Boolean Indicates whether the promotion rule can be applied without any qualification criteria (true) or not (false). Small, 65.0 65.0
isEligibility​Rule Boolean Indicates whether the rule is the promotion eligibility rule (true) or not (false). Small, 61.0 61.0
isRuleFor​AllEligible​Categories Boolean Indicates whether the rule applies to all eligible categories associated with the promotion (true) or not (false). Small, 65.0 65.0
isRuleFor​AllEligible​Products Boolean Indicates whether the rule applies to all eligible products associated with the promotion (true) or not (false). Small, 65.0 65.0
name String The name of the promotion rule. A promotion consists of two types of rules. The eligibility rule decides which products, categories, stores, store groups, and customers are eligible for the promotion. The template rules decide which customer activities are eligible for the promotion and the rewards available for each eligible customer activity. Small, 61.0 61.0
ruleActionList Rule Action[] The list of actions that belong to the rule. Small, 61.0 61.0
ruleFilter​CriteriaList Rule Filter Criteria[] The list of filter criteria that belong to the rule. Small, 61.0 61.0
rule​ParameterList Rule Parameter[] The list of parameters that belong to the rule. Small, 61.0 61.0
sequenceNumber Integer The sequence number of the rule in the promotion rules list. Small, 61.0 61.0