Class PromotionEngineSettings

Instructions for how the PromotionEngine should behave.

Inheritance

System.Object

PromotionEngineSettings

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: EPiServer.Commerce.Marketing

Assembly: EPiServer.Business.Commerce.dll

Version: 12.17.2

Syntax

public class PromotionEngineSettings

Constructors

PromotionEngineSettings()

Initializes a new instance of PromotionEngineSettings

Declaration

public PromotionEngineSettings()

Remarks

Will set RequestedStatuses to Fulfilled and ApplyReward to true.

PromotionEngineSettings(RequestFulfillmentStatus, Boolean)

Initializes a new instance of PromotionEngineSettings

Declaration

public PromotionEngineSettings(RequestFulfillmentStatus requestedStatuses, bool applyReward)

Parameters

Type	Name	Description
RequestFulfillmentStatus	requestedStatuses	The fulfillment statuses to return RewardDescriptions for.
System.Boolean	applyReward	The flag indicates reward will be applied or not.

Properties

ApplyReward

Get or sets if the reward will be applied. Default is true.

Declaration

public bool ApplyReward { get; set; }

Property Value

Type	Description
System.Boolean

ExclusionLevel

Gets or sets the exclusion level that should be applied. Default is Order.

Declaration

public ExclusionLevel ExclusionLevel { get; set; }

Property Value

Type	Description
ExclusionLevel

ReevaluatePromotions

Get or sets if the the PromotionEngine should re-evaluate the promotions already applied to the IOrderGroup. Default is false.

Declaration

public bool ReevaluatePromotions { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

If set to true the PromotionEngine will create a list of promotions based on the Promotions collections of the order group's order forms and then try to apply those promotions only. All found promotions that can be loaded (i.e. have not been deleted) will be evaluated even if they are currently inactive. Running the promotion engine with this flag set to true will not increase the redemption count for the promotions.

RequestedStatuses

Gets or sets which fulfillment statuses to return RewardDescriptions for.

Declaration

public RequestFulfillmentStatus RequestedStatuses { get; set; }

Property Value

Type	Description
RequestFulfillmentStatus