Create a coupon

post

https://sandbox.xola.com/api/coupons

Creates a new coupon object.

To perform this action, you must be the account owner, or must be delegated with ROLE_MARKETER, or ROLE_SELLER_ADMIN.

Body Params

name

string

required

Name of the coupon campaign.

type

string

required

Type of coupon. Possible values are discount, person, unlock, bxgy, voucher`.

algorithm

string

required

Algorithm used to calculate the discount. Possible values are percent, absolute.

amount

float

required

Amount of the discount.

purchaseAmount

float

Amount paid by the customer for this coupon. This may be lower than the amount in case of promotional campaigns.

codes

array of objects

required

List of unique codes that may be used to redeem this coupon.

codes*

limit

int32

Limits the number of times the coupon can be used. Setting this to null or leaving blank will make this an "unlimited use" coupon.

bookBySchedule

array of objects

Restriction which ensures that this coupon is only redeemable within the specified schedules.

bookBySchedule

arrivalSchedule

array of objects

Restriction which ensures that this coupon can only be used for orders whose arrival is within the specified schedules.

arrivalSchedule