MultiBuyDiscount Class

Class implementing multibuy discount from calculation point of view.

Inheritance Hierarchy

System.Object
  CMS.Ecommerce.MultiBuyDiscount

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 11.0.0

Syntax

[SerializableAttribute]
public sealed class MultiBuyDiscount : IMultiBuyDiscount, 
	IDiscount, ICouponCodeApplication

The MultiBuyDiscount type exposes the following members.

Constructors

	Name	Description
Public method	MultiBuyDiscount(MultiBuyDiscountInfo, Decimal, String)	Creates new instance of absolute MultiBuyDiscount based on the specified MultiBuyDiscountInfo.
Public method	MultiBuyDiscount(MultiBuyDiscountInfo, Func<Decimal, Decimal>, String)	Creates a new instance of relative MultiBuyDiscount based on the specified MultiBuyDiscountInfo.

Properties

	Name	Description
Public property	AppliedCouponCode	Applied coupon code.
Public property	ApplyFurtherDiscounts	Indicates if further discounts are to be applied if this discount applies.
Public property	ApplyOnUnitsCount	The number of discounted units.
Public property	AutoAddEnabled	Indicates if product is added to cart automatically, the system adds product to shopping cart only when the discount is percentage and set 100 % off.
Public property	BasedOnUnitsCount	The number of products needed to enable this discount.
Public property	DiscountGuid	Unique Guid identifier of the discount.
Public property	DiscountName	Multibuy discount display name.
Public property	DiscountUsesCoupons	Indicates if discount is applicable only with discount coupon.
Public property	IsFlat	True - discount value is fix, False - discount value is relative.
Public property	MaxApplication	Maximum number of possible usages of the discount. Zero or negative value is representing an unlimited application count.
Public property	Value	Discount value. Value is percentage of fix, based on value of IsFlat.

Methods

	Name	Description
Public method	AcceptsCoupon	Indicates if given coupon code is suitable for this discount. Returns false if this discount has no codes assigned.
Public method	Apply	Logs discount usage.
Public method	CalculateDiscount	Calculates the discount value for given basePrice.
Public method	GetMissingProducts	Returns IDs of SKUs which could be discounted if present in cart. Most important products go first.
Public method	IsApplicableOn	Indicates if this discount is affecting the price of given cart item, i.e. this method returns true for items discounted by this discount.
Public method	IsBasedOn	Indicates if this discount is based on given cart item, i.e. this method returns true for items needed to be in the cart to be eligible to get this discount.
Public method	PrioritizeItems	Moves Y items to higher priorities in case of BXGY discount.