Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 2.77 KB

EffectSet.md

File metadata and controls

39 lines (28 loc) · 2.77 KB

EffectSet

The set effect and its properties. See API effects.

Properties

Name Type Description Notes
experimentId Long The ID of the experiment that campaign belongs to. [optional]
campaignId Long The ID of the campaign that triggered this effect.
rulesetId Long The ID of the ruleset that was active in the campaign when this effect was triggered.
ruleIndex Long The position of the rule that triggered this effect within the ruleset.
ruleName String The name of the rule that triggered this effect.
effectType EffectTypeEnum An effect discriminator of type `set`.
triggeredByCoupon Long The ID of the coupon that was being evaluated when this effect was triggered. [optional]
triggeredForCatalogItem Long The ID of the catalog item that was being evaluated when this effect was triggered. [optional]
conditionIndex Long The index of the condition that was triggered. [optional]
evaluationGroupID Long 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 Long The revision ID of the campaign that was used when triggering the effect. [optional]
campaignRevisionVersionId Long The revision version ID of the campaign that was used when triggering the effect. [optional]
selectedPriceType String The selected price type for the SKU targeted by this effect. [optional]
selectedPrice BigDecimal The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. [optional]
adjustmentReferenceId UUID The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. [optional]
rewardId Long The ID of the reward that was being evaluated when this effect was triggered. [optional]
rewardIntegrationId String The integration ID of the specific customer reward whose usage produced this effect. [optional]
props UpdateAttributeEffectProps

Enum: EffectTypeEnum

Name Value
SET "set"