Settings
Rules list
Add/Edit rule
Modules
Template changes 

Settings

settings

Compoent Active: If you desactivate component, no rule will be executed on customer's cart
Virtuemart: Check if Virtuemart is installed
Extended classes enabled: This must be activated in Virtuemart configuration for the component to work

vm settings
Theme files: verifies the necessary theme files are present. If you installed a new Virtuemart theme, you'll get a button to copy the files to the new theme. 

top 

THERE SHOULD NOT BE ANY SETTING IN RED HERE.

Rules list

rules

This list all rules that are configured. Click on the rule name to edit

 

top 

Add/Edit rule

A rule is a set of conditions and result actions. There are several parameters there that make this component very powerfull. We recommend you start with very simple rule and add complexity one at a time.

Condition

rule-conditions

Published: Whether the rule will ne parsed or not. This is usefull to keep a rule that can be temporarily disabled
Start/End publishing: The rule will be parsed only  within the selected dates. Leave empty to have the rule valid at anytime
Shoppers groups: A rule can be valid only for some specific shoppers groups. For example, Gold members would get a gift over 100$ purchase
Matching products in cart: Start typing product or category name in the search box to get a list of product. Select the one(s) you want to add. EVERY ITEM here must be in the customer's cart to validate the rule. Don't put too many items or the chances to validate the rule will drop. In the example here, the rule will be valid when BOTH Shovel AND Nice Saw are in the cart.
Minimum/Maximum cart amount: Rule will be valid only when the cart subtotal is within the price range. Leave to zero to bypass this parameter. For example, offer a bonus for every purchase between 50$ and 100$. (you can set another rule to offer a greater bonus product when the cart is over 100$)
Minimum/Maximum cart weight: Rule will be valid only when the weight of all items in the cart is within the range. Leave to zero to bypass this parameter. 
Number of products in cart: The rule will be validated as soon as the total number of items reaches the value set here. With 3 for example, 2xProd A + 1xProd B is valid
Number of distinct products in cart: The rule will be validated as soon as the number of different skus in cart reaches the value.  With 3 for example, 2xProd A + 1xProd B is NOT Valid but 2xProd A + 1x Prod B + 1x Prod C is valid.
Filter by category: This filter applies to amount and number of products/skus in cart only. This is usefull to count the number of products or total of products within the selected categories (OR conditions)
Filter by manufacturer:  This filter applies to amount and number of products/skus in cart only. This is usefull to count the number of products or total of products within the selected manufacturers (OR conditions)

 

top 

Result

Whenever a rule is validated, it can add, remove items or coupons to customer's cart. A rule will not update any product price so if you want to offer a product for free or sell it separatly, simply clone your product, set it's price to zero nd keep it unpublished so that it will not show up in the product list of your shop.

rule-result

Coupon to add: This will list the permanent coupons defined in Virtuemart. Remember to activate Virtuemart coupon functionnality in Virtuemart settings to use this. If you have AWO Coupon installed, these coupons will be used instead, offering you much more possibilities.
Products to add: Search and select the products you'd like to be added to the customer's cart. If you product has attributes, the customoer will be able to select them directly from the cart.
Quantity to add: Number of times the product should be added every time the rule is valid (see Limit the rule to be applies x times below for further information) 
Check stocks: If you've set a number of products in stock for this item and enable this, the product will be added only if there are stocks left. This is usefull if you have only a limited quantity of promotional items.
Check minimum order quantity: This is a bit more tricky but very powerfull. If you've set a minimum order quantity to the bonus item, it will be added only when that quantity is reached. Let's say the minimum order quantity is 2, quantity to add is 1 and the rule condition is  minimum 10$. With 10$ in cart, the rule will try to add one product but since the minimum order quantity is not reached, it will not be added. However, if you have 20$ in cart, the rule gets validated twice so the bonus item is added with a quantity of 2 and the product is now added (qty=2).
Check maximum order quantity: As above, the maximum order quantity can limit the number of bonus items that can be added to the cart
User can update quantity: This will let the user change the added quantity (or remove the bonus item). It can be usefull when you want to suggest a product (when customer buys a power sander, you may want to suggest him to buy some sanding papers) 
Limit the rule to be executed x times: the rule can be validated several times withiin the cart like for the 10$/20$ sample above or with the number of items/distinct items. By setting a value here, you'll make sure the rule won't be executed more than the number of times you define. If you set 4 with 10$ minumum purchase the rule would be 'Add 1 bonus for every 10$ up to 40$.
Products to remove: A rule can also remove products from customer's cart.
Last valid rule to be executed: When the rule IS VALID and this setting is enabled, no further rule will be tested (based on the rule order you can define on the rules list screen) 

 

top 

Upsell

This will show a message on top of customer's cart when he is close to be elligible for a bonus.
Upsell amout percentage: When should the upsell be displayed. For example if you've set 80% and a minimum amount of 100$ the message will be shown when the customer's cart reaches 80$
If your rule is set in quantities, the message will be shown when there is one product missing to validate the rule.
Upsell message: You can use the tags below to get a formated message and these tags will be replaced by the actual values. 

upsell

 

top 

Modules

 Virtuemart Bonus comes with 3 modules. One Administration module to display a quick icon in your Admin Panel and 2 front end modules.
mod_vm_bonus_qicon: Should be displayed in 'icon' position. You can enable the version checker to be alerted when a new version is available.
mod_virtuemart_bonus: Will display a list of bonus products that are currently offered on the site.
mod_virtuemart_bonus_upsell: Will display the same upsell message as in the shopping cart. 

top 

Template changes

The Bonus component is written in state of the art Joomla MVC. Therefore you can modify the templates of your theme or the ones provided with VM Bonus.
The basket files in particular need to be modified in order to display addintional information for Bonus but the files from your theme are left intact.
Whenever a template file is present in /components/com_vm_bonus/theme, it will be used instead of the one in /components/com_virtuemart/themes/your-theme/templates/
The files provided are based on the Virtuemart default theme.

If your theme has modified basket, files, copy these files from your theme to /components/com_vm_bonus/theme_custom/basket and modify these to integrate VM Bonus changes.

Open the /components/com_vm_bonus/theme/basket files and look for the followig text to identify the pieces of code you'll have to replicate in your file.

/**************************
* BEGIN: VM_BONUS CHANGE *
**************************/

 

top