Interface SaleDiscount

Hierarchy

  • SaleDiscount

Properties

description discount excludedProductTags? itemProperties? maxOrderCount? name requiredProductTags? requiresMembership? saleCode storeDomainId? timeConstraints utmConstraints?

Properties

description

description: string

Internal description of discount

discount

discount: number

Integer percentage discount

Optional excludedProductTags

excludedProductTags?: string[]

Excluded product tags, if any. 'never-sale' and 'never-discount' will automatically be included.

Optional itemProperties

itemProperties?: Properties

Item properties to set on items that are discounted.

Optional maxOrderCount

maxOrderCount?: null | number

Maximum number of orders this discount can be applied to

name

name: string

Name is potentially customer-facing!

Optional requiredProductTags

requiredProductTags?: string[]

Required product tags, if any

Optional requiresMembership

requiresMembership?: boolean

Whether this discount requires membership

saleCode

saleCode: string

Code displayed as discount reason

Optional storeDomainId

storeDomainId?: null | number

Domain ID of store this discount applies to. Leave blank or null to enable discount in all stores.

timeConstraints

timeConstraints: {
    end: Date;
    start: Date;
}

Time constraints of sale. Please consider your time zone when setting these.

Type declaration

  • end: Date
  • start: Date

Optional utmConstraints

utmConstraints?: UtmParams

UTM constraints, if any

Settings

Member Visibility

Theme

Generated using TypeDoc