Class: module:models/CouponItem

module:models/CouponItem(code)

new module:models/CouponItem(code)

Constructs a new CouponItem. Document representing a coupon item.

Parameters:
Name Type Description
code String

The coupon code.

Source:

Members

(readonly) StatusCodeEnum :String

Allowed values for the status_code property.

Type:
  • String
Source:

(inner, constant) adhoc

value: "adhoc"

Source:

(inner, constant) applied

value: "applied"

Source:

(inner) code :String

The coupon code.

Type:
  • String
Source:

(inner, constant) coupon_already_in_basket

value: "coupon_already_in_basket"

Source:

(inner, constant) coupon_code_already_in_basket

value: "coupon_code_already_in_basket"

Source:

(inner, constant) coupon_code_already_redeemed

value: "coupon_code_already_redeemed"

Source:

(inner, constant) coupon_code_unknown

value: "coupon_code_unknown"

Source:

(inner, constant) coupon_disabled

value: "coupon_disabled"

Source:

(inner) coupon_item_id :String

The coupon item id.

Type:
  • String
Source:

(inner, constant) customer_redemption_limit_exceeded

value: "customer_redemption_limit_exceeded"

Source:

(inner, constant) no_active_promotion

value: "no_active_promotion"

Source:

(inner, constant) no_applicable_promotion

value: "no_applicable_promotion"

Source:

(inner, constant) redemption_limit_exceeded

value: "redemption_limit_exceeded"

Source:

(inner) status_code :module:models/CouponItem.StatusCodeEnum

The status of the coupon item.

Type:
  • module:models/CouponItem.StatusCodeEnum
Source:

(inner, constant) timeframe_redemption_limit_exceeded

value: "timeframe_redemption_limit_exceeded"

Source:

(inner) valid :Boolean

A flag indicating whether the coupon item is valid. A coupon line item is valid if the status code is 'applied' or 'no_applicable_promotion'.

Type:
  • Boolean
Source:

Methods

(static) constructFromObject(data, obj) → {module:models/CouponItem}

Constructs a CouponItem from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:models/CouponItem

Optional instance to populate.

Source:
Returns:

The populated CouponItem instance.

Type
module:models/CouponItem