Update a coupon

put

https://sandbox.xola.com/api/coupons/{id}

Updates the specified coupon.

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

Path Params

string

required

ID of the coupon.

Body Params

name

string

required

Name of the coupon campaign.

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.

limit

int32

Limits the number of times the coupon can be used.

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