To configure the Discount Coupon Codes module, go to Modules > Order Total > Discount Coupon in the admininistration section of your website. Click the Edit button on the right side of the screen to edit the configuration options. Explanations for each option are provided below:
| Item Doodle x 1: | $25.00 |
| Discount Coupon XYZ Applied: | -$5.00 |
| Subtotal: | $20.00 |
| Tax: | $1.39 |
| Total: | $21.39 |
| Item Doodle x 1: | $25.00 |
| Subtotal: | $25.00 |
| Discount Coupon XYZ Applied: | -$5.00 |
| Tax: | $1.39 |
| Total: | $21.39 |
| Subtotal: | $25.00 |
| Discount Coupon XYZ Applied (State tax): | -$2.30 |
| Discount Coupon XYZ Applied (Local tax): | -$2.70 |
| Tax: | $1.39 |
| Total: | $21.39 |
| Subtotal: | $25.00 |
| Discount Coupon XYZ Applied: | -$5.00 |
| Tax: | $1.39 |
| Total: | $21.39 |
| Subtotal: | $25.00 |
| Discount Coupon XYZ for 20% Applied: | -$5.00 |
| Tax: | $1.39 |
| Total: | $21.39 |
Please Note: When Debug Mode is "on" (set to true), error messages will not work - the user will not be redirected to the payment screen when there is an error.
Log in to your admin section and go to Catalog > Discount Coupons. Click the New Coupon button to create a new Discount Coupon Code. The only field that is required is the discount amount.
Once you have created a discount coupon code, you may distribute it in any format. The only information a customer will need to use a coupon is the code you specified when creating the coupon. You can send out codes in newsletters, order confirmations, etc.
Discounts are displayed as order total lines in the customer's checkout confirmation screen and order history screen, and in all admin order screens.
Discounts are applied BEFORE tax.
- For percentage discounts, enter the amount as a decimal.
For example, .15 instead of 15 or 15% for a discount
of 15%
- For fixed discounts, enter the amount exactly as you want it to appear.
For example, 10 for a $10 discount
- For shipping discounts, enter the percentage discount you wish to offer.
For example, 1 for free shipping, .5 for
50% off shipping
Start dates and end dates must be in the same format as the formatting specified in admin/includes/languages/english.php (or the appropriate main language file for the language of your admin section).
You have the ability to manage excluded products, categories, manufacturers, customers, and shipping zones for each coupon you create. Customers will not be notified a product is excluded unless the order total/product quantity of non-excluded items doesn't meet the Min Order requirement for the coupon. In that case, they will not be given notice which particular items are excluded. If you create coupons with exclusions, it is recommended to ensure the customers know up front which products are excluded to avoid confusion.
You must create a coupon before you can manage exclusions for that coupon. See the section on Creating Discount Coupon Codes for help.
Log in to your admin section and go to Catalog > Discount Coupons. Select the coupon for which you wish to manage exclusions. In the box on the right side of the screen, you will see six buttons: edit, delete, product exclusions, manufacturer exclusions, category exclusions, customer exclusions, and shipping zone exclusions. Click on the button for the type of exclusions you wish to create.
The four exclusions screens work similarly. The box on the left will list products/manufacturers/categories/customers for which the coupon is NOT excluded. The box on the right lists products/manufacturers/categories/customers for which the coupon IS excluded. Use the top four buttons between these two boxes to move products from one box to the other. Click save when you are done.
If a product is in any excluded category, it will be considered an excluded item. For example, Product A is in Category 1 and Category 2. Category 1 is an excluded category. Even if a customer sees Product A in Category 2 and adds it to his/her cart, the product will still be considered excluded because Category 1 is excluded.
You may edit the fields that are displayed in the exclusions boxes by editing the following code starting on line 17 in admin/coupons_exclusions.php:
/**********************************************/
//toggle these true/false to determine which fields to display in product list in the same order as they are listed below
$display_fields = array(
'categories' => array( 'c.categories_id' => false,
'cd.categories_name' => true ),
'customers' => array( 'c.customers_id' => false,
'CONCAT( c.customers_firstname, CONCAT( " ", c.customers_lastname ) ) AS name' => true,
'c.customers_email_address' => false ),
'manufacturers' => array( 'm.manufacturers_id' => false,
//'mi.manufacturers_url' => false,
'm.manufacturers_name' => true ),
'products' => array( 'p.products_id' => false,
'p.products_model' => false,
'pd.products_name' => true,
'p.products_price' => false ) );
//separator for the fields in the listing
$separator = ' :: ';
//category exclusions
//separator for the category names
$category_separator = '->';
//toggle true/false to determine whether to display the full category path
$category_path = true;
//end category exclusions
/**********************************************/
You may prevent a field from being displayed by editing it's true/false status in the $display_fields array. The other settings modify the characters used to separate multiple fields in the exclusions boxes.
You can find support for this contribution at http://forums.oscommerce.com/index.php?showtopic=213019 (OSCommerce User Forums). Please read through the common problems in the install.html file or previous postings to see if your problem or question has already been answered. If you are posting about problems with exclusions or calculations, please set the Debug Mode to true in Configuring the Order Total Module to capture debugging information and include that output in your post.
Bug fixes and new releases are added to the contribution page at http://www.oscommerce.com/community/contributions,4269.