WrPromotion
webround-docs / WrPromotion
Interface: WrPromotion
Defined in: wr.d.ts:876
A discount promotion or coupon code
Properties
active
active:
boolean
Defined in: wr.d.ts:881
Whether the promotion is currently active
code
code:
string
Defined in: wr.d.ts:885
The coupon code string
createdAt
createdAt:
string
Defined in: wr.d.ts:907
description
description:
string
Defined in: wr.d.ts:879
discountType
discountType:
string
Defined in: wr.d.ts:889
Discount calculation type
discountValue
discountValue: {
base:number; } |Record<string,number>
Defined in: wr.d.ts:891
Discount value — percentage { base } or fixed amount per currency
endsAt
endsAt:
string
Defined in: wr.d.ts:906
When the promotion ends (ISO 8601)
exclusive
exclusive:
boolean
Defined in: wr.d.ts:901
Whether this promotion cannot be combined with others
id
id:
string
Defined in: wr.d.ts:877
limitUsageCustomer
limitUsageCustomer:
boolean
Defined in: wr.d.ts:893
limitUsageGlobal
limitUsageGlobal:
boolean
Defined in: wr.d.ts:892
maxUsesGlobal
maxUsesGlobal:
number
Defined in: wr.d.ts:895
Maximum total uses across all customers
maxUsesPerCustomer
maxUsesPerCustomer:
number
Defined in: wr.d.ts:897
Maximum uses per customer
minOrderAmount
minOrderAmount:
Record<string,number>
Defined in: wr.d.ts:899
Minimum order amount per currency to qualify
name
name:
string
Defined in: wr.d.ts:878
position
position:
number
Defined in: wr.d.ts:887
Display order
reserved
reserved:
boolean
Defined in: wr.d.ts:902
startsAt
startsAt:
string
Defined in: wr.d.ts:904
When the promotion starts (ISO 8601)
target
target:
string
Defined in: wr.d.ts:883
What the promotion applies to
updatedAt
updatedAt:
string
Defined in: wr.d.ts:908