Create Coupon

post

https://api.qpilot.cloud/Sites/{siteId}/Coupons

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

siteId

int64

required

The site identifier

Body Params

The coupon to create

int64

siteId

int64

code

string

required

length between 0 and 20

name

string | null

country

string | null

postcode

string | null

state

string | null

city

string | null

minUnits

int32 | null

maxUnits

int32 | null

minWeight

double | null

maxWeight

double | null

weightUnitType

string

enum

Allowed:

cycles

int32

maxCyclesPerSite

int32 | null

minSubtotal

float | null

maxSubtotal

float | null

maxCyclesPerCustomer

int32 | null

assignments

int32

maxAssignmentsPerCustomer

int32 | null

maxAssignmentsPerSite

int32 | null

minScheduledOrderCycles

int32 | null

maxScheduledOrderCycles

int32 | null

maxCyclesPerScheduledOrder

int32 | null

maxDiscountPerCustomer

double | null

lifetimeValue

double

amount

double

discountType

string

enum

maxPercentageDiscount

double | null

expirationDate

date-time | null

applyExpirationDateToExisting

boolean

isStackable

boolean

productId

int64 | null

product

object

productGroupId

int64 | null

productGroup

object

productDiscountNotAppliesWhenItHasSalePrice

boolean

subtotalDiscountAppliesToRegularPrice

boolean

createdUtc

date-time

updatedUtc

date-time

customerCouponUsages

array of objects | null

customerCouponUsages

includeCustomerEmails

string | null

excludeCustomerEmails

string | null

active

boolean

valid

boolean

couponInvalidationCode

string

enum

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success