Purpose of Module
The Discount Based on Subtotal module allows the Miva Merchant store to offer discounts based on the subtotal of the items in the customer's basket. This allows the store to offer overall volume pricing across its entire product line. For example, the store may offer 10% off orders between $200 and $499.99, and 20% off orders of $500 or more. The module provides flexibility to exclude certain products and to exclude certain price groups.
The module also allows the subtotal calculation to include basket charges of a given type. If the "included charges" option is left blank, then the subtotal will be the sum of all the products (and their attributes) in the basket, and will not include any charges such as shipping or tax. In this case, if a coupon or another discount is applied, then the subtotal will also not include that discount. Since it is often desirable to base the discount off the subtotal AFTER applying the coupon, the store administrator can specify the coupon charge code in the included charges, and then it will be deducted before this module's discount is applied.
How to Install
- Installing the Module
- Unzip the module's ZIP file to your hard drive
- Log into your Miva admin utility
- Expand the navigation tree next to Modules
- Click the link "Add Module"
- Click the "Upload File" graphic
- Click the "Browse" button
- Browse to the location where you stored the contents of the ZIP file
- Select nbdiscsubtotal.mv(c)
- Click the "Upload" button
- When the graphic has been uploaded, the small "Upload File" window will disappear, leaving you with the main Miva admin screen visible
- Click the "Add" button on the main Miva admin screen
- Associating the Module with a Store
- Log into your Miva admin utility
- Expand the navigation tree next to Stores
- Expand the navigation tree next to the store with which you wish to associate this module
- Click the "Logging Configuration" link under the store
- In the list of modules, you should see an entry for NetBlazon's Discount Based on Subtotal. Check the box next to this module and then click the Update button.
- Above the list of modules should be a new link labelled "Discount Based on Subtotal". Click this link.
- Enter your license key and click the "Update" button
Administrator Interface - Discount Levels
To access the module's administration screens, click the Logging Configuration link under your store. Then, on the right side, click the link labelled "Discount Based on Subtotal". Under the licensing information are two subtabs labeled "Discount Levels" and "Options". Discount Levels is the default selected subtab.
The Discount Levels subtab allows you to specify the discounts levels that will be active in the store. To add a new level, click the "New" icon in the navy blue header. Under "Minimum Amount", enter the basket subtotal minimum that should trigger this discount. If desired, also enter a "Maximum Amount". If this is the only or highest discount level, you can leave the Maximum Amount blank to indicate no limit. Enter the text you wish displayed in the basket contents for this discount, under "Description in Basket". Then, enter the discount in the last box. If the discount should be taken as a percentage of the subtotal, check the "Percent" box. If blank, the exactly dollar amount will be taken as a discount. When you are done click the Update button.
You may enter as many discount levels as you like. Note that the module will apply the first discount that the basket qualifies for. So, if you overlap levels, you may get results that are not what you desire. Be careful not to overlap discount levels unless you have a particular reason to do so.
Administrator Interface - Options
There are a number of global options that can be specified for this module:
- Discount is Tax Exempt?: If checked, then the discount charge will be tax exempt. Otherwise the discount charge is included in the amount when tax is calculated.
- Excluded Products: Any products listed here will not count toward the required basket subtotal that triggers a discount. Enter product codes separated by a pipe (|) character.
- Excluded Price Groups: Customers assigned to price groups specified here will not receive the discount when they are logged into their account. Enter price group names separated by a pipe (|) character.
- Included Charges: Normally, no charges are included when calculating the subtotal in order to determine which (if any) discount is applied. In order to include certain charges in the subtotal, specify their code(s) here, separated by the pipe (|) character.
Using Discount Based on Subtotal with Templating Systems
Discount Based on Subtotal provides several OpenTokens for use with various templating systems. The OpenTokens provided are:
- discount: Discount amount (unformatted) based on the current basket contents.
- subtotal: Current basket's qualifying subtotal.
Before tokens can be used in most templating systems, Discount Based on Subtotal must be registered as a third-party token. This is done in different locations depending on which templating system is in use. To register Discount Based on Subtotal as a third-party OpenToken, log Miva Merchant, click the triangle next to Stores, and then click the name of your store. Then on the right side, click the OpenUI Tokens link. Next, click the round "New" button. For module code, enter "NBDISCSUBTOTAL" (without the quotes), and for token, also enter "NBDISCSUBTOTAL" (without the quotes). To register Discount Based on Subtotal as a third-party token with other templating systems, please refer to those systems' documentation for instructions.
Now, within your templates, you can reference Discount Based on Subtotal's tokens in the following manner:
(For Product and Category Page Templates, make sure to add an extra pipe as shown:
The string after the last pipe ("|") character should be replaced with the appropriate token from the list above.