You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 7
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) | 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 quantity at which the coupon rule should start applying | Y (if QUANTITY or BUY_X_GET_Y_QTY) |
endValue
| Integer | the quantity at which the coupon rule should stop applying | Y (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) |
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.