• Installing M2 Add Free Product to Cart
• Set up cron
• Uninstalling M2 Add Free Product to Cart
• Compatibility
• Getting Around
• M2 Add Free Product to Cart On Backend
• M2 Add Free Product to Cart On Frontend
• FAQ

Add Free Product to Cart for Magento 2 automatically adds to cart discounted or free products of various types and visibility attribute: simple, configurable, downloadable, "not visible individually". This functionality is governed by scenario rules, pre-configured on the backend. Customers get informed on active promo campaigns via customizable banners and popups. Admins track the success of their promo campaigns with the help of the comprehensive dashboard of the extension.

API documentation link

Installing M2 Add Free Product to Cart

Command Line Installation

1. Backup your web directory and store database
2. Download the Add Free Product to Cart installation package
3. Upload the contents of the Add Free Product to Cart installation package to your store root directory
4. In the SSH console of your server, navigate to your store root folder:

cd path_to_the_store_root_folder

run:

php bin/magento module:enable Aheadworks_Afptc

php bin/magento module:enable Aheadworks_AfptcGraphQl

then:

php bin/magento setup:upgrade

after:

php bin/magento setup:static-content:deploy -f

     5. Flush the store cache, log out from the backend, and log in again

Composer Installation

1. If you are installing an extension from Aheadworks for the first time, you need to add our composer repository to your Magento store:

Login to your ssh console and navigate to your store folder:

cd path_to_the_store_root_folder

Run the following commands:

composer config repositories.aheadworks composer https://dist.aheadworks.com/

On successful execution of the commands you will be able to use the composer to install the extensions.

     2. To install the extension:

Login to your ssh console and navigate to your store folder:

cd path_to_the_store_root_folder

     3. To install the latest version of the extension:

composer require aheadworks/module-afptc

if you need to install a specific version, run this command:

composer require aheadworks/module-afptc:<version>

When prompted, enter Public Key (Username) and Private Key (Password):

Both Public Key (Username) and Private Key (Password) can be found in My Projects and Licenses in your personal account on our site:

Run the following command to install Add Free Product to Cart GraphQl:

composer require aheadworks/module-afptc-graph-ql 

Need to use with Klarna payment method?

Make sure the official module of the payment gateway is installed and proceed with a corresponding command:

composer require aheadworks/module-afptc-klarna(for Magento 2.3.* and 2.4.3 and below) 

composer require aheadworks/module-afptc-mm-klarna(for Magento 2.4.4 and above)

     4. Enable the extension:

php -f bin/magento module:enable Aheadworks_Afptc

php -f bin/magento module:enable Aheadworks_AfptcGraphQl

Need to use with Klarna payment method?

Make sure the official module of the payment gateway is enabled and proceed with a corresponding command:

bin/magento module:enable Aheadworks_AfptcKlarna (for Magento 2.3.* and 2.4.3 and below) 

bin/magento module:enable Aheadworks_AfptcMmKlarna (for Magento 2.4.4 and above)

Next, register the extension:

bin/magento setup:upgrade

Recompile your Magento store if you are in the Production mode:

bin/magento setup:di:compile

To verify that the extension is enabled, run this command:

bin/magento module:status

Clean store cache, by running the following command:

bin/magento cache:clean

Log out and Log in the backend again.

composer require hyva-themes/magento2-aheadworks-afptc

To upgrade the extension:

     5. To update or upgrade an extension:

Download the updated extension file. Take note of the module-name and version. Export the contents to your Magento root.

If a composer package exists for the extension, run one of the following.

Update per module name:

composer update aheadworks/module-afptc

Updater per version:

composer require aheadworks/module-afptc:<version>

Run the following commands to upgrade, deploy, and clean the cache.

php bin/magento setup:upgrade --keep-generated
php bin/magento setup:static-content:deploy
php bin/magento cache:clean

Set up cron

If you have already configured cron jobs for your Magento installation then you can skip this step. Read the following instructions on setting cron job for your Magento store:Magento user guide.

Generally, it would be enough to run in SSH console of your server: 

crontab -e

And insert the following line:  

*/3 * * * * php -c <ini-file-path> <your Magento install dir>/bin/magento cron:run
*/3 * * * * php -c <ini-file-path> <your Magento install dir>/update/cron.php
*/3 * * * * php -c <ini-file-path> <your Magento install dir>/bin/magento setup:cron:run

Remember to confirm the Save request when exiting the installation.

Uninstalling M2 Add Free Product to Cart

Since Magento introduced declarative Database you need to be very carefull when uninstalling or disabling the module.

Manual Removal

1. Disable the module by executing the following commands:

php bin/magento module:disable Aheadworks_Afptc
php bin/magento setup:upgrade

2. Remove the extension files from the following folder:

app/code/Aheadworks/Afptc

Automatic Removal (via Composer)

1. Disable the module by executing the following commands:

php bin/magento module:uninstall Aheadworks_Afptc

Compatibility

Getting Around

Integrations 

• Product labels
• Simple Bundle Product
• Advanced Subscription Products
• Customer Segmentation

M2 Add Free Product to Cart On Backend

To configure the extension proceed to Stores > Configuration > Aheadworks Extensions > Add Free Product to Cart.

• Default Title Of Popup - the title of the popup to be displayed in case of several active promo offers; 
• Hide options of configurable products - the Yes/No option ('Yes' makes sense if your offer contain both configurable and simple products);
• Where to display promo popup - the place of the popup display (on cart and checkout pages only, or on any page as soon as the contents of the cart are associated with the rule);
• Validate subtotal - allows including or excluding taxes from the subtotal of the cart when working out the rule.
• Do not Offer Promos for Products with Special Price -the Yes/No option (if set to 'Yes' promo rules are not applying to products with special price and parent product of this child).

 To complete the settings, click the 'Save Config' button on the top right.

Dashboard

To manage the scenario rules of the campaigns and track their performance proceeds to Marketing > Add Free Product to Cart > Rules. This is where you will see the Scenario grid as well as the board with some financial indicators of thereof.

The dashboard displays the following info:

• Active promo campaigns - the number of active promos;
• Total sales - the total amount of all orders with at least 1 promo item, $$;
• N% of all sales - the percentage of total sales which were stimulated by the promos;
• Orders - the total number of orders with at least 1 promo item;
• N% of all orders- the percentage of the total of orders stimulated by promos;
• Avg cart total of orders with promo items, $$;
• Avg cart total of all orders, $$;
• Promo Items per order - the average quantity of promo items per order.

The rule grid features the following columns:

• id - the identification number of the scenario;
• Title - the title of the rule;
• Scenario - the title of the scenario;
• Coupon - the name of the coupon, if part of the scenario;
• Status - indicates whether the scenario is enabled or disabled;
• From / to - the dates of promo activity;
• Priority - the decimal numeric for sorting the overlaying rules;
• Action - select an active link with two alternatives: Edit and Delete.

The functionality of the grid makes it possible to enable, disable and delete the rules both in bulk and individually. For the former, select the rules and use the Actions dropbox on the top left of the grid.

To edit the rule click Select in the corresponding Action cell, and select Edit. Alternatively, click on the row of the chosen rule. 

To design a new rule, click the Add New Rule button on the top right of the page.

Creating Rules

The New Rule page is made of four blocks: General Settings, Rule Settings, Popup Settings, and Promo Settings.

General Settings

The General Rules block features the following parameters for set-up:

• Title - the name of the rule;
• Description - the description of the rule (visible only on the backend);
• Enable - the Yes/No alternative;
• Active From / To - the dates of validity of the promo; 
• Customer Groups - restriction on the customer groups to fall under the promo campaign;
• Customer Segment Condition - define what customers will participate in the promo campaign: All visitors, Only specific segments or Exclude specific segments;
• Customer Segments - select customer segments to include in or exclude from the promotional campaign;

• Rule Priority - the decimal numeric to prioritize overlapping promos (zero is a top priority);
• Discard Subsequent Rules - the Yes/No alternative;
• Offer only those products which are in stock - the Yes/No alternative.

Rule Settings

This is where you opt for a scenario: "Buy X get Y", "Spend X Get Y", "Buy X get Y Free", "Coupon", set frequency of response, select products to participate in the campaign and decide on either a fixed-value- or %-discount.

Depending on the chosen scenario the block features a combination of the following parameters for set-up:

• Scenario - the Buy X Get Y, Spend X Get Y,  Buy X get Y Free, Coupon alternatives;
• Every time / First Time / Every Nth Time - the frequency of response of the scenario to the rule;
• When a user entered this coupon code - the text of the promo code;
• The "If" block - the conditions to define the scenario; 
• For a Fixed Amount / With A Percent Discount - the character of the discount, and the number of products to fall under the discount;
• The "Products" block - the native Magento "Add Products" functionality to add products to the campaign. 

The first four parameters are different for different scenarios. The other two stay the same.

The discount condition allows setting the (decimal integer) number of products (in the Products promo list ) which fall under the discount, the % or fixed-value character of the discount and the value of the discount/promo price. Clicking on the number here will open a text box to alter that number, clicking the character of the discount will open a swtich-box to choose between the two alternatives.

The Product block herein allows adding products to the promo, as well as removing them from it. Furthermore, you can configure selected parent-products.

The Products grid features the following columns:

• id - the identification number of the product;
• Name - the name of the product;
• SKU - the stock keeping unit number of the product;
• Thumbnail - the image of the product;
• Configuration - the active link to the Product Configuration popup (available for parent-products only);
• Actions - the Remove action link.

To add a product to the rule, click the Add Products button on the top left of the grid. The Select Products popup will appear on the page.

Select the products for the rule using the tick-boxes in the first column of the grid and click the Add Selected Products button on the top right. Bundle, Group and Gift Card products are not supported as promo products.

Should you choose a parent-product, you will later be able to configure it with the help of the Configure active link in the Product grid (see the previous picture). 

The Configure Product popup allows setting the desired size and color of the product. The SKU and price of the configured product will get updated in the Products grid automatically. Click OK to finalize the configuration.

Buy X Get Y

This scenario defines a situation when you want customers to get the Y product for free or with a discount should they get interested in product X.

This is the only block where the frequency of response of the scenario to the rule makes sense. 

• First time - customers will get the promo item or offer only for the first time when the conditions of the rule are met. E.g. A customer receives a promo product only for the first product X, disregarding how many Products X they are buying;
• Every time - customers will get the promo item or offer every time when the conditions are met. E.g. With every Product X a customer can get Product Y;
• Every Nth time- customers will get the promo item or offer every second, third or Nth time. E.g. For every 3 Products X a customer will get 1 Product Y.

To add a condition to the scenario click the green "Cross" button and choose one of the following:

• Product Attribute Combination - opens up the "If an item is FOUND in the cart with ALL of these conditions true" condition and allows selecting a product attribute to define the item;
• Products Subselection - opens up the "If total quantity is ... for a subselection of items in cart matching ALL of these conditions:" and allows selecting a product attribute to define the item;
• Conditions Combination (default condition) - opens up the "If ALL of these conditions are TRUE:" and allows choosing one of the conditions herein.

Use the 'ALL', 'TRUE', 'IS', '...' and other clickable parameters to choose a meaningful variation and shape up the condition to your needs.

To delete a condition click the red "Cross" button.

Spend X Get Y

This scenario defines a situation when you want customers to get the Y product for free or with a discount should the sum in the cart run over $X.

The default condition is the same here. At the same, alongside the product attributes it allows car item attributes and cart attributes to define the condition. 

Buy X get Y Free

This scenario adds an identical (to product Х) free product (Y) to the cart if all conditions of the rule are met.

Please note, that there is no “Popup Settings” section in the rule settings, as the promo product will always be automatically added to the cart when all conditions of the rule are met.

Coupon

This scenario defines a situation when you want (selected) customers to use a predefined coupon at cart to get a discount on the items in it.

The conditions configuration is the same here. The only difference is that the name of the Coupon has to be suggested to make things work.

Popup Settings

This is where you set the parameters for the popup which will bear the promo:

• How to offer promo products - the two alternatives: Show Popup and Auto-add promo product to cart, if possible;
• Text in the Popup Header - the alternative text to the deafult one, indicated in the Settings.

Promo Settings

This block is available only when the "Buy X Get Y" or "Buy X get Y" Free scenario is chosen. This is where you can configure the promo described by the scenario rule.

The block presents the following parameters for set-up:

• Promo Text - the message to reflect the promo call to action;
• Image - the image that will be displayed next to the promo items in the popup;
• Image Alt - the alternate text for an image; 
• Header - the text for the header of the promo popup;
• Description - the brief description of your current promo that your customers will see if they click on the promo image;
• URL - the link to the page you want to redirect your customers to, should they want to read more information on the campaign;
• URL Text - the message to encourage customers to follow the above-mentioned link.

Sample Rules

a) Buy X Get Y - SKU condition

I want to offer discounted Y products or grant complimentary Y ones to the customer who has topped-up his/her cart with one of the X products. The customer may use this promo only once. 

b) For a number of products

I want to offer the Y product with a 30% discount to those customers who have topped up their carts with at least 5 items of the X category.   

M2 Add Free Product to Cart On Frontend

The frontend functionality of the extension is intuitive and does not require customers to configure any settings or carry out any special cart management.

Let's consider the following sample campaign to see the embodiment of the features above on the storefront:

Campaign: Offer the Affirm Water bottle for just 1 USD to customers who intend to buy a Jupiter All-Weather Trainer (of any size and color). Scenario: Buy X Get Y   Rule: Every time the customer adds a Jupiter All-Weather Trainer into the cart, never mind other products there, offer one Affirm Water bottle, and not anything else, for just 1 USD.

In the picture below: Once the product X has been added to cart a gift icon with a numeric '1' appears in the top right corner of the page, next to cart.

Clicking the gift icon or proceeding to the cart, the customer will see a popup with the promo product and supporting information on the offer. The customer will be able to decline the offer or add the product to cart. 

Once the customer adds the promo product to cart, he/she will see in the Cart Summary the subtotal, the discounted price (-$6 in the example, which makes the price of the bottle the target $1) and the total order price.

Scenario: Buy X Get Y  

As of version 1.6.0 merchants are able to display an image of a promo products on the product page. 

FAQ