Promotion Rule

Output representation of the details of a promotion rule.

Property NameTypeDescriptionFilter Group and VersionAvailable Version
apiNameStringThe API name of the promotion rule.Small, 61.061.0
descriptionStringThe description of the promotion rule.Small, 61.061.0
hasNo​Qualification​CriteriaBooleanIndicates whether the promotion rule can be applied without any qualification criteria (true) or not (false).Small, 65.065.0
isEligibility​RuleBooleanIndicates whether the rule is the promotion eligibility rule (true) or not (false).Small, 61.061.0
isRuleFor​AllEligible​CategoriesBooleanIndicates whether the rule applies to all eligible categories associated with the promotion (true) or not (false).Small, 65.065.0
isRuleFor​AllEligible​ProductsBooleanIndicates whether the rule applies to all eligible products associated with the promotion (true) or not (false).Small, 65.065.0
nameStringThe 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.061.0
ruleActionListRule Action[]The list of actions that belong to the rule.Small, 61.061.0
ruleFilter​CriteriaListRule Filter Criteria[]The list of filter criteria that belong to the rule.Small, 61.061.0
rule​ParameterListRule Parameter[]The list of parameters that belong to the rule.Small, 61.061.0
sequenceNumberIntegerThe sequence number of the rule in the promotion rules list.Small, 61.061.0