Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.81 KB

EffectEntity.md

File metadata and controls

24 lines (17 loc) · 1.81 KB

EffectEntity

Definition of all properties that are present on all effects, independent of their type.

Properties

Name Type Description Notes
campaignId Integer The ID of the campaign that triggered this effect.
rulesetId Integer The ID of the ruleset that was active in the campaign when this effect was triggered.
ruleIndex Integer The position of the rule that triggered this effect within the ruleset.
ruleName String The name of the rule that triggered this effect.
effectType String The type of effect that was triggered. See API effects.
triggeredByCoupon Integer The ID of the coupon that was being evaluated when this effect was triggered. [optional]
triggeredForCatalogItem Integer The ID of the catalog item that was being evaluated when this effect was triggered. [optional]
conditionIndex Integer The index of the condition that was triggered. [optional]
evaluationGroupID Integer The ID of the evaluation group. For more information, see Managing campaign evaluation. [optional]
evaluationGroupMode String The evaluation mode of the evaluation group. For more information, see Managing campaign evaluation. [optional]
campaignRevisionId Integer The revision ID of the campaign that was used when triggering the effect. [optional]
campaignRevisionVersionId Integer The revision version ID of the campaign that was used when triggering the effect. [optional]