Affiliate
v1.5.6

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

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 co...

Quick Start

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 ...

Configuration settings

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 Notificat...

Affiliate Dashboard

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 ...

Managing Programs

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 M...

Managing Affiliate Groups

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 defaul...

Managing Accounts

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 -&g...

Issuing Banners

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 cli...

Transactions

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 ...

Withdrawals

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...

Email Notification Templates

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...

Account Additional Fields

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...

Migration from Magento 1 to Magento 2

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 con...

How-To

How-To Contents 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...

How to upgrade the extension

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 installe...

Disabling the Extension

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 mod...

Change Log

Change Log 1.5.6 (2024-12-04) Improvements Clarification for empty commissions 1.5.5 (2024-11-15) Fixed Fixed the issue with the customer-affiliate relation not being acquired Fixed the issue with error when registering a customer in affiliate program...