| affiliateOid |
Integer |
Associates an order with an affiliate when this value is set. |
[optional] |
| allowMultipleOneTimeCodes |
Boolean |
True if multiple one time codes for this coupon can be used on a cart at the same time. |
[optional] |
| amountOffItems |
CouponAmountOffItems |
|
[optional] |
| amountOffItemsAndFreeShipping |
CouponAmountOffItemsAndFreeShipping |
|
[optional] |
| amountOffShipping |
CouponAmountOffShipping |
|
[optional] |
| amountOffShippingWithItemsPurchase |
CouponAmountOffShippingWithItemsPurchase |
|
[optional] |
| amountOffSubtotal |
CouponAmountOffSubtotal |
|
[optional] |
| amountOffSubtotalAndFreeShipping |
CouponAmountOffSubtotalFreeShippingWithPurchase |
|
[optional] |
| amountOffSubtotalAndShipping |
CouponAmountOffSubtotalAndShipping |
|
[optional] |
| amountOffSubtotalWithBlockPurchase |
CouponAmountOffSubtotalWithBlockPurchase |
|
[optional] |
| amountOffSubtotalWithItemsPurchase |
CouponAmountOffSubtotalWithItemsPurchase |
|
[optional] |
| amountOffSubtotalWithPurchase |
CouponAmountOffSubtotalWithPurchase |
|
[optional] |
| amountShippingWithSubtotal |
CouponAmountShippingWithSubtotal |
|
[optional] |
| automaticallyApplyCouponCodes |
CouponAutomaticallyApplyCouponCodes |
|
[optional] |
| buyOneGetOne |
CouponBuyOneGetOneLimit |
|
[optional] |
| calculatedDescription |
String |
Calculated description displayed to the customer if no description is specified. |
[optional] |
| canBeUsedWithOtherCoupons |
Boolean |
True if this coupon can be used with other coupons in a single order. |
[optional] |
| couponOid |
Integer |
Coupon oid. |
[optional] |
| couponType |
String |
Coupon type. |
[optional] |
| description |
String |
Description of the coupon up to 50 characters. |
[optional] |
| discountItemWithItemPurchase |
CouponDiscountItemWithItemPurchase |
|
[optional] |
| discountItems |
CouponDiscountItems |
|
[optional] |
| expirationDts |
String |
Date/time when coupon expires |
[optional] |
| freeItemAndShippingWithSubtotal |
CouponFreeItemAndShippingWithSubtotal |
|
[optional] |
| freeItemWithItemPurchase |
CouponFreeItemWithItemPurchase |
|
[optional] |
| freeItemWithItemPurchaseAndFreeShipping |
CouponFreeItemWithItemPurchaseAndFreeShipping |
|
[optional] |
| freeItemWithSubtotal |
CouponFreeItemWithSubtotal |
|
[optional] |
| freeItemsWithItemPurchase |
CouponFreeItemsWithItemPurchase |
|
[optional] |
| freeItemsWithMixmatchPurchase |
CouponFreeItemsWithMixMatchPurchase |
|
[optional] |
| freeShipping |
CouponFreeShipping |
|
[optional] |
| freeShippingSpecificItems |
CouponFreeShippingSpecificItems |
|
[optional] |
| freeShippingWithItemsPurchase |
CouponFreeShippingWithItemsPurchase |
|
[optional] |
| freeShippingWithSubtotal |
CouponFreeShippingWithSubtotal |
|
[optional] |
| hideFromCustomer |
Boolean |
Hide coupon from customer during checkout. Often used when coupons are automatic discounting mechanisms. |
[optional] |
| merchantCode |
String |
Merchant code of coupon up to 20 characters. |
[optional] |
| merchantNotes |
String |
Internal notes about this coupon. These are not visible to customer. |
[optional] |
| moreLoyaltyCashback |
CouponMoreLoyaltyCashback |
|
[optional] |
| moreLoyaltyPoints |
CouponMoreLoyaltyPoints |
|
[optional] |
| multipleAmountsOffItems |
CouponMultipleAmountsOffItems |
|
[optional] |
| noDiscount |
CouponNoDiscount |
|
[optional] |
| percentMoreLoyaltyCashback |
CouponPercentMoreLoyaltyCashback |
|
[optional] |
| percentMoreLoyaltyPoints |
CouponPercentMoreLoyaltyPoints |
|
[optional] |
| percentOffItemWithItemsQuantityPurchase |
CouponPercentOffItemWithItemsQuantityPurchase |
|
[optional] |
| percentOffItems |
CouponPercentOffItems |
|
[optional] |
| percentOffItemsAndFreeShipping |
CouponPercentOffItemsAndFreeShipping |
|
[optional] |
| percentOffItemsWithItemsPurchase |
CouponPercentOffItemsWithItemsPurchase |
|
[optional] |
| percentOffItemsWithMinimumItemAmount |
CouponPercentOffItemsWithMinimumItemAmount |
|
[optional] |
| percentOffMsrpItems |
CouponPercentOffMsrpItems |
|
[optional] |
| percentOffRetailPriceItems |
CouponPercentOffRetailPriceItems |
|
[optional] |
| percentOffShipping |
CouponPercentOffShipping |
|
[optional] |
| percentOffSubtotal |
CouponPercentOffSubtotal |
|
[optional] |
| percentOffSubtotalAndFreeShipping |
CouponPercentOffSubtotalAndFreeShipping |
|
[optional] |
| percentOffSubtotalLimit |
CouponPercentOffSubtotalLimit |
|
[optional] |
| percentOffSubtotalWithItemsPurchase |
CouponPercentOffSubtotalWithItemsPurchase |
|
[optional] |
| percentOffSubtotalWithSubtotal |
CouponPercentOffSubtotalWithSubtotal |
|
[optional] |
| quickbooksCode |
String |
Quickbooks accounting code. |
[optional] |
| restrictByPostalCodes |
List<String> |
Optional list of postal codes which restrict a coupon to within these postal codes. |
[optional] |
| restrictByScreenBrandingThemeCodes |
List<CouponRestriction> |
Optional list of legacy screen branding theme codes to limit coupon use to only those themes. |
[optional] |
| restrictByStorefronts |
List<CouponRestriction> |
Optional list of storefronts to limit coupon use to only those storefronts. |
[optional] |
| skipOnRebill |
Boolean |
Skip this coupon when it is on a rebill of an auto order. |
[optional] |
| startDts |
String |
Date/time when coupon is valid |
[optional] |
| superCoupon |
Boolean |
If true, this coupon can be used with ANY other coupon regardless of the other coupons configuration |
[optional] |
| tieredAmountOffItems |
CouponTieredAmountOffItems |
|
[optional] |
| tieredAmountOffSubtotal |
CouponTieredAmountOffSubtotal |
|
[optional] |
| tieredPercentOffItems |
CouponTieredPercentOffItems |
|
[optional] |
| tieredPercentOffShipping |
CouponTieredPercentOffShipping |
|
[optional] |
| tieredPercentOffSubtotal |
CouponTieredPercentOffSubtotal |
|
[optional] |
| tieredPercentOffSubtotalBasedOnMsrp |
CouponTieredPercentOffSubtotalBasedOnMSRP |
|
[optional] |
| usableBy |
UsableByEnum |
Who may use this coupon. |
[optional] |