| affiliate_oid |
int |
Associates an order with an affiliate when this value is set. |
[optional] |
| allow_multiple_one_time_codes |
bool |
True if multiple one time codes for this coupon can be used on a cart at the same time. |
[optional] |
| amount_off_items |
CouponAmountOffItems |
|
[optional] |
| amount_off_shipping |
CouponAmountOffShipping |
|
[optional] |
| amount_off_shipping_with_items_purchase |
CouponAmountOffShippingWithItemsPurchase |
|
[optional] |
| amount_off_subtotal |
CouponAmountOffSubtotal |
|
[optional] |
| amount_off_subtotal_and_free_shipping |
CouponAmountOffSubtotalFreeShippingWithPurchase |
|
[optional] |
| amount_off_subtotal_and_shipping |
CouponAmountOffSubtotalAndShipping |
|
[optional] |
| amount_off_subtotal_with_block_purchase |
CouponAmountOffSubtotalWithBlockPurchase |
|
[optional] |
| amount_off_subtotal_with_items_purchase |
CouponAmountOffSubtotalWithItemsPurchase |
|
[optional] |
| amount_off_subtotal_with_purchase |
CouponAmountOffSubtotalWithPurchase |
|
[optional] |
| amount_shipping_with_subtotal |
CouponAmountShippingWithSubtotal |
|
[optional] |
| automatically_apply_coupon_codes |
CouponAutomaticallyApplyCouponCodes |
|
[optional] |
| buy_one_get_one |
CouponBuyOneGetOneLimit |
|
[optional] |
| calculated_description |
str |
Calculated description displayed to the customer if no description is specified. |
[optional] |
| can_be_used_with_other_coupons |
bool |
True if this coupon can be used with other coupons in a single order. |
[optional] |
| coupon_oid |
int |
Coupon oid. |
[optional] |
| coupon_type |
str |
Coupon type. |
[optional] |
| description |
str |
Description of the coupon up to 50 characters. |
[optional] |
| discount_item_with_item_purchase |
CouponDiscountItemWithItemPurchase |
|
[optional] |
| discount_items |
CouponDiscountItems |
|
[optional] |
| expiration_dts |
str |
Date/time when coupon expires |
[optional] |
| free_item_and_shipping_with_subtotal |
CouponFreeItemAndShippingWithSubtotal |
|
[optional] |
| free_item_with_item_purchase |
CouponFreeItemWithItemPurchase |
|
[optional] |
| free_item_with_item_purchase_and_free_shipping |
CouponFreeItemWithItemPurchaseAndFreeShipping |
|
[optional] |
| free_item_with_subtotal |
CouponFreeItemWithSubtotal |
|
[optional] |
| free_items_with_item_purchase |
CouponFreeItemsWithItemPurchase |
|
[optional] |
| free_items_with_mixmatch_purchase |
CouponFreeItemsWithMixMatchPurchase |
|
[optional] |
| free_shipping |
CouponFreeShipping |
|
[optional] |
| free_shipping_specific_items |
CouponFreeShippingSpecificItems |
|
[optional] |
| free_shipping_with_items_purchase |
CouponFreeShippingWithItemsPurchase |
|
[optional] |
| free_shipping_with_subtotal |
CouponFreeShippingWithSubtotal |
|
[optional] |
| hide_from_customer |
bool |
Hide coupon from customer during checkout. Often used when coupons are automatic discounting mechanisms. |
[optional] |
| merchant_code |
str |
Merchant code of coupon up to 20 characters. |
[optional] |
| merchant_notes |
str |
Internal notes about this coupon. These are not visible to customer. |
[optional] |
| more_loyalty_cashback |
CouponMoreLoyaltyCashback |
|
[optional] |
| more_loyalty_points |
CouponMoreLoyaltyPoints |
|
[optional] |
| multiple_amounts_off_items |
CouponMultipleAmountsOffItems |
|
[optional] |
| no_discount |
CouponNoDiscount |
|
[optional] |
| percent_more_loyalty_cashback |
CouponPercentMoreLoyaltyCashback |
|
[optional] |
| percent_more_loyalty_points |
CouponPercentMoreLoyaltyPoints |
|
[optional] |
| percent_off_item_with_items_quantity_purchase |
CouponPercentOffItemWithItemsQuantityPurchase |
|
[optional] |
| percent_off_items |
CouponPercentOffItems |
|
[optional] |
| percent_off_items_and_free_shipping |
CouponPercentOffItemsAndFreeShipping |
|
[optional] |
| percent_off_items_with_items_purchase |
CouponPercentOffItemsWithItemsPurchase |
|
[optional] |
| percent_off_msrp_items |
CouponPercentOffMsrpItems |
|
[optional] |
| percent_off_retail_price_items |
CouponPercentOffRetailPriceItems |
|
[optional] |
| percent_off_shipping |
CouponPercentOffShipping |
|
[optional] |
| percent_off_subtotal |
CouponPercentOffSubtotal |
|
[optional] |
| percent_off_subtotal_and_free_shipping |
CouponPercentOffSubtotalAndFreeShipping |
|
[optional] |
| percent_off_subtotal_limit |
CouponPercentOffSubtotalLimit |
|
[optional] |
| percent_off_subtotal_with_items_purchase |
CouponPercentOffSubtotalWithItemsPurchase |
|
[optional] |
| percent_off_subtotal_with_subtotal |
CouponPercentOffSubtotalWithSubtotal |
|
[optional] |
| quickbooks_code |
str |
Quickbooks accounting code. |
[optional] |
| restrict_by_postal_codes |
list[str] |
Optional list of postal codes which restrict a coupon to within these postal codes. |
[optional] |
| restrict_by_screen_branding_theme_codes |
list[CouponRestriction] |
Optional list of legacy screen branding theme codes to limit coupon use to only those themes. |
[optional] |
| restrict_by_storefronts |
list[CouponRestriction] |
Optional list of storefronts to limit coupon use to only those storefronts. |
[optional] |
| skip_on_rebill |
bool |
Skip this coupon when it is on a rebill of an auto order. |
[optional] |
| start_dts |
str |
Date/time when coupon is valid |
[optional] |
| super_coupon |
bool |
If true, this coupon can be used with ANY other coupon regardless of the other coupons configuration |
[optional] |
| tiered_amount_off_items |
CouponTieredAmountOffItems |
|
[optional] |
| tiered_amount_off_subtotal |
CouponTieredAmountOffSubtotal |
|
[optional] |
| tiered_percent_off_items |
CouponTieredPercentOffItems |
|
[optional] |
| tiered_percent_off_shipping |
CouponTieredPercentOffShipping |
|
[optional] |
| tiered_percent_off_subtotal |
CouponTieredPercentOffSubtotal |
|
[optional] |
| tiered_percent_off_subtotal_based_on_msrp |
CouponTieredPercentOffSubtotalBasedOnMSRP |
|
[optional] |
| usable_by |
str |
Who may use this coupon. |
[optional] |