Page Comparison

couponCode

String (max: 20 chars)

coupon the code for newly created coupon

Y

campaignId

Integer

Id of the campaign coupon should apply to

Y

applyTo

ENUM('BASE';'SHIPPING';'BOTH')

specify if coupon should apply to base price or shipping or both

Y

singleUse

Boolean

should this be a single use coupon?

N

oneTimeCoupon

Boolean

should this be a one time coupon?

N

isRecurring

Boolean

is this a recurring coupon?

N

discountType

ENUM('FLAT';'PERCENT')

specify if the coupon should be a flat discount or percentage discount

Y

defaultCoupon

Boolean

specify if this coupon should always be applied, even if a customer does not enter it in

N

productId

String (max 100 chars)

comma-separated list of campaign product Ids that the coupon will apply to (omit if applying to whole order)

N (Y if passing isRecurring=1)

discount

Decimal

coupon discount amount

Y (N if passing isRecurring=1)

maxCycles

Integer

How many billing cycles should the coupon be valid for?

N (only applicable for recurring coupons)

recurringDiscount

Decimal

discount amount for recurring coupons

N (Y if passing isRecurring=1)

startDate

Date (mm/dd/yyyy)

the date on which to begin accepting the coupon

N

endDate

Date (mm/dd/yyyy)

the expiration date of the coupon

N

ruleType

ENUM('AMOUNT'; …QUANTITY;BUY_X_GET_Y_AMT;BUY_X_GET_Y_QTY

The type of coupon rule

Y

startValue

Integer

the beginning value in quantity at which the coupon rule should activatestart applying

N (Y if passing Y (if QUANTITY or BUY_X_GET_Y_QTY)

endValue

Integer

the ending value in quantity at which the coupon rule should activatestop applying

N (Y if passing

ruleDiscount

product

Integer

productQty

IntegerY (if QUANTITY or BUY_X_GET_Y_QTY)

discount

Decimal

the discount to give for this rule

product

Integer

For Buy X Get Y discounts, the product that should be discounted

Y (if QUANTITY or BUY_X_GET_Y_QTY)

productQty

Integer

For Buy X Get Y discounts, the product that should be discounted

Y (if QUANTITY or BUY_X_GET_Y_QTY)