Click or drag to resize
CouponCodeCollection Class
Represents the collection of coupon codes.
Inheritance Hierarchy
SystemObject
  CMS.EcommerceCouponCodeCollection

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 12.0.0
Syntax
C#
[SerializableAttribute]
public sealed class CouponCodeCollection : ICouponCodeCollection, 
	IReadOnlyCouponCodeCollection, ICouponCodeApplication

The CouponCodeCollection type exposes the following members.

Constructors
  NameDescription
Public methodCouponCodeCollection
Top
Properties
  NameDescription
Public propertyAllAppliedCodes
Gets all applied coupon codes.
Public propertyCartAppliedCodes
Gets coupon codes that are already applied in cart.
Public propertyCodes
Gets the coupon codes.
Public propertyCouponCodes
Gets the coupon codes.
Public propertyNotAppliedInCartCodes
Gets coupon codes, that are in cart, but not applied.
Public propertyOrderAppliedCodes
Gets all applied coupon codes that are already applied in order.
Top
Methods
  NameDescription
Public methodAdd
Adds coupon with given couponCode and status to the collection.
Public methodApply
Applies all applicable coupon codes during order creation.
Public methodStatic memberDeserialize
Returns a new instance of CouponCodeCollection deserialized from given string.
Public methodIsAppliedInCart
Returns true when given codes is present and was applied in cart.
Public methodIsAppliedInOrder
Returns true when given codes is present and was applied in order.
Public methodIsNotAppliedInCart
Returns true when given codes is present in cart, but it is not applied.
Public methodMerge
Merge existing coupon codes with given ones.
Public methodRemove
Removes the coupon with given couponCode from collection. Does nothing when no such coupon exists.
Public methodSerialize
Serializes the collection into string.
Top
See Also