Discounts & Coupons/Vouchers
A variety of discount & coupons/vouchers can be created and used with CartThrob. These discounts are stored as channel entries and are configured using a special custom field. The discounts system differs very little from the coupons system except that discounts do not require the customer to enter a code to apply the discount.
Table of Contents
- Available discount plugins
- Discounts Setup and Configuration
- Coupons/Vouchers Setup and Configuration
- Template tags
- Discount plugin development
Available discount plugins
CartThrob currently supports the following discount & coupon types:
- Amount off over x
- Amount off product
- Amount off entire cart
- Buy x get x for discounted price
- Free order
- Free shipping
- Limit by quantity
- Percentage off categories
- Percentage off product
- Percentage off entire cart
Discounts Setup and Configuration
You create discounts by adding entries to a Discounts channel. There are some specific requirements for setting up your discounts channel, so please take note of the directions below.
Discounts channel setup
Create the discounts channel. At a minimum, the discounts channel requires a "discount settings" field. When you create a custom field for this discount settings field, you must use the CartThrob Discount Settings field type. This field type will allow you to select from one of the coupon plugins (current plugins are listed above.) The CartThrob Discount Settings custom field type will output additional required coupon code fields in your channel.
When you choose a coupon type in your discounts channel, you will notice additional fields specific to that coupon type. Not all discounts require the same data, so this custom field type makes it easy to display all necessary settings for that coupon code.
Backend Configuration
Configure the CartThrob backend. Go to the Add-Ons › Modules › CartThrob. Click on Discounts. Once on this page, map the discount channel & then the discount field to the custom field you just created.
As our users request additional discount types we will add them, so please contact us if the discount type you require is not currently available.
Coupons/Vouchers Setup and Configuration
You create coupon codes by adding entries to a coupons channel. There are some specific requirements for setting up your Coupons channel, so please take note of the directions below.
Coupons channel setup
Create the Coupons channel. If you used the "Auto-Install Templates" option of the CartThrob extension, your coupons channel should already be correctly configured. At a minimum, the coupons channel requires a "coupon settings" field. When you create a custom field for this coupon settings field, you must use the "CartThrob Discount Settings" field type. This field type will allow you to select from one of the coupon plugins (current plugins are listed above). The Coupon Code Settings custom field type will output additional required coupon code fields in your channel.
The following fields are used by CartThrob's coupon system. The Coupon Code Field is optional:
- Coupon Code Field: you can set the Title field as the code field in the coupon settings if you'd like.
- Coupon Settings: described above.
When you choose one of these coupon types in your coupon channel you will notice additional fields specific to that coupon type. Not all coupons require the same data, so this custom field type makes it easy to display all necessary settings for that coupon code.
Backend Configuration
Configure the CartThrob backend. Go to the Add-Ons › Modules › CartThrob. Click on Discounts. Once on this page, map the coupon fields to the fields you just created.
As our users request additional coupon types we will add them, so please contact us if the coupon type you require is not currently available.