Import Coupons

New coupons can be imported into your campaigns via a CSV file. This can help streamline your setup.

Navigate to Admin → Import and select Import New Coupons from the Import Type dropdown selector.


Click on the blue Download Example File link. This will download a file onto your computer which will show you how the file must be mapped.

File headers must be the exact header that is shown on the example file.

That downloadable file is also posted below:

Field

Type

Description

Required

Field

Type

Description

Required

couponCode

String (max: 20 chars)

the code for the newly created coupon

Y

campaignId

Integer

Id of the campaign the coupon should apply to

Y

applyTo

BASE or SHIPPING or BOTH

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

Y

singleUse

Boolean (0 or 1)

should this be a single use coupon?

N

oneTimeCoupon

Boolean (0 or 1)

should this be a one time coupon?

N

isRecurring

Boolean (0 or 1)

is this a recurring coupon?

N

discountType

FLAT or PERCENT

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

Y

defaultCoupon

Boolean (0 or 1)

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

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)

productTags

String (max 100 chars)

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

N

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

AMOUNT or QUANTITY or BUY_X_GET_Y_AMT or BUY_X_GET_Y_QTY

The type of coupon rule

Y

startValue1

Integer

the first quantity at which the coupon rule should start applying

Y (if QUANTITY or BUY_X_GET_Y_QTY)

endValue1

Integer

the first quantity at which the coupon rule should stop applying

Y (if QUANTITY or BUY_X_GET_Y_QTY)

discount1

Decimal

the first discount to give for this rule

 

product1

Integer

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

Y (if QUANTITY or BUY_X_GET_Y_QTY)

productQty1

Integer

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

Y (if QUANTITY or BUY_X_GET_Y_QTY)

startValue2

Integer

the second quantity at which the coupon rule should start applying

Y (if QUANTITY or BUY_X_GET_Y_QTY)

endValue2

Integer

the second quantity at which the coupon rule should stop applying

Y (if QUANTITY or BUY_X_GET_Y_QTY)

discount2

Decimal

the second discount to give for this rule

 

product2

Integer

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

Y (if QUANTITY or BUY_X_GET_Y_QTY)

productQty2

Integer

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

Y (if QUANTITY or BUY_X_GET_Y_QTY)

startValue3

Integer

the third quantity at which the coupon rule should start applying

Y (if QUANTITY or BUY_X_GET_Y_QTY)

endValue3

Integer

the third quantity at which the coupon rule should stop applying

Y (if QUANTITY or BUY_X_GET_Y_QTY)

discount3

Decimal

the third discount to give for this rule

 

product3

Integer

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

Y (if QUANTITY or BUY_X_GET_Y_QTY)

productQty3

Integer

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

Y (if QUANTITY or BUY_X_GET_Y_QTY)

 

Once the CSV file is complete with all the new coupons, click the green Upload CVS Data File button. Select the file from your computer.

The bottom portion of the Import page shows the Pending and Completed uploads. It will also show if there were any errors on the import.