[R] 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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Note: This feature utilizes the triggers and rewards syntax.

Body Params

seller

object

required

The seller that this coupon applies to

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 (in dollars or percent depending on the algorithm chosen)

codes

array of objects

required

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

codes*

experiences

object

required

purchaseAmount

float

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

paymentMethod

string

Reported payment method when this voucher is used. Applicable and required for voucher types.

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

tags

excludeTaxFee

boolean

Defaults to false

Whether to exclude taxes and fees when applying the coupon.

maxDemographics

int32

The number of demographics that the coupon may be applied to (applicable for voucher coupons)

triggers

array of objects

required

The triggers required to apply the coupon

triggers*

rewards

array of objects

required

The rewards applied when this coupon is used.

rewards*

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here!