Class PromotionInformation
Information about an applied promotion.
Inheritance
Implements
Inherited Members
Namespace: EPiServer.Commerce.Marketing
Assembly: Mediachase.Commerce.dll
Version: 10.8.0Syntax
public class PromotionInformation : ICloneable
Constructors
PromotionInformation()
Declaration
public PromotionInformation()
Properties
AdditionalInformation
Gets or sets additional information. Additional information can be added before storing the promotion information.
Declaration
public string AdditionalInformation { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CouponCode
Gets or sets the coupon code used to activate the promotion.
Declaration
public string CouponCode { get; set; }
Property Value
Type | Description |
---|---|
System.String | The coupon code, or null if no coupon code was required. |
CustomerId
Gets or sets the id of the customer redeeming the promotion.
Declaration
public Guid CustomerId { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Description
Gets or sets a description of the result when the promotion was processed.
Declaration
public string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DiscountType
Gets or sets the promotion's discount type.
Declaration
public DiscountType DiscountType { get; set; }
Property Value
Type | Description |
---|---|
DiscountType |
Entries
Gets or sets the information for the entries which the promotion was applied to.
Declaration
public List<PromotionInformationEntry> Entries { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<PromotionInformationEntry> |
IsRedeemed
Gets or sets a value indicating whether to include in redemption count.
Declaration
public bool IsRedeemed { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Name
Gets or sets the name of the processed promotion.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
OrderForm
Gets or sets the order promotion information.
Declaration
public PromotionInformationOrderForm OrderForm { get; set; }
Property Value
Type | Description |
---|---|
PromotionInformationOrderForm |
OrderFormId
Gets or sets the id of the order form this promotion belongs to.
Declaration
public int OrderFormId { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
PromotionGuid
Gets or sets the guid of the applied promotion.
Declaration
public Guid PromotionGuid { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
RewardType
Gets or sets the reward type, can be percentage or amount or free.
Declaration
public RewardType RewardType { get; set; }
Property Value
Type | Description |
---|---|
RewardType |
SavedAmount
Gets the amount saved by the promotion.
Declaration
public decimal SavedAmount { get; }
Property Value
Type | Description |
---|---|
System.Decimal |
Shipments
Gets or sets the information for the shipments which the promotion was applied to.
Declaration
public List<PromotionInformationShipment> Shipments { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<PromotionInformationShipment> |
VisitorGroup
Gets or sets the visitor group used to activate the promotion.
Declaration
public Guid? VisitorGroup { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> | The visitor group ID, or |
Methods
ClearSavedAmount()
Clean up saved amount
Declaration
public void ClearSavedAmount()
Clone()
Clones the instance of the promotion information.
Declaration
public object Clone()
Returns
Type | Description |
---|---|
System.Object | Cloned PromotionInformation instance. |