Class Coupon

Hierarchy

  • Coupon

Implements

Constructors

constructor

Properties

above_invoice_amount? alias? applying_plus applying_user_groups applying_user_tags auto_gen below_invoice_amount? can_redeem can_sell description? description_alias? discount_amount? discount_calc_type discount_percent? duration expired_at? guid is_delivery_free is_individual_use is_multi_stores name price_in_points? promo_code styles usage_count usage_limit_per_invoice

Constructors

constructor

Properties

Optional above_invoice_amount

above_invoice_amount?: number

Only above a specified invoice total before this coupon can be redeemed

Optional alias

alias?: string

Coupon alias

applying_plus

applying_plus: IApplying<string>

Applying PLUs (Price Lookup Code)

applying_user_groups

applying_user_groups: IApplying<number>

Applying User Groups

applying_user_tags

applying_user_tags: IApplying<string>

Applying User Tags

auto_gen

auto_gen: boolean = false

If auto generation is true, the coupon will be automatically generated for all applicable users

Optional below_invoice_amount

below_invoice_amount?: number

Only below a specified invoice total before this coupon can be redeemed

can_redeem

can_redeem: boolean = true

If this coupon has been disabled for redemption

can_sell

can_sell: boolean = true

If this coupon has been disabled for purchasing

Optional description

description?: string

Coupon primary description

Optional description_alias

description_alias?: string

Coupon alias description

Optional discount_amount

discount_amount?: number

Flat discount amount

discount_calc_type

discount_calc_type: CalcType = CalcType.Flat

Discount Calculation Type

Optional discount_percent

discount_percent?: number

Percent discount (e.g. 30% => 0.3)

duration

duration: number = 30

Expiring duration in day after coupon is purchased

Optional expired_at

expired_at?: Date

When this coupon will be expired

guid

guid: string = ""

Coupon guid

is_delivery_free

is_delivery_free: boolean = false

Can this coupon be used to offset delivery fee

is_individual_use

is_individual_use: boolean = true

If this coupon can only be used individually without stacking other coupons together

is_multi_stores

is_multi_stores: boolean = false

If this coupon can be used for multiple stores

name

name: string = ""

Coupon primary name

Optional price_in_points

price_in_points?: number

The amount of points to redeem this coupon

promo_code

promo_code: string = ""

Promotion code which is used to look up the coupon

styles

styles: Record<string, string> = {}

Styles of the coupon

usage_count

usage_count: number = 0

How many of this coupon has been redeemed

usage_limit_per_invoice

usage_limit_per_invoice: number = 1

How many of this coupon can be redeemed within an invoice

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc