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 | | |