Getting Started

Welcome to the Affiliate documentation.

Here, you will find everything you need to set up your Affiliate service and create a vast promotional network, motivating your customers with enticing income potential.

You will be able to launch fully-featured affiliate programs for your store with this extension! There's no need to use third-party services and pay their requisit fees anymore. Drive more sales from alternative channels and let your affiliates earn additional money.

Go ahead, dive in!

Firstly, please find our extension in the My Downloadable Products section of our store. Learn how to install extension, and proceed with Quick Start, which will guide you in setting up your Affiliate service.

How to install the extension

Installation via composer (preferably)

We recommend this installation method because the composer automatically checks and installs necessary dependencies.

Back up your store's database and web directory.
Log in to the SSH console of your server and navigate to the root directory of the Magento 2 store.
Copy the installation instructions from the page My Downloadable Products to the SSH console and press ENTER.
Run the command php -f bin/magento module:enable Mirasvit_Core Mirasvit_Affiliate to enable the extension.
Run the command php -f bin/magento setup:upgrade to install the extension.
Run the command php -f bin/magento cache:clean to clean the cache.
Deploy static view files

rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

Installation via direct file upload

You can also install the extension via direct files uploading.

Go to My Downloadable Products / View & Download.
Unpack the .zip package and copy the contents to the Magento root directory.
Log in to the SSH console of your server and navigate to the Magento root directory.
Run the command php -f bin/magento module:enable Mirasvit_Core Mirasvit_Affiliate to enable the extension.
Run the command php -f bin/magento setup:upgrade to install the extension.
Run the command php -f bin/magento cache:clean to clean the cache.
Deploy static view files

rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

Install the extension for Hyva

Run the command to obtain the Blog MX Hyva component

composer require hyva-themes/magento2-mirasvit-affiliate

Enable the installed Hyva component:

bin/magento module:enable Hyva_MirasvitAffiliate

Update the Magento database schema and data with the command:
```
bin/magento setup:upgrade
```
Compile code to generate the contents of the Magento var/di folder:
```
bin/magento setup:di:compile
```
Run the command below to clean the cache:
```
bin/magento cache:flush
```

Quick Start

Our Affiliate extension comes with a set of pre-defined Programs and basic promotional materials for each customer that will join your promotional network, letting you begin building your Affiliate policy out-of-box.

However, there's more you need to do to create and tune up for maximum flexibility and efficiency of your promotion.

Create a set of attractive Banners, so your Affiliates can spread rich information about your goods and services.
Tune up, or even create new Programs, which will turn commissions into a flexible, motivating engine.
Issue special Coupons for your Affiliates, so they can attract new customers with discounts.
Track all your Transactions and Withdrawal Requests, analyze them, and tune them up for maximum efficiency at Configuration Settings.
Create rich and informative Email Notifications for each action in your workflow to keep your Affiliates aware of their earnings and your staff of customers' requests.
Manage your Affiliate Accounts on a micro-level, building an effective promotional network.
Use our Dashboard to have all critical information available at your fingertips.

This should be a good place to start.

Refer to the appropriate sections of our manual to get more info.

Configuration settings

Settings that allow you to tune-up your Affiliate policy are located at Marketing -> Affiliates -> Settings, and is broken into the following sections:

Account
Commission Workflow
Withdrawal Workflow
Coupons
Email Notification Settings

Account

Option	Description
Auto Sign Up after creating account	If the option is enabled, the affiliate will automatically be signed to the Affiliate program after creating their account.
Approval is required	If the option is disabled, the affiliate account will automatically be approved after registration. Otherwise, you need to manually approve the account at the Marketing > Affiliates > Account.
Links Referral Param	An Additional parameter which should be added to the referral links for inclusion to the affiliate policy.
Display affiliate link only for registered affiliates	If the option is enabled, all customers will see a link to the affiliate section in their personal account.
Additional Fields	A button that leads to the Account Additional Fields page. On this page, custom fields could be added to affiliate account settings (Read more about this here)

Commission Workflow

Option	Description
Add commission when the order has obtained status	Commission will be applied when order receives the selected status.
Subtract commission when the order has obtained status	Commission will be subtracted when order receives the selected status(es). Additional statuses for this and above option can be added at Stores -> Settings -> Order Status.
Subtract commission when credit memo is created	If the option is enabled, the commission will be subtracted after creating a credit memo.
Commission holding period (days)	Allows you to hold the commission transactions within the defined period.
Sales Commission Lifetime (days)	Affiliate will receive commissions from referred customers during this period. By default, commissions expire after 365 days (1 year).
Commissions limit	The limit is universal for all and applies to orders from individual referrals. For instance, there is an affiliate (A) and referrals (R1 and R2). If A has already received the number of commissions from R1's orders equal to the limit, they will no longer receive commissions from R1. However, they will continue to receive commissions from R2 until the same limit is reached.
Assign Priority	Assignment priority for commissions. There are two available options: Assign to first referred affiliate and Assign to last referred affiliate.

Withdrawal Workflow

Option	Description
Minimum withdrawal amount	Sets the affiliate minimum withdrawal amount.
Payment Methods	Allows you to turn on/off different services of money transfer to withdraw commissions. Currently supported services: PayPal. Skrill, Other (e. q. customer-defined).

Coupons

Option	Description
Enable Coupon	Enables the possibility for affiliates to receive coupons for referring friends. This coupon will be displayed at Promotional Materials of Customer Account, and it's unique for each customer.
Coupon Pattern	If the option above is enabled, this option defines regular expression, how these coupons look like. By default, it is AFL-[A-Z]{4} (AFL-UYTR, for example). Read more about regular expressions here.

Email Notification Settings

This section is broken into two collapsible subsections, each of which contains notification settings for Affiliates and Admin Staff. Each option corresponds with an action, on which email notification can be sent, and defines a template that will be used for that email.

If you do not need notification to be sent, set Disable these emails as an appropriate option.

For Affiliates

Option	Description
New Account	Template for notification on creating an affiliate account.
Account has been approved	Template for notification on affiliate account approval.
New Transaction	Template for notification on new affiliate transaction completion.
Balance has been updated	Template for notification on affiliate balance update.

For Admin

Option	Description
New Account	Template for admin notification on creating a new affiliate account.
New Withdrawal Request	Template for admin notification on the new withdrawal request

Note

Read more on email notification templates at Email Notification Templates section.

Affiliate Dashboard

The affiliate Dashboard is a starting point of our extension, which contains the statistical data of the currently defined affiliate policy results. It consists of two panels - Main and Latest Activity.

Main Dashboard Panel

Main Panel contains the Statistics Ribbon, which holds the following result markings:

Active Affiliates - displays the number of customers who have joined your affiliate programs.
Visits - quantity of visits that were made through promotional materials, such as Banners, Referral Links and Coupons.
Revenue - income that your store has earned in total for the last seven days.
Commissions - the amount of money that was earned by your affiliates.
Total Affiliates - displays the total quantity of affiliates who have joined your programs.
Total Ballance - displays the total sum of commissions not withdrawn by affiliates.
Total Withdrawals - displays the total sum of withdrawn commissions.
On hold - displays the total amount of held commissions.

The score table of Most Valuable Affiliates is located under this ribbon, which displays the Affiliates that contributed to your store the most. It provides the following information per row:

Affiliate - name of Affiliate customer.
Total Earning - the total amount of commission, earned by an Affiliate
Clicks - the total number of clicks received by promotional material of the Affiliate.

Note

The score position is based on the total earning amount, so if the customer has gotten many clicks but little income - it will be placed into a secondary position.

Latest Activity Panel

This panel is broken into individual cells, each representing a single Transaction, with the most recent at the top. Each cell contains the following information:

Date of transaction - Human-readable transaction date displayed at the right side in the bottom.
Customer - a highlighted link to the account of a customer that triggered a transaction.
Order - if the customer referred to order, its number will be highlighted and turned into a link.
Transaction summary - a short description of the transactions.
Currency amount -the amount of money earned or withdrawn with the current transaction.

This information is adequate to keep your Affiliate policy at your fingertips.

Managing Programs

Programs are the basic building blocks of your Affiliate policy. Each program represents a method, which customers can use to turn their investment in promotional activity into real money.

All currently defined programs are located at Marketing -> Affiliate -> Programs. There, they can be managed, activated, and removed.

Our extension comes with four basic programs that customers can join:

Pay per Impression - used for banners that customers include to their pages, blogs, or even stores. The commission is generated per unique view of the banner.
Pay per Lead - used for both referral links and other clickable promotional materials that can lead customers to your store. The commission is generated per each unique visit to the store made through a link or banner.
Pay per Click - used for banners and other clickable materials. The commission is generated on a per-click basis.
Pay per Sale - used for orders placed after visiting a store through a referral link or banner. The commission is generated as part of the actual sale.

Each of these basic programs can be modified and fitted to your vision of the Affiliate policy. Moreover, multiple programs of the same type can be active simultaneously, providing you with a highly flexible approach .

How to create a new Affiliate Program

Go to Marketing -> Affiliate -> Programs and press the Add New button. You will be brought to the creation page, which consists of the following several sections:

General Settings

As the main part of the Program setup, this section is always visible, unlike others. It contains the following fields:

Name - an intuitive name for the Program.
Description - description of the Program.
Type - type of Program (see above for details). Each type triggers the appearance of its own additional section with the following tiers:
- Pay per Sale
- Pay per Lead
- Pay per Click
- Pay per Impression
Store Views - determines in which stores this program can be used.
Is Active - determines whether this Program is active, and if customers can use it for generating commission.
Active From - date from which the Program becomes eligible for generating commissions.
Active To - date after which the Program stops generating commissions.
Is Visible - determines whether the Program details will be displayed at the customer's account.
Priority - the priority of the program (affects only Pay per Sale programs). If the orders match more than one program, the program with the highest priority will be used.

Each Affiliate Program allows you to configure commissions for each Affiliate Group created in the extension.

The tiers' definitions are determined in separate sections, which become visible only after the Type selection, and can differ depending on the particular Type.

Conditions

Permits you to apply the commission only to cart items matching the following conditions:

Coupon

This section allows you to choose one of the existing rules from your Marketing -> Promotions -> Cart Price Rules page. You can use configurable rules and offer discounts on specified products only.

Coupons Is Active - determines whether new customers can use the coupon.
Apply Cart Price Rule - determins which Cart Price Rules will be applied when customers purchase a new product. Discounts will only be applied for products specified in the rule. Please note that you need to use “Auto Generation” for your coupon rule.

Pay per Sale Commission

Tiers of this type of program have the following parameters:

Affiliate Group - affiliate group for which the commission is configuring.
Commission Type - is a type of commission that the customer receives on order completion. There are three possible commission types:
- Percent of order amount - the commission is calculated based on the amount of the heretofore paid order total.
- Percent of cart amount - the commission is calculated from the subtotal of products bought, excluding taxes and/or shipping fees.
- Fixed amount - the commission is a fixed monetary amount that drops to the customer account upon order completion.
Commission From First Order - is a value representing either a percent (between 0 and 100), or a fixed monetary amount. This commission will be received only from the first order made by the customer related to the affiliate account.
Commission From Second and More Orders - is a value representing either a percent (between 0 and 100), or a fixed monetary amount. This commission will be received from the second and higher orders made by the customer related to the affiliate account.

In addition, this parameter can optionally be limited by specifying a maximum number of transactions in the settings. This allows you to cap the number of sales eligible for commission, ensuring greater control over the payout structure for affiliates.

Pay per Lead Commission

Tiers of this type of program have the following parameter:

Affiliate Group - affiliate group for which the commission is configuring.
Commission Amount - a fixed monetary amount which drops to the customer account when somebody leads to your store using their promotional materials.

Pay per Click Commission

Tiers of this type of program have the following parameter:

Affiliate Group - affiliate group for which the commission is configuring.
Commission Amount - fixed monetary amount which drops to the customer account when somebody clicks on one of their promotional materials.

Pay per Impression Commission

Tiers of this type of program have the following parameter:

Affiliate Group - affiliate group for which the commission is configuring.
Commission Amount - fixed monetary amount which drops to the customer account when somebody views one of their promotional materials.

Managing Affiliate Groups

Affiliate Groups is a helpful tool that allows you to configure different commissions in Affiliate Programs for affiliates assigned to various groups.
Immediately following installation, the extension provides you with one default affiliate group to which all affiliates will be assigned.

Groups can be one of the following types: manual-updating or automatically-updating group. Automatically-updating groups are updating on cron basis.

How to create a new Affiliate Group

Go to Marketing -> Affiliate -> Affiliate Groups and press the Add New button. You will be brought to the creation page, which consists of several sections:

General Settings

As the main part of the Affiliate Group setup, this section is always visible, unlike others. It contains the following fields:

Name - an intuitive name of the Affiliate Group.
Is Default - the flag to set the group as default. Only one group can be named the default. Only the auto-updating group can be set as default. Conditions will be ignored if the group is set as default.
Update Automatically - determines whether the group should or shouldn't be updated automatically by cron.
Is Hidden In Frontend - determines whether this Affiliate group should or shouldn't be visible on the front of the website. If enabled - this Affiliate Group won't be displayed to visitors of the website.
Description - the field to describe the Affiliate Group for visitors of the website.

Conditions

Visible and affects only for auto-updating groups.

Here you can set rules based on which Affiliates will be assigned to this group. The extension provides the next rules:

Number of orders from referred customers - the number of orders made by customers related to the affiliate account from which the Affiliate has already received commissions.
Sales Amount from referred customers - the total amount of orders made by customers related to the affiliate account from which the Affiliate has already received commissions.

Assigned Affiliates

The table displays Affiliates assigned to the current Affiliate Group. This section provides you with the ability to add Affiliates to the Affiliate Group manually (allowed only for manual-updating Affiliate Groups)

Managing Accounts

Each customer who has joined your Affiliate policy automatically created an account that provides a single place from which his or her progress and involvement can be tracked and viewed.

All of these accounts are located at Marketing -> Affiliate -> Accounts.

Note

You cannot remove a customer from your Affiliate program, but you can either exclude them from your Programs or revoke their approval, thus effectively cutting off their commissions flow.

Working with Affiliate Accounts

Each account managing page consists of four subsections:

General Information - contains base profile of Affiliate.
Transactions - contains a filtered grid, where all their transactions can be viewed
Withdrawals - also contains a filtered grid, with all of their withdrawal requests.
Referred Customers - list of customers who registered on your store using promotional materials of the current Affiliate.

Some of these subsections also contain additional information - follow the respective links above to read more.

General Information

This section contains the Affiliate's profile, with the following fields:

Customer - name and email of the Affiliate.
Affiliate Group - The Affiliate Group to which the Affiliate is assigned. The Affiliate Group can be changed manually only to one of the manually-updating groups or the default group.
Unique Identifier - UID has been generated automatically upon joining your Affiliate policy, and is used in Referral Links.
Status - current status of Affiliate. There are the following possible states:
- Pending - this is the statement that the Affiliate receives when they join your policy, but the settings option Approval is required is set to Yes (Read more about this here)
- Approved - the customer is a part of your Affiliate policy and is eligible to join your Programs.
- Not Approved - the customer is cut off from your Affiliate policy, and stripped from your Programs. Use this option when you need to exclude a customer from your policy.
Referring Website - the website on which the customer wishes to place your promotional materials. This field is added by default but could be disabled or removed at Marketing -> Affiliate -> Additional Fields.
Is Subscribed - indicates whether the customer is subscribed to notifications of the Affiliate policy.
Payment Method - is a method through which withdrawals are made. One of the methods should be selected as defined at the Payment Methods settings option (Read more on this here)
Payment information - determines additional info for payments.
Programs - the checked list of programs to which the current Affiliate is plugged. Use this option if you wish to exclude the customer from one specific Program, but not from the Affiliate policy as a whole.

The General section may also contain additional Custom Fields. These fields could be added and configured at Marketing -> Affiliate -> Additional Fields (Read more about this here)

This section also contains a Statistics table, from which can be seen promotional statistics of the current Affiliate:

Clicks - the number of clicks made on their promotional materials.
Leads - the number of leads to your store that were made by their promotional materials.
Impressions - the number of views there were made on their promotional materials
Sales - sales that were made using materials of this Affiliate (using a coupon, for example).

Coupons

This section contains a Coupons table, on which can be seen a unique coupon code, issued to the Affiliate for each program, that they can give to friends and thus build a promotional chain. To edit an automatically generated coupon, click on the row.

Transactions

This section shows all completed transactions. The extension will update the data by cron.

Withdrawals

This section shows all completed withdrawals. The extension will update the data by cron.

Events

This section shows all completed Events.

Referred Customers

This section is used for tracking how many referral customers of this Affiliate have made. The below statistics display their promotional chain:

Name - name of the referred customer.
Email - email of the referred customer.
Action - last action made by the referred customer.

Note

In some cases, you may wish to include already registered customers in the promotional chain of the current Affiliate.
Press Add Customers to carry it out. A filtered grid of customers will appear on which you can select existing customers in bulk and add them using the Add Selected Customers button.

Issuing Banners

Banners are part of the Promotional Materials which a customer receives upon joining an Affiliate program.

A banner is a promotional graphical image which also acts as a referral link, linked with your store. Our extension records each click and view (impression) of a given banner and collects statistics.

All banners are managed at the Marketing -> Affiliates -> Banners grid, which shows the following information:

Preview - a small thumbnail on the banner image.
Title - the title of the banner.
Type - type of banner (read more below).
Statistics - contains statistic markings of the current banner. Includes:
- Clicks - the quantity of unique clicks on the image.
- Impressions - unique views of the banner.

Banners are currently available to customers who marked Yes in the column Is Active. From the Action column, you can either edit or remove the banner.

To create a new banner, press the Add New button, and you will be brought to the creation page. It consists of the following fields:

Name - the name of the banner
Type - the type of the banner. There are two available types, which are:
- Text - the text link with promotional text.
- Image - the regular image banner.
Is Active - this determines whether this banner is active and available to Affiliates.

Depending on the Type, there can be two additional subsections, which are visible if the corresponding type is selected:

Text section

Contains additional fields for a text-based promotional banner:

Link - the actual link that leads to your banner.
Text -the promotional text that will accompany that link.

Image section

Contains additional fields for regular banner:

Link - the actual link that leads to your banner.
Image - a file uploading widgets, which allows you to upload a banner image of your choice. Only JPEG, GIF, and PNG images allowed.
Width - the preferred width of the banner image (for inclusion to the banner code for the customer)
Height - the preferred height of the banner image (for inclusion to the banner code for the customer)

Transactions

All transactions are located at Marketing -> Affiliate -> Transactions. Each action which is a part of the Affiliate programs will be recorded as a transaction, and not a single one can be removed. If for some reason the balance of the Affiliate is incorrect, you will need to correct it with a Manual Transaction.

Transaction grid provides the following information:

Affiliate - email of customer who has joined your Affiliate policy.
Amount - money amount that was involved in the transaction. It can be both positive and negative.
Type - type of transaction. There are two types available:
- Commission - addition to the customer's balance.
- Withdrawal - transfer from the customer's balance to the external payment system.
Description - short description of the transaction.
Status - status of the transaction. There can be one the following states of transactions present:
- On Hold - can appear when the option Commission holding period is enabled (read more here).
- Completed - the transaction is approved, and changes are applied to the balance.
Created At - date of transaction.

How to make Manual Transactions

Go to Marketing -> Affiliate -> Transactions and press the Add New button. You will be brought to the transaction creation page, which contains just three fields:

Affiliate - drop-down list of customers who have joined your Affiliate policy. You can select only one per manual transaction.
Amount - the amount of money that shall be distributed to the customer.
Message - short transaction description.

Note

You can create manual transactions for both positive and negative currency amounts, though in either case, they will be marked as Commission.

Withdrawals

Withdrawals consist of money transfers from a customer's commission balance to some external payment system. Typically, customers request a withdrawal, but they can also be created manually (although the payment system still needs to be chosen by the customer).

All withdrawal requests are located in their dedicated grid at Marketing -> Affiliate -> Withdrawals, where they are arranged in a grid with the following information:

Affiliate - email of the customer who has joined your Affiliate policy.
Amount - money amount that the customer wishes to transfer to an external payment system.
Fee - surcharge that shall be paid additionally for transfer.
Request date - date on which the customer made a withdrawal request.
Type - current status of the withdrawal. Read more on these statuses below.

How to create manual Withdrawal Request

Go to Marketing -> Affiliate -> Withdrawals, and press the Add New button. You will be brought to request a creation page with the following fields:

Affiliate - a customer that needs to withdraw funds. Only one customer can be selected per request.
Status - status of request. There are four possible states of withdrawals:
- Pending - this status is assigned automatically to each new withdrawal.
- Approved - this status should be set when customers are allowed to chose a payment method and make a transfer.
- Denied - this status is assigned when for some reason, withdrawal is forbidden.
- Completed - this status is assigned automatically when the transfer is made.
Amount - amount of money that should be transferred.
Fee - surcharge that should be paid additionally.

Email Notification Templates

Our extension encourages the sending of email notifications on each key action that an affiliate can perform. You can see their list on Email Notification Settings subsection at Marketing -> Affiliates -> Settings.

Each notification can be sent using its template. It is a standard Magento Transactional Email that can be customized using the default Magento means.

Our extension also adds a set of special variables to the templates that turn emails into flexible notifications.

How to customize Email Notification

If you wish to customize one of the Affiliate Email Notification, please do the following:

Go to Marketing -> Email Templates and press the Add New Template button. You will be brought to the Template creation page.
Use the Template drop-down field to select one of the default Affiliate templates as a base - they are located under the Mirasvit_Affiliate section.
Note
If you wish to customize the notification for a new account creation - you will realize that our extension provides two different templates with the same name - New Account. The first one is the email notification for admin staff and the second is for the affiliate.
Press the Load Template button to automatically fill in the Template Subject and the Template Content fields with default content. Modify them to fit your needs.
Give the template a new Template Name and save the template. From this moment on, it becomes selectable in the configuration section.
Go to Marketing -> Affiliates -> Settings -> Email Notification Settings, pick up the proper event, assign it to your newlycreated template, and save the configuration.

Notification Email Variables

Our extension also provides customers with a list of special variables which can be used for email customizing.

Here is the list of the most used variables (some of them, however, can be used only in specific notifications):

{{var account.getName()}} - name of the current Affiliate
{{var account.getEmail()}} - email of the current Affiliate
{{var account.getPaymentEmail()}} - emails on financial returns, used by the Affiliate for payments.
{{var account.getWebsite()}} - referring website of the current Affiliate
{{var account.getBalance()}} - balance of the current Affiliate. Shorcut {{var balance}} can also be used.
{{var account.getTotalCommissions()}} - total quantity of all commissions, received by the Affiliate.
{{var account.getTotalWithdrawals()}} - total quantity of all withdrawals, made by the Affiliate.
{{var account.getIsSubscribed()}} - returns true or false, with the question of whether the account has a subscription.
{{var status}} - shortcut for account status of current Affiliate (available only in notifications for New Account)
{{var isPending}} - shortcut, which returns true or false, depending on a Pending status of the Affiliate account. Typically used in {{if isPending}} conditionals and available only in the notifications for New Account.
{var transaction.getAmount()} - amount of the current Affiliate transaction. Shortcut {{var amount}} also can be used.
{var transaction.getMessage()} - message which contains details of the transaction (commission or withdraw).
{{var withdraw.getAmount()}} - amount of current withdrawal action, requested by the Affiliate
{{var withdraw.getMessage()}} - message which contains details of Withdrawals requested by Affiliate

Example

You can also use variables in some complex expressions, using a special {{trans}} variable, which is equal to the sprintf function, and allows PHP-like expressions:

{{trans "Greetings, %name," name=$account.getName()}}

Account Additional Fields

Account additional field settings located at Marketing -> Affiliate -> Additional Fields.

This page contains a list of additional account fields, which could be added, changed, or removed. These fields are used on the Sign In to Affiliates and Affiliate Account Settings pages.

Each field record has the next parameters:

Key - index of the name of the additional field. It is submitted with the form as part of a name/value pair.
Label - caption for the field.
Field Type - a type of form control:
- Text - an input field where the user can enter text data.
- Textarea - a multi-line text input control.
- Checkbox - a checkbox allowing single values to be selected/deselected.
- Checkbox Group - checkboxes, allowing several values to be selected from provided options.
- Radio Button Group - radio buttons, let a user select only one from provided options.
- Select - a drop-down menu of options.
Enabled - sets whether the field will be used for Account settings.
Required - sets whether a user must specify a value for the field before the form can be submitted.
Field Placeholder - placeholder text for the field with the "Text" or "Textarea" field type.
Options - list of options for the field with the "Checkbox Group", "Radio Button Group", or "Textarea" field type.
- Option Key - represents the option value to be submitted with the form.
- Option Label - caption for the option.

Migration from Magento 1 to Magento 2

Below are examples of scripts that can be used to transfer data from a Mirasvit Affiliate for Magento 1 to a Mirasvit Affiliate for Magento 2.

To use scripts, you will need the help of a PHP developer. Scripts may contain bugs and not transfer all necessary data, meaning that you may need to adjust them for your needs.

Migration service is not a part of our support service.

Click on the names of scripts below to download:

mirasvit_affiliate_m1_export.php - script for exporting Magestore Affiliate data to XML file.
mirasvit_affiliate_m2_import.php - script for importing Affiliate data from XML file.

How to perform Migration

Follow these steps to perform the migration correctly:

Run standard Magento 2 migration, and make sure that customers and orders have been transferred from your M1 store to M2;
Make sure that the Affiliate for Magento 2 is installed on your M2 store.
Place mirasvit_affiliate_m1_export.php to the root of your M1 store, and run it either:
- From the browser by opening the URL http://store_m1.com/mirasvit_affiliate_m1_export.php, or
- From the SSH/Console: navigate to your store's root and run the command php -f mirasvit_affiliate_m1_export.php
If the script returns success, the file affiliate_export.xml will be created at the root of the store with all of your data. Transfer it to the root of your M2 store;
Place mirasvit_affiliate_m2_import.php to the root of your M2 store, and run it either:
- From the browser by opening the URL http://store_m1.com/mirasvit_affiliate_m2_import.php, or
- From the SSH/Console: navigate to your store's root and run the command php -f mirasvit_affiliate_m2_import.php
Check migrated data.
When the migration is completed, remove both migration scripts.

Troubleshooting

In some cases, the import script can crash on timeout or a memory overloading error (due to large quantities of data). In this case, you should restart the import script by reloading the browser page. It will skip previously uploaded data, and proceed from the last unprocessed record.

How-To

How can I translate affiliate into different languages?

How can I translate an affiliate into different languages

The extension uses the same logic for translations as default Magento. More details: https://devdocs.magento.com/guides/v2.3/frontend-dev-guide/translations/xlate.html)

Our i18n files should be located at: vendor/mirasvit/module-affiliate/src/Affiliate/i18n/

Create a separate file for your language (en_US.csv, de_DE.csv). The names for all languages can be found via this command:

php -f bin/magento info:language:list

Override the strings in your dictionary file:

"Original line" , "Translated line"

Run this command to see the changes:

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

php -f bin/magento cache:flush

The custom themes will be displayed instead of the default for your language.

How to upgrade the extension

To upgrade the extension, follow these steps:

Back up your store's database and web directory.
Log in to the SSH console of your server and navigate to the root directory of the Magento 2 store.
If the extension was installed via:
- Composer: run the command composer require mirasvit/module-affiliate:* --update-with-dependencies to update the current extension with all dependencies.
  Note
  If you have the Hyva installed, run:
```
composer require mirasvit/module-affiliate:* hyva-themes/magento2-mirasvit-affiliate:* --update-with-dependencies
```
  Note
  In some cases, the above command is not applicable, or you cannot upgrade just the current module and need to upgrade all the Mirasvit modules in a bundle. In this case, the above command will have no effect.
  
  Instead, run the composer update mirasvit/* command. It will update all the Mirasvit modules installed in your store.
- Direct file upload: download the new extension package from our store and copy contents to the root Magento directory
Run the command php -f bin/magento module:enable Mirasvit_Core Mirasvit_Affiliate to re-enable the extension.
Note
If you have the Hyva installed, run:
```
      bin/magento module:enable Mirasvit_Core Mirasvit_Affiliate Hyva_MirasvitAffiliate
```
Run the command php -f bin/magento setup:upgrade to install updates.
Run the command php -f bin/magento cache:clean to clean the cache.
Deploy static view files

rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

Disabling the Extension

Temporarily Disable

To temporarily disable the extension, please take the following steps:

Log in to the SSH console of your server and navigate to the root directory of the Magento 2 store.
Run the command php -f bin/magento module:disable Mirasvit_Affiliate to disable the extension.
Note
If you have the Hyva installed, run:
```
      bin/magento module:disable Mirasvit_Affiliate Hyva_MirasvitAffiliate
```
Log in to the Magento backend and refresh the store cache (if enabled).

Extension Removing

To uninstall the extension, please take the following steps:

Log in to the SSH console of your server and navigate to the root directory of the Magento 2 store.
Run the command composer remove mirasvit/module-affiliate to remove the extension.
Note
If you have the Hyva installed, run:
```
          composer remove mirasvit/module-affiliate hyva-themes/magento2-mirasvit-affiliate
```
Log in to the Magento backend and refresh the store cache (if enabled).

Change Log

1.8.3

(2026-03-31)

Fixed

Very small commission amounts (less than $0.01, common in click-based programs) now display correctly with enough decimal places instead of showing $0.00 — affects the Transactions grid, Events grid, and the affiliate account page

1.8.2

(2026-03-27)

Fixed

Fix banner code generation

1.8.1

(2026-03-27)

Fixed

Program sorting
The number of digits after the decimal point for the click program

1.8.0

(2026-03-11)

Features

REST API — full CRUD endpoints for all major entities (accounts, banners, coupons, groups, programs, transactions, withdrawals, referred customers) via Magento REST API

1.7.23

(2026-03-05)

Improvements

Configurable email notifications — send New Affiliate and New Withdrawal admin notifications to any email address, with separate enable/disable toggles, template selection, sender identity, and CC recipients for each notification type

1.7.22

(2026-02-27)

Fixed

Fixed group condition evaluation when using time-period-based rules

1.7.21

(2026-02-20)

Features

Time-based group conditions — evaluate group rules within a specific period (Current Week, Month, Quarter, or Year), enabling automatic group assignment based on affiliate performance over time

1.7.20

(2026-02-06)

Fixed

Fixed commission being incorrectly applied when an affiliate used their own referral code to make a purchase

1.7.19

(2026-01-27)

Fixed

Fixed affiliate account statistics showing only current store data instead of global data across all stores

1.7.18

(2025-12-05)

Fixed

Fixed referral link not recognizing removed customer relations, causing stale referrals to still track
Fixed affiliate conditions (lifetime commission, affiliate client) not checking whether the customer relation was removed

1.7.17

(2025-12-03)

Fixed

Fixed statistics page showing incorrect click counts (was counting sales instead of clicks)
Fixed statistics counts and commission amounts being wrong when zero-commission events were filtered out
⚠️ Replaced deprecated Zend_Db_Expr with Magento\Framework\DB\Sql\Expression in statistics and analytics services

1.7.16

(2025-11-25)

Fixed

Fixed referral link URL being generated incorrectly (produced true/false instead of the actual referral parameter)

1.7.15

(2025-11-21)

Fixed

Fixed HTML escaping issue in the transactions list on the affiliate account page

1.7.14

(2025-11-20)

Fixed

Fixed over-escaping in the affiliate transactions template introduced in 1.7.13

1.7.13

(2025-11-18)

Improvements

Balance and Hold columns — affiliate account form in admin now displays current balance and on-hold amounts with proper currency formatting
Reorganized affiliate account form fields into the Additional Info category for better clarity

Fixed

Fixed Content Security Policy (CSP) violations on pages with inline affiliate scripts
Fixed unescaped output across multiple frontend templates (transactions, programs, promotions, widget, dashboard)
Fixed border appearing around date fields on the statistics page

1.7.12

(2025-11-07)

Improvements

⚠️ Referred customer removal is now a soft delete (is_removed column added to mst_affiliate_account_customer table) — previously deleted relations are now preserved and marked as removed

Fixed

Fixed account statistics not loading when viewing data for all stores
Consolidated Magento 2.4.5-specific JS files (click245.js, widget245.js) into the main JS files

1.7.11

(2025-11-03)

Fixed

Fixed account statistics not working when "All Stores" view was selected

1.7.10

(2025-10-27)

Fixed

Fixed data loss of additional account fields — checkbox and radio inputs had duplicate IDs causing incorrect form submissions
Fixed crash on account edit page when no payment method was selected

1.7.8

(2025-10-24)

Features

Affiliate rules for program conditions — two new conditions: "Is an affiliate" (checks if the ordering customer is an approved affiliate) and "Affiliate client" (checks if the customer is a referred client of an affiliate)

1.7.7

(2025-09-24)

Fixed

Fixed inability to remove all referred customers from an affiliate account at once

1.7.6

(2025-09-23)

Fixed

Fixed new affiliate registration redirecting unauthenticated users incorrectly instead of sending them to the login page

1.7.5

(2025-09-17)

Features

Export to CSV — export affiliate data (name, total earnings, on hold, clicks) from the admin dashboard

1.7.4

(2025-08-29)

Fixed

Fixed RequireJS mixin conflicts that could cause errors on other pages — replaced mixin with a standalone UI component for the withdrawal form

1.7.3

(2025-08-26)

Improvements

Withdrawal balance verification — the withdrawal form now shows available funds and validates that the requested amount (including fee) does not exceed the affiliate's balance

Fixed

Fixed incorrect default store view assignment for CMS blocks during installation

1.7.2

(2025-07-29)

Improvements

Swissup Breeze theme compatibility — added Breeze-specific layout files, JS components, and CSS styles

1.7.1

(2025-06-20)

Improvements

Remote storage compatibility — media file operations now work with remote storage backends (e.g., S3)
Added links to user manual in the admin menu

1.7.0

(2025-06-04)

Improvements

WCAG 2.2 AA compliance — added aria labels, required attributes, proper fieldset legends, unique IDs, and label associations across all frontend forms and pages

Fixed

Fixed AddToAny share buttons not displaying correctly on the product page

1.6.2

(2025-05-23)

Features

AddToAny share buttons — affiliates can share referral links via social media directly from product pages

Fixed

Fixed incorrect layout on the affiliate dashboard page
Fixed error "Call to a member function setBalance() on null" when saving transactions

1.6.1

(2025-05-15)

Fixed

Fixed "Missed phrase" error on affiliate account pages caused by incorrect translation function usage

1.6.0

(2025-05-06)

Improvements

⚠️ Hyva compatibility is now built-in — the separate hyva-themes/magento2-mirasvit-affiliate compatibility module is no longer needed and should be removed

1.5.10

(2025-04-15)

Fixed

Fixed compatibility with PHP 8.4 (updated return type declarations across interfaces and models)

1.5.9

(2025-04-07)

Improvements

Added pagination to the withdrawal list on the affiliate account page

Fixed

Fixed commission not being created for second and subsequent orders from a referred customer

1.5.8

(2025-03-12)

Improvements

Non-affiliate customers who are logged in are now automatically redirected to the affiliate signup page when they try to access affiliate pages
Reorganized and improved all admin configuration field descriptions and groupings for better clarity

1.5.7

(2025-01-22)

Fixed

Fixed slow page load on the Referral Widget caused by an unoptimized bestseller query

1.5.6

(2024-12-04)

Improvements

Commission limit messages are now configurable per program — when the transaction limit is reached, a custom message explains why no commission was earned

1.5.5

(2024-11-15)

Fixed

Fixed customer-affiliate relation not being established when a customer registers through the affiliate flow
Fixed error when registering a customer in the affiliate program from the admin panel

1.5.4

(2024-08-06)

Fixed

Fixed unexpected logout when navigating between affiliate pages

1.5.3

(2024-07-12)

Fixed

Fixed filter by type not working in the withdrawal grid

1.5.2

(2024-06-17)

Fixed

Fixed admin role permissions not being enforced for Account Additional Fields settings

1.5.1

(2024-06-17)

Fixed

Fixed blank affiliate pages when the AdGuard browser extension is installed

1.5.0

(2024-06-11)

Features

Account additional fields — configure custom fields (text, textarea, select, multiselect, file, image) for affiliate registration and account editing, managed from a new admin configuration page

1.4.37

(2024-05-27)

Fixed

Fixed bestsellers not displaying in the referral widget — improved product collection query and added new widget configuration options

1.4.36

(2024-05-20)

Fixed

Fixed error when saving configuration on Magento 2.4.1 and earlier

1.4.35

(2024-05-09)

Improvements

Added support for Mirasvit GDPR extension v1.4

1.4.34

(2024-04-24)

Features

Custom withdrawal payment methods — define custom payment methods for affiliate withdrawals from admin configuration, with configurable fields per method

1.4.33

(2024-03-05)

Fixed

Fixed error page when requesting a non-existent banner URL

1.4.32

(2024-02-26)

Fixed

Fixed empty transaction description in commission records
Added HTML tag validation to all admin forms to prevent markup in text fields

1.4.31

(2024-02-01)

Fixed

Fixed impression statistics not being recorded correctly

1.4.30

(2024-01-18)

Fixed

Fixed commission calculation producing incorrect results in multistore setups

1.4.29

(2023-12-08)

Fixed

Fixed chart not displaying correctly when viewing statistics for all sites
Fixed calendar date picker not working on the statistics page

1.4.28

(2023-11-09)

Fixed

Fixed filtering transactions by status not working in the admin transaction grid

1.4.27

(2023-11-07)

Features

All-sites statistics — view aggregate affiliate performance data across all store views from the statistics page

1.4.26

(2023-10-09)

Fixed

Fixed error on the program editing page when coupons are used and "Use Auto Generation" is disabled in Cart Price Rules
Fixed compatibility with Magento 2.4.6

1.4.25

(2023-09-28)

Fixed

Fixed commission being charged multiple times when email notification sending fails

1.4.24

(2023-09-18)

Features

Commission explanation — view a detailed breakdown of how each commission was calculated via a new modal on the transaction page

Improvements

Added export button for the Referred Customers list in admin

Fixed

Fixed commission calculation failing when "Subtract commission when order has obtained status" setting is empty
Fixed missing block name error when editing Group or Program on Magento Commerce (EE)
⚠️ Renamed program type classes: SaleProgram → Sale, ClickProgram → Click, LeadProgram → Lead, ImpressionProgram → Impression. Added new explain column to the transaction DB table.

1.4.23

(2023-08-03)

Fixed

Fixed status variable not being available in email templates for new affiliate notifications

1.4.22

(2023-08-02)

Improvements

Added total commission amount per customer in the referred customers list
Made the "Referring Website" field optional during affiliate registration

Fixed

Fixed email templates not working with Magento 2.4.4 and later (changed template variable format)
Fixed incorrect visitor IP address detection

1.4.21

(2023-06-20)

Fixed

Fixed commission not being calculated for guest orders when the program has a Customer Group condition

1.4.20

(2023-06-15)

Fixed

Fixed programs with an activity period not being applied correctly when the period was active

1.4.19

(2023-05-12)

Fixed

Fixed "Is Processed" column always showing the same value in the event grid on the account edit page
Fixed inability to remove an affiliate from a group
Fixed click tracking not registering clicks in certain cases

1.4.18

(2023-03-30)

Improvements

Added loading indicator on the Promotion Materials page while the widget preview loads

1.4.17

(2023-03-27)

Fixed

Removed non-functional "Add New" button from the Referred Customers listing

1.4.16

(2023-03-15)

Fixed

Fixed PHP 8.2 compatibility issue with data patch

1.4.15

(2023-03-13)

Fixed

Fixed date filters not working in admin grids for referred customers, transactions, and withdrawals

1.4.14

(2023-03-02)

Fixed

Fixed widget configurator not loading on the Promotion Materials page

1.4.13

(2023-02-16)

Improvements

Added support for Magento 2.4.6

Fixed

Fixed base currency not displaying correctly in admin grids on Magento 2.4.6
Fixed currency shown in the statistics chart not matching the store's base currency
Fixed withdrawal form showing incorrect currency

1.4.12

(2023-02-13)

Improvements

Added option to hide events with zero commission on the affiliate Statistics page

1.4.11

(2023-01-30)

Improvements

Old orders placed before the affiliate module was installed no longer generate retroactive commission transactions

1.4.10

(2023-01-17)

Improvements

Improved statistics page behavior when using calendar date range buttons (Today, Week, Month, etc.)

1.4.9

(2023-01-06)

Fixed

Fixed TypeError crash on the Promotion Materials page when coupon data is missing

1.4.8

(2022-12-29)

Fixed

Fixed error "Return type of ReverseRegex\Generator\Node::offsetExists($key)" during coupon generation — replaced external library with a built-in coupon code generator

1.4.7

(2022-11-14)

Fixed

Fixed category selection being lost when editing Program Conditions

1.4.6

(2022-10-27)

Features

Commission-based affiliate conditions — new rules to apply conditions based on whether an order already has a commission from another program

1.4.5

(2022-10-14)

Fixed

Fixed error when an order contains items whose products have been deleted from the catalog

1.4.4

(2022-08-15)

Improvements

Compatibility with Magento 2.4.5

Fixed

Fixed referrer tracking being lost intermittently during navigation

1.4.3

(2022-06-29)

Fixed

Fixed commission calculation producing incorrect amounts for the Fixed Amount commission type

1.4.2

(2022-06-22)

Fixed

Fixed error when removing a Referred Customer from the account edit page in admin

1.4.1

(2022-06-20)

Improvements

⚠️ Removed db_schema_whitelist.json — no longer needed after migration to declarative schema

1.4.0

(2022-06-07)

Improvements

⚠️ Migrated database schema to Magento declarative schema (db_schema.xml). Removed all legacy InstallSchema, UpgradeSchema, and UpgradeData scripts; replaced with data patches.

1.3.40

(2022-05-03)

Fixed

Fixed sorting not working in the Accounts admin grid
Fixed commission lifetime cookie not being set correctly

1.3.39

(2022-04-19)

Fixed

Fixed commission lifetime cookie expiration not being applied properly

1.3.38

(2022-04-15)

Fixed

Fixed email template variables not rendering correctly in notification emails

1.3.37

(2022-04-13)

Fixed

Fixed email subscription toggle not saving on the affiliate account form

1.3.36

(2022-04-04)

Fixed

Fixed Affiliate Tab link not appearing in the customer account navigation

1.3.35

(2022-03-24)

1.3.34

(2022-01-26)

Features

Scheduled withdrawal requests — automatically create withdrawal requests on a configurable schedule (daily, weekly, monthly) with rounding options

Fixed

Fixed compatibility with Magento 2.4.4
Fixed error in the admin panel when viewing a transaction for a deleted order

1.3.33

(2022-01-14)

Fixed

Fixed error when processing orders that have no associated quote (e.g., orders created via admin or API)

1.3.32

(2022-01-06)

Fixed

Fixed incorrect commission calculation for the Sale program type

1.3.31

(2021-12-24)

Fixed

Fixed wrong affiliate being credited when a customer uses a coupon code belonging to a different affiliate
Fixed slow loading on the program edit page when there are many Cart Price Rules

1.3.30

(2021-10-25)

Fixed

Fixed orphaned commission entries remaining after an affiliate program is deleted

1.3.29

(2021-10-13)

Fixed

Fixed statistics chart crashing when there are gaps (empty periods) in the data

1.3.28

(2021-09-29)

Fixed

Fixed affiliate blocks not rendering on the frontend for newly created accounts

1.3.27

(2021-09-22)

Improvements

Removed third-party scripts from the referral widget — widget now loads without external dependencies

Fixed

Fixed affiliate welcome block not displaying for new visitors
Fixed affiliate group being reset to default when editing an account

1.3.26

(2021-09-03)

Fixed

Fixed TypeError crash on the Promotion Materials page

1.3.25

(2021-08-27)

Features

Statistics charts — visual charts (powered by Chart.js) on the affiliate account statistics page showing performance over time

Improvements

Added event list to the account statistics page
Added pagination to the transaction list on the affiliate account page

1.3.24

(2021-08-11)

Features

Send To Store Credit — transfer affiliate balance to Magento Store Credit directly from the withdrawal management page

1.3.23

(2021-08-09)

Improvements

Added "Active" status column to the programs listing in admin
Added informational message when the Store Credit extension is not installed

1.3.22

(2021-08-06)

Features

Lifetime commission condition — set conditions in sales programs based on the affiliate's total lifetime commission (e.g., increase commission rate after reaching a threshold)

1.3.21

(2021-07-30)

Fixed

Fixed zero-amount transactions being created when no commission should be earned

1.3.20

(2021-07-29)

Fixed

Fixed empty transactions being created for orders that don't match any active affiliate program

1.3.19

(2021-07-27)

Features

Multi-program support — multiple affiliate programs can now apply to the same order, each calculating its own commission independently. Programs with "Stop Processing" enabled will prevent lower-priority programs from applying.

1.3.18

(2021-07-20)

Fixed

Fixed program conditions not evaluating correctly for bundle products

1.3.17

(2021-06-17)

Fixed

Fixed affiliate account not being found when a customer uses a coupon code for referral tracking

1.3.16

(2021-06-17)

Fixed

Fixed guest customer events not being registered for lead tracking programs

1.3.15

(2021-06-17)

Fixed

Fixed commission calculation not accounting for tax when tax-inclusive pricing is enabled

1.3.14

(2021-06-14)

Features

Referred Customers admin page — manage and view all referred customers with a dedicated admin listing
Added configuration option to hide the referred customers list on the affiliate's frontend account page

Fixed

Fixed commission priority not being applied correctly when multiple programs match
Fixed hold functionality not working for pending transactions

1.3.13

(2021-06-03)

Fixed

Fixed sales not being tracked when the customer session is empty (e.g., during async order processing)

1.3.12

(2021-05-25)

Fixed

Fixed impression events not being registered for banner views

1.3.11

(2021-05-21)

Fixed

Fixed affiliate tracking cookie not being set properly in certain browser configurations

1.3.10

(2021-05-20)

Improvements

Added translation files for 40+ locales as starting templates for customization

1.3.9

(2021-05-19)

Fixed

Fixed error occurring after a customer removes a coupon code from their cart

1.3.8

(2021-05-12)

Fixed

Fixed commission being calculated on the full order when only some products match the program conditions — now only matching items are included
Fixed notification emails being sent for zero-commission transactions
Fixed transactions list not displaying on the affiliate account page

1.3.7

(2021-04-02)

Fixed

Fixed admin notification emails not being sent for new affiliate registrations and withdrawal requests

1.3.6

(2021-03-30)

Fixed

Fixed data migration error during upgrade

1.3.5

(2021-03-29)

Fixed

Fixed commission being calculated using order currency instead of base currency when they differ

1.3.4

(2021-03-23)

Fixed

Fixed withdrawal payment methods not displaying on the affiliate account page

1.3.3

(2021-03-23)

Fixed

Fixed error when registering a new lead event
Fixed error on the affiliate account page when transaction data contains null values

1.3.2

(2021-03-22)

Improvements

The account statistics page now shows unique clicks instead of total clicks for more accurate performance tracking

1.3.1

(2021-03-19)

Fixed

Fixed transactions only showing for the current store instead of all stores
Fixed notification email sender name not being set correctly

1.3.0

(2021-03-17)

Features

Affiliate Groups — organize affiliates into groups with automatic assignment rules based on affiliate performance conditions. Includes full admin CRUD, group-based rules engine, and a cron job to automatically reassign affiliates to groups based on their activity.
Tier system — define commission tiers for programs
Transaction export — export transaction data from admin
Programs page — affiliates can view available programs from their account dashboard

Improvements

⚠️ Requires Magento 2.3 or higher (versions below 1.3.0 support Magento 2.1–2.2)
⚠️ Major code refactoring — simplified all data interfaces and models. Added new group DB table and group_id column on the account table.

1.2.3

(2021-02-03)

Fixed

Fixed commission not being calculated for orders where quote_id is 0

1.2.2

(2021-01-12)

Features

Tax inclusion option — configure whether commission is calculated on the order amount including or excluding tax

1.2.1

(2020-12-17)

Fixed

Fixed dashboard crashing when some affiliate accounts had been deleted

1.2.0

(2020-12-10)

Fixed

Fixed commission not being added when order status changes happen rapidly (e.g., via automated fulfillment)

1.1.82

(2020-11-17)

Fixed

Fixed success message not appearing after affiliate sign-in

1.1.81

(2020-10-30)

Fixed

Fixed error when creating or editing programs on Magento 2.4.0

1.1.80

(2020-09-30)

Improvements

Fixed grammar and spelling across all documentation and UI labels

1.1.79

(2020-09-16)

Fixed

Fixed error when saving a coupon with an empty code field

1.1.78

(2020-09-07)

Fixed

Fixed error on the affiliate account edit page after deleting a referred customer
Fixed error on the affiliate account edit page on Magento 2.1

1.1.77

(2020-08-27)

Improvements

Commissions on hold are now displayed separately in the dashboard statistics

Fixed

Fixed not all customers being displayed in the account edit form customer list

1.1.76

(2020-08-07)

Features

Multiple programs with different coupons — use several affiliate programs with different cart price rules and unique coupon codes per program

1.1.75

(2020-07-30)

Improvements

Compatibility with Magento 2.4

Fixed

Fixed transaction list and affiliate balance display issues

1.1.74

(2020-07-23)

Fixed

Fixed affiliate balance not updating correctly after saving a transaction from admin

1.1.72

(2020-07-21)

Fixed

Fixed error when saving a new transaction from the admin panel

1.1.71

(2020-07-16)

Features

Program priority — set the order in which programs are evaluated when multiple programs match
Customer group and store conditions — restrict programs by customer group or store view
Event listing in admin — view all affiliate events with filtering and sorting

Improvements

Added event section to the affiliate account page
Improved referrer tracking reliability across stores

1.1.70

(2020-05-13)

Fixed

Fixed sale program applying commission even when no products match the program rules
Fixed compatibility with Amasty Role Permissions extension

1.1.69

(2020-04-13)

Fixed

Fixed commission not being subtracted when a discounted order is refunded

1.1.68

(2020-03-03)

Fixed

Fixed commission being earned on an affiliate's own sales and clicks
Fixed commission not being subtracted when an order is canceled
Fixed zero-commission activity messages appearing in the dashboard
Fixed repeated sign-in prompts on affiliate pages
Fixed commission not being added after re-enabling a previously disabled program
Fixed SQL error on the affiliate welcome page
Fixed commission not being added for different customers sharing the same IP address
Fixed date incrementing incorrectly on the account statistics page

1.1.67

(2020-01-16)

Fixed

Fixed error when adding or deleting commission tiers
Fixed commission not being subtracted correctly on refund for fixed-amount commissions

1.1.66

(2019-12-12)

Fixed

Fixed sorting by ID in the Add Customers grid
Fixed potential XSS vulnerability in account data and customer input fields

1.1.65

(2019-11-18)

Improvements

Coupon pattern is now validated before use to prevent invalid coupon codes

Fixed

Fixed statistics date ranges not filtering correctly
Fixed modal window conflicts on sites using Bootstrap
Fixed programs being duplicated after saving
Fixed error on the program edit page on Magento 2.1.x

1.1.63

(2019-10-23)

Fixed

Fixed admin listing filters not persisting after page reload

1.1.62

(2019-09-09)

Fixed

Fixed text banner form not loading data when editing

1.1.61

(2019-08-08)

Fixed

Fixed code quality issues flagged by Magento Extension Quality Program

1.1.60

(2019-08-01)

Improvements

Added Store Credit as a withdrawal payment method in the admin backend

1.1.59

(2019-08-01)

Fixed

Fixed cart grand total value used for commission calculation

1.1.58

(2019-07-09)

Fixed

Fixed shipping refunded amount being included in commission calculation for credit memos

1.1.55

(2019-07-01)

Fixed

Fixed credit memo not reducing the affiliate commission correctly

1.1.54

(2019-05-11)

Features

Product-specific commission rules — apply commission only for products matching specific conditions within an order

1.1.53

(2019-05-06)

Fixed

Fixed referral widget iframe links opening inside the iframe instead of the parent window

1.1.50

(2019-05-03)

Fixed

Fixed referral parameter not being appended to product links in the referral widget

1.1.49

(2019-04-01)

Improvements

Account statistics now only include processed orders, giving affiliates a more accurate view of earned commissions

1.1.48

(2019-03-19)

Features

Transaction limit per customer — limit the number of commission transactions per customer-affiliate pair (e.g., commission only for the first order)

1.1.47

(2019-03-14)

Fixed

Fixed customer-affiliate relation timeframe calculation being incorrect

1.1.46

(2019-03-13)

Improvements

Improved products widget layout with flex markup for better responsive display
Added option to hide the affiliate link for customers who are not registered affiliates

Fixed

Fixed unnecessary header and footer appearing in the referral widget
Fixed incorrect title on the affiliate welcome page

1.1.45

(2019-03-07)

Fixed

Fixed validation error when a new customer tries to register as an affiliate during account creation

1.1.44

(2019-03-04)

Improvements

Improved Store Credit extension integration with the withdrawal workflow

1.1.42

(2019-01-23)

Fixed

Fixed "headers already sent" error when displaying banner output
Fixed display issue with the affiliate signup form

1.1.40

(2019-01-16)

Features

Affiliate registration without customer account — allow affiliates to register and operate without requiring a Magento customer account

Fixed

Fixed various stability issues with the registration and authentication flow

1.1.39

(2018-11-29)

Improvements

Compatibility with Magento 2.3

1.1.38

(2018-11-14)

Fixed

Fixed account assignment priorities not being respected when multiple matching methods exist (referral link, coupon, etc.)

1.1.37

(2018-10-16)

Fixed

Fixed notification emails being sent from the wrong store view

1.1.36

(2018-10-10)

Fixed

Fixed sorting by account name not working in the transaction listing

1.1.35

(2018-09-06)

Fixed

Fixed admin session cookie conflict causing issues with affiliate tracking

1.1.34

(2018-08-27)

Fixed

Fixed notification emails not being sent for new affiliate registrations

1.1.33

(2018-08-15)

Fixed

Fixed cron job crashing when a referenced order has been deleted

1.1.32

(2018-07-30)

Fixed

Fixed error when creating a new affiliate program in admin

1.1.31

(2018-07-24)

Features

Register affiliate from admin — create affiliate accounts directly from the customer edit page in the backend

Fixed

Fixed error when saving customer-affiliate relations

1.1.30

(2018-05-23)

Fixed

Fixed compatibility issue with Magento 2.1

1.1.29

(2018-02-26)

Features

Affiliate info on order page — view affiliate details (account, referral source) directly on the order view page in admin

Fixed

Fixed sales not being tracked correctly for certain affiliate-customer combinations

1.1.28

(2018-02-08)

Features

Manual balance adjustment — add custom transactions from admin to manually adjust an affiliate's balance

1.1.27

(2018-02-06)

Features

Delete affiliate accounts — remove affiliate accounts from admin
Enable/disable payment methods — configure which withdrawal payment methods are available to affiliates

1.1.26

(2018-02-06)

Fixed

Fixed commission not being subtracted correctly when an order is refunded

1.1.25

(2018-01-25)

Fixed

Fixed admin user orders being counted as affiliate sales
Fixed fatal error when filtering affiliates by the "Affiliate Since" column

1.1.24

(2018-01-09)

Fixed

Fixed error in the affiliate accounts listing page

1.1.23

(2018-01-04)

Fixed

Fixed sale program not calculating commission correctly

1.1.22

(2018-01-03)

Fixed

Fixed broken review link on the affiliate account page

1.1.21

(2018-01-02)

Fixed

Fixed automatic affiliate signup not working for new customer registrations

1.1.20

(2018-01-02)

Fixed

Fixed Pay Per Click program not tracking clicks correctly

1.1.19

(2017-12-26)

Improvements

Improved programs list display with program type information

1.1.18

(2017-12-26)

Fixed

Fixed interface for assigning programs to affiliates in admin

1.1.17

(2017-12-26)

Features

Account statistics page — affiliates can view their performance statistics (events, commissions) from their account dashboard

1.1.16

(2017-12-20)

Fixed

Fixed error in account service causing affiliate account operations to fail

1.1.15

(2017-12-06)

Improvements

Added English translations for all UI strings

Fixed

Fixed banner images not displaying correctly

1.1.14

(2017-11-20)

Features

Pending account notifications — admin system messages alert when there are pending affiliate accounts or withdrawals waiting for approval
Separate account creation page — dedicated page for new affiliate registration

1.1.13

(2017-11-20)

Fixed

Fixed sale program commission calculation issue

1.1.12

(2017-11-13)

Fixed

Fixed hidden programs still being applied to commission calculations

1.1.11

(2017-11-09)

Fixed

Fixed errors occurring when a customer associated with an affiliate has been deleted
Fixed installation errors on fresh setup

1.1.10

(2017-10-13)

Features

Add referred customers from admin — manually assign customers to an affiliate's referred customers list from the account edit page

1.1.9

(2017-09-27)

Improvements

Compatibility with Magento 2.2

1.1.8

(2017-09-18)

Features

Editable coupon codes — edit affiliate coupon codes directly from the admin account form

1.1.7

(2017-09-11)

Fixed

Fixed payment notification email not being sent after withdrawal approval

1.1.6

(2017-09-01)

Improvements

Improved admin account interface with inline statistics and better transaction display

Fixed

Fixed program amounts not saving correctly

1.1.5

(2017-08-21)

Features

Withdrawal request email — admin receives email notification when an affiliate submits a withdrawal request

1.1.4

(2017-08-21)

Fixed

Fixed notification emails failing to send in certain configurations

1.1.3

(2017-08-10)

Improvements

Removed legacy admin grid and form files after UI component migration in 1.1.0

1.1.2

(2017-07-28)

Fixed

Fixed event processing logic not handling certain event types correctly

1.1.1

(2017-07-27)

Fixed

Fixed error when saving an affiliate account in admin

1.1.0

(2017-07-21)

Features

Commission tiers — define tiered commission rates that increase as affiliates reach higher performance levels
Commission priority — configure which program takes precedence when multiple programs match an order
Referred customers tracking — automatic tracking and display of customer-affiliate relationships

Improvements

⚠️ Complete admin interface rewrite — migrated all grids and forms to Magento UI Components

1.0.10

(2017-06-02)

Fixed

Fixed program ID handling in the referral widget

1.0.8

(2017-05-31)

Features

Custom referral codes — configure unique affiliate identifiers and referral parameter names instead of using system-generated IDs

Fixed

Fixed click events not being registered for certain referral link formats

1.0.7

(2017-05-03)

Fixed

Fixed commission calculation for the "by cart percent" commission type producing incorrect amounts
Fixed possible rendering error on admin pages

1.0.6

(2017-04-19)

Fixed

Fixed error when displaying the programs widget on the frontend

1.0.5

(2017-04-18)

Fixed

Fixed email notifications not being sent for new affiliates and withdrawals

1.0.4

(2017-04-18)

Features

Cart subtotal commission — calculate commission based on the order subtotal (cart total) instead of individual product prices

1.0.3

(2017-04-12)

Features

Coupon-based referrals — use coupon codes as an alternative referral method, automatically linking customers to affiliates when they apply a coupon

Improvements

Added configurable cookie lifetime for referral tracking duration

1.0.2

(2017-02-27)

Fixed

Fixed incorrect file permissions on the media folder preventing banner uploads

1.0.1

(2016-10-18)

Improvements

Removed Font Awesome dependency from frontend styles for faster page loads
Added unique affiliate link display in the admin interface

Fixed

Fixed error when saving affiliate accounts
Fixed issues with the withdrawal process and session handling

1.0.0

(2016-08-01)

Initial release

Getting Started

Go ahead, dive in!

How to install the extension

Installation via composer (preferably)

Installation via direct file upload

Install the extension for Hyva

Quick Start

Configuration settings

Account

Commission Workflow

Withdrawal Workflow

Coupons

Email Notification Settings

For Affiliates

For Admin

Note

Affiliate Dashboard

Main Dashboard Panel

Note

Latest Activity Panel

Managing Programs

How to create a new Affiliate Program

General Settings

Conditions

Coupon

Pay per Sale Commission

Pay per Lead Commission

Pay per Click Commission

Pay per Impression Commission

Managing Affiliate Groups

How to create a new Affiliate Group

General Settings

Conditions

Assigned Affiliates

Managing Accounts

Note

Working with Affiliate Accounts

General Information

Coupons

Transactions

Withdrawals

Events

Referred Customers

Note

Issuing Banners

How to Create New Banner

Text section

Image section

Transactions

How to make Manual Transactions

Note

Withdrawals

How to create manual Withdrawal Request

Email Notification Templates

How to customize Email Notification

Note

Notification Email Variables

Example

Account Additional Fields

Migration from Magento 1 to Magento 2

How to perform Migration

Troubleshooting

How-To

Contents

How can I translate an affiliate into different languages

How to upgrade the extension

Note

Note

Note

Disabling the Extension

Temporarily Disable

Note

Extension Removing

Note

Change Log

1.8.3

Fixed

1.8.2

Fixed

1.8.1