Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Coupons can be imported into your CheckoutChamp campaigns via a CSV file which can help streamline your setup.

To import a CSV with coupons, navigate to Admin → Import and then select the “Import New Coupons” option from the Import Type dropdown selector.

After you select “Import New Coupons” 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.

That downloadable file is also posted below:

 Expand for details about each header title

Field

Type

Description

Required

couponCode

String (max: 20 chars)

coupon code for newly created coupon

Y

campaignId

Integer

Id of the campaign coupon should apply to

Y

applyTo

ENUM('BASE';'SHIPPING')

specify if coupon should apply to base price or shipping

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

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 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'; …

startValue

Integer

the beginning value in which the coupon should activate

N (Y if passing

endValue

Integer

the ending value in which the coupon should activate

N (Y if passing

ruleDiscount

product

Integer

productQty

Integer

Once you have filled in the CSV with all the coupons you would like to create, click the green Upload CVS Data File button and select the appropriate CSV file from your computer.

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

  • No labels