How to install the extension

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

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

How to upgrade the extension

To upgrade the extension follow these steps:

  1. Backup your store's database and web directory.
  2. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  3. Run command composer update mirasvit/module-affiliate to update the extension sources.
  4. Run command php -f bin/magento module:enable Mirasvit_Core Mirasvit_Affiliate to re-enable the extension.
  5. Run command php -f bin/magento setup:upgrade to install updates.
  6. Run command php -f bin/magento cache:clean to clean the cache.
  7. 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 follow these steps:

  1. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  2. Run the command php -f bin/magento module:disable Mirasvit_Affiliate to disable the extension.
  3. Login in to the Magento back-end and refresh the store cache (if enabled).

Extension Removing

To uninstall the extension please follow theses steps:

  1. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  2. Run the command composer remove mirasvit/module-affiliate to remove the extension.
  3. Login in to the Magento back-end and refresh the store cache (if enabled).

General settings

Go to the Marketing > Affiliates > Settings. You'll find the following settings:

Account

Option Description
Auto Sign Up after create account If option is enabled, affiliate will be automatically logged in after creating their account.
Approval is required If option is enabled, affiliate account will be automatically approved after registration.
Otherwise, you need to approve the account at the Marketing > Affiliates > Account.

Withdrawal Workflow

Option Description
Minimum withdrawal amount Sets affiliate minimum withdrawal amount.

Commission Workflow

Option Description
Add commission when order obtained status Commision will be applied when order receives the selected status.
Subtract commission when order obtained status Commision will be substracted when order receives the selected status(es).
Subtract commission when credit memo is created If option is enabled, commission will be substracted after creating credit memo.
Commission holding period (days) Allows to you to hold the commision transactions within the determined period.

Email Notification Settings

For Affiliates

Option Description
New Account Sends email after creating an affiliate account.
Account has been approved Sends email after affiliate account is approved.
New Transaction Sends email after new affiliate transaction is completed.
Balance has been updated Sends email after affiliate balance is updated.

For Admin

Option Description
New Account Sends email to the admin after creating an affiliate account.

Note

To customize the Email templates, follow the page Email Notification Templates.

Email Notification Templates

Affiliate extension sends emails with different types of notifications to the affiliate and the admin. You can customise the templates of those emails.

To change the extension's email template you need to do following:

  • Go to Marketing > Email Templates.
  • Press the button Add New Template.
  • Select the template in the dropdown list that you would like to customise. The current extension templates are placed at the Mirasvit_Affiliate header.
  • Press the button Load Template.
  • Enter new Template Name.
  • Change Template Subject and Template Content if you need.
  • Press the button Save Template.
  • Go to Marketing > Affiliates > Settings > Email Notification Settings. Select your new template in the dropdown list of necessary notifications.
    Save configuration.

How to disable a Email notification

To disable Email notifications you need to go to Marketing > Affiliates > Settings > Email Notification Settings.
In the dropdown list of necessary notifications select the option Disable these emails. Save the configuration.