ICouponCodeCollection Interface

Represents the collection of coupon codes.

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

Syntax

public interface ICouponCodeCollection : IReadOnlyCouponCodeCollection, 
	ICouponCodeApplication

The ICouponCodeCollection type exposes the following members.

Properties

	Name	Description
Public property	AllAppliedCodes	Gets coupon codes that are already applied in cart or order. (Inherited from IReadOnlyCouponCodeCollection.)
Public property	CartAppliedCodes	Gets coupon codes that are already applied in cart. (Inherited from IReadOnlyCouponCodeCollection.)
Public property	Codes	Gets all coupon codes. (Inherited from IReadOnlyCouponCodeCollection.)
Public property	NotAppliedInCartCodes	Gets coupon codes, that are in cart, but not applied. (Inherited from IReadOnlyCouponCodeCollection.)
Public property	OrderAppliedCodes	Gets coupon codes that are already applied in order. (Inherited from IReadOnlyCouponCodeCollection.)

Methods

	Name	Description
Public method	Add	Adds coupon with given couponCode and status to the collection.
Public method	Apply	Applies coupon code during order creation. (Inherited from ICouponCodeApplication.)
Public method	IsAppliedInCart	Returns true when given codes is present and is applied in cart.
Public method	IsAppliedInOrder	Returns true when given codes is present and was applied in order.
Public method	IsNotAppliedInCart	Returns true when given codes is present in cart, but it is not applied.
Public method	Merge	Merge existing coupon codes with given ones.
Public method	Remove	Removes the coupon with given couponCode from collection. Does nothing when no such coupon exists.
Public method	Serialize	Serializes the collection into string.