Having hard time finding an answer to your question?

Check out our Knowledge Base.


Extension page: http://ecommerce.aheadworks.com/magento-extensions/checkout-promo.html

Checkout Promo allows you to display shopping cart and checkout banners basing on given rules. This is another powerful sales motivation extension - you can entice your customers to spend more to receive this or that benefit. "Buy X to get a discount", "Spend not less than Y to get a gift", "Buy product N to get K for free", and many other sales formulas can be successfully implemented using this extension. You can create as many rules as you wish and satisfy requirements even of the biggest ecommerce players.


1. Backup your web directory and store database.

You can make backup copies with any tool you find appropriate

If you are going to use the native Magento backup function, navigate to System -> Tools -> Backups and perform System and Database backups

 2. Log in to the Magento backend

 3. Disable compilation

Navigate to System -> Tools -> Compilation.

If Compiler status is Disabled, you can skip to the next step

If Compiler is enabled, disable it.

IMPORTANT: after the extension is installed, you can enable the compilation again; IT IS CRUCIAL that you use "Run Compilation Process" function, not just "Enable button"

Installing an extension with the Compilation enabled will result in store downtime.

 4. Flush store cache

You can flush the store cache in 2 ways:

  • via the backend:

Navigate to System -> Cache Management menu, and click Flush Magento Cache button

  • via filesystem:

On your server, navigate to Magento root folder, then proceed to /var/cache/; delete all the content there.

 5. Download the extension package from your account and extract the downloaded archive

 6. Copy the content of /Step_1/ folder to your store's root directory

In case you are using a custom theme, it is recommended to copy the design files to your current theme's folders. In case there are several themes in use at the same store, the design files must be copied to each of them.

  • Find this folder in the package: /step_1/app/design/frontend/base/default/ ; copy its content to /app/design/frontend/[your_package]/[your_theme]/
  • Find this folder in the package: /step_1/skin/frontend/base/default/ ; copy its content to /skin/frontend/[your_package]/[your_theme]/

 7. Copy the content of /Step_2/ folder to your store's root directory

 8. Flush store cache again; log out from the backend and log in again.



Checkout Promo shows static blocks on the Checkout and/or Shopping Cart pages. The blocks are created through CMS -> Static Blocks backend menu. After a block is saved, it will become available for selecting in a Checkout Promo rule.

Do not forget to set the Enabled status for CMS blocks you'd like to display.


Checkout Promo rules can be added/edited from the Promotions->Checkout Promo backend page.

Rule Setup

General Information tab allows defining basic rule parameters:

  • Rule Name - the internal rule identifier
  • Description - an optional text area
  • Status - enables / disables a rule
  • Websites - defines what website(s) the rule will be active on
  • Customer Groups - this selector allows to restrict the customer groups the rule will be active for
  • From / To Dates - these options allow automatic enabling / disabling the rule on the selected dates
  • Priority - sets the rule processing order


 In the Conditions tab you can define when the rule will be triggered.

The list of the available conditions is identical to that of the standard Shopping Cart Price Rules.

The selected conditions are matched against the visitor's current Cart contents.

Make sure that you set the conditions according to when you want the banner to appear.

E.g., you have a banner informing a customer that they will get free shipping if they order 5 or more items at once. Thus, the condition you set for the banner rule would be Total Items Quantity less than 5.


 Through the Actions tab, you can define what CMS block will be displayed when the rule conditions are met.

You can also select the target areas (Shopping Cart and / or Checkout Screen)

Stop further rule processing option works for the Checkout Promo rules only, i.e., it will only prevent other banners from displaying. This option does not affect native Shopping Cart Price Rules.



Market Segmentation Suite extension integration

The Market Segmentation Suite (MSS) extension by aheadWorks allows you to define a combination of rules. While being processed these rules can take into account a set of different conditions regarding customer's properties, their shopping cart, wishlist, previous purchases, etc.

The visibility of blocks displayed by the Checkout Promo extension can be controlled by validating MSS rule assigned to the Checkout Promo rule.

Triggering MSS rule conditions

Checkout Promo decides whether to display its blocks basing on two moments:

Since MSS extension operates data that might not be available on moments listed above, some rules may not be triggered due to insufficient source data.

Below there is a list of MSS conditions that may not be checked properly:

Condition typeData needed for the condition to be checkedAvailability
Order group
Number of ordersCustomer accountCustomer has to be registered and logged in
Sales amount
Purchased quantity
Customers group
Billing/shipping address


Billing address, Shipping address, First name, Last name, Email

If the customer is not registered and logged in, these data will not be available until the customer enters it.
For unregistered customers, the rule will trigger only if customer refreshes or comes again to the Checkout page during current customer session after filling in fields on the Checkout page.
First name/Last name
Customer group


Customer account


Not available if the customer is not registered and logged in

Date of birth
Newsletter and/or Advanced newsletter subscription
Shopping Cart group
Grand totalCurrent orderAvailable always
Number of items
Products group
Product listWishlist or Shopping CartAvailable always for Shopping Cart
For Wishlist available for registered customers only
Product historyList of products bought before which order status is "Complete" taken from customer accountAvailable if customer is registered and logged in


If you just need to temporary disable the extension, you can just do the steps 1-5, without deleting the files of the extension.

  1. Disable compilation, in case it is enabled.
  2. Login to your FTP, navigate to app/etc/modules/
  3. Open the file AW_Checkoutpromo.xml and change the following line:








    Now your Magento is unaware of the existence of this module.

  4. Clear the cache under var/cache
  5. Make sure that the site is working properly, otherwise roll back the changes and apply to our technical support.
  6. If everything works fine, it is safe to delete the files of the extension.
  7. In case you need to clean the database, backup your database and then run the following queries in MySQL: 


    DROP TABLE`aw_checkoutpromorule`;



    delete from core_resource where code ='checkoutpromo_setup'


    Note, if you are using the table with prefixes, you must specify them in all table names. 

    If you are not sure how to do that or expect any troubles with it, please contact your server administrator regarding the matter.
    If you remove the tables as it is described above, you will need to create all Checkout Promo rules again after the extension is reinstalled. 


After the extension installation the store gives an error, or blank page, or suggests to start Magento installation procedure.

Change the owner of the extracted extension files to the web server user and set 775 permissions on them. Clear the store cache and try again.

After the extension installation I receive a 404 error in Promotions->Checkout Promo Rules.

Logout from backend and login back. 

There is no aheadWorks extensions under my configuration section, or having the extension tab clicked I get a blank page, or Access Denied error.

Clear the store cache, browser cookies, logout and login again.

I've set up everything correctly, inserted the HTML code but there is nothing on that page.

Clear the store cache, clear your browser cache and domain cookies and refresh the page.

My configuration changes do not appear on the store.

 Clear the store cache, clear your browser cache and domain cookies and refresh the page.

You can always find the latest version of the software, full documentation, demos, screenshots and reviews at http://ecommerce.aheadworks.com
License agreement: http://ecommerce.aheadworks.com/LICENSE-M1.txt
Contact us: http://ecommerce.aheadworks.com/contacts/
Copyright © 2019 aheadWorks Co. http://www.aheadworks.com