Child pages
  • Refer a Friend - Magento 2
Skip to end of metadata
Go to start of metadata

Icon

Firefox user notice:

Please use a different web browser to view this document.

Sorry for the inconvenience.

Magento 2 Refer a Friend extension allows creating effective customer referral programs beneficial for all the sides, including Magento merchants, brand advocates, and newly attracted customers. The module includes multiple configuration and management options both on backend and frontend that make it possible to tailor programs to particular business needs, track and improve certain program aspects making it even more valuable for all the participants.

Compatibility: Magento Open Source 2.2.X, Magento Commerce 2.2.X

Product Page

Thank you for choosing Aheadworks!


Installing Refer a Friend

Command Line Installation

1. Backup your web directory and store database

2. Download the Refer a Friend installation package

 3. Upload contents of the Refer a Friend installation package to your store root directory

 4. In SSH console of your server navigate to your store root folder:

cd path_to_the_store_root_folder

run:

php -f bin/magento module:enable Aheadworks_Raf

then:

php -f bin/magento setup:upgrade

after:

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

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

Icon

Make sure the installation is done from under the FTP administrator account. Otherwise, make sure to set 775 permissions to the store root directory after the extension is deployed.

Composer Installation

1. Log in to your customer account at https://ecommerce.aheadworks.com and navigate to Account -> Composer access;

2. Configure your store to work with the Aheadworks composer repository:

Add composer repository to composer.json by running:

composer config repositories.aheadworks composer https://dist.aheadworks.com/ in the Magento installation root.

Use a key pair provided as login and pass. You can optionally save them in the global composer auth file.

 3. You can start using AW composer now.

 For extension names, navigate to Account -> Composer access.

 4. Open the root Magento directory on your server and send Composer the following command:

composer require <component-name>:<version>

Note: Use the previously copied component name and version.

 5. Make sure that Composer finished the installation without errors. Flush store cache, log out and log into the backend again.

Installing ShareThis and AddThis

After the extension installation, you can add the AddThis or ShareThis social bookmarking services to your store in order to facilitate the whole process of sharing for your brand advocates.

1. Create your AddThis or ShareThis accounts:

2. Follow the provided instructions to add your site to the services. In case you have one of this services working in your store, there is no need to do anything. The functionality will be engaged automatically.

 3. As soon as everything is set and launched properly, your brand advocates are able to share their individual referral links via the AddThis or ShareThis buttons from their customer accounts and across the entire store.

Getting Around

Business Advantages

The business benefits of the extension are clear and straightforward. It adds new customers and generate more sales, including additional sales made by brand-new customers and purchases from existing ones who act like brand advocates within refer-a-friend programs.

What Makes It Different

In addition to the business advantages brought by the idea of customer referral programs, the module stands out from the bulk of the same solutions with:

  • Rewards available for both brand advocates and new customers;
  • Integration with AddThis and ShareThis;
  • Rules explained in details for brand advocates and Magento staff;
  • Statistics available for individual brand advocates and general data tracking for Magento admins;
  • GDPR compliance (right to be forgotten).

Refer a Friend Frontend Use

Before to offer your customers to take part in the refer-a-friend program you need to configure the extension according to your needs and preferences. The whole process is described in the Backend Configuration section below. When the configuration finished all the eligible shoppers are able to participate quite easily.

Refer a Frind Frontend Interface

Following the process workflow, Refer a Friend offers brand advocates the Referral Program section added to their customer accounts so they could track and manage their referral activity.

The section includes:

  • Detailed refer-a-friend program term explanations, including discounts granted to new customers and rewards provided to brand advocates;
  • Performance statistics, such as the number of invited friends, current reward balance, invitation block, and the checkbox to be notified about new rewards.
Icon

The invitation block allows brand advocates to generate a referral link and use ShareThis or AddThis functionality for effective sharing from the account and even on any website page.

In case if a customer leaves the referral group or is excluded from it by Magento admins, the rewards earned can still be applied but the ability to invite new friends is revoked.

 


Backend Configuration

General Configuration

The Configuration section is the first step to take when you start using the Refer a Friend extension. Please enter it following Stores > Configuration > Aheadworks Extensions > Refer a Friend > Configuration.

The section consists of two blocks: General and Email Options. The General block makes it possible to set up general settings of the extension as follows below.

General

Who Can Invite Friends

This configuration option determines the customers eligible to act as brand advocates. It allows you to avoid abuses of your refer-a-friend programs.

There two options you can choose between: a) All Registered Customers and b) Only Registered Customers with Previous Purchases. This way, only registered customers are allowed to invite friends. If the first option is selected, all the registered visitors with or without purchases may participate. The second option allows only customers with orders to enter the program. Additionally, you can determine the type of orders they should have to fit the requirements.

Customer Groups Which Can Join Referral Program

One more opportunity to shape and finalize the eligible circle of brand advocates is to select them among Magento customer groups. You can do this using the Customer Groups Which Can Join Referral Program configuration option. This way, the groups that do not participate in the program are not distracted with unnecessary tabs in their customer accounts.

Icon

The drop-down selector doesn't contain the 'Not Logged In' group as it is unacceptable in any case.

Order Status to Give a Reward to Advocate

The Order Status to Give a Reward to Advocate option is useful, for example, in the case if you invoice orders outside of Magento but still want to award your brand advocates attracting new customers.

Maximum RAF Discount Which Can Be Applied to Subtotal, %.

Most active brand advocates may earn significant rewards and use them as discounts for their own purchases. So, you can limit its use during the checkout providing the maximum discount allowed per one order.

If Unused, Earned Discount Expires in, days

Use this configuration option in order to motivate brand advocates to actively spend their rewards. The expiration date is calculated since the last positive balance update, so it is updated each time a brand advocate attracts a new customer.

Static Block for Welcome Popup

If you want to facilitate the process of inviting new customers and allow brand advocates to show their attitude towards their friends, you can set up a welcome popup to be displayed for newly attracted visitors. The configuration option makes it possible to determine its content selecting among the Magento static blocks. The popup is not displayed if none of the static blocks are selected.

Send Email Reminder that the Balance Expires in X Days

If you set up expiration terms for brand advocates' rewards, you definitely need to notify them about this. Here, you can determine the moment when these notifications are going to be sent.

Icon

In case if '0' is selected, the reminder is not sent.

Email Options

Email Options allow you to сonfigure the notification system of the extension.

  • Email Sender. Here, you can specify the email address acting as the sender of all email notifications.
  • Email template of Notification About New Friends Reward. This option defines the template to be sent to brand advocates about their new rewards.
  • Expiration Reminder Email Template. Here you can set up the email template notifying brand advocates that their rewards expire soon.
  • Email Template of Notification About Reward Expiration. Finally, the option defines the template for notifications telling brand advocates that their rewards have been expired.
Icon

Refer a Friend is delivered with some default templates. You can use and customize them or add your own ones.

Rules

As soon as the general settings of the extension are configured we can proceed to set refer-a-friend program rules. The main thing is that rules define the rewards earned by brand advocates and the discounts provided for new customers. The Rules section is located along the following path: Marketing > Refer a Friend by Aheadworks > Rules.

Rules Grid

Each refer-a-friend rule is applied to one Magento website. So, in case if you manage one website, the module doesn't display the Rules page and grid. Instead, it redirects your immediately to the rule editing page. But, if you have several websites in one Magento installation, you can create a separate rule for each of them.

The Rules grid contains 4 columns:

  • Rule name. A custom rule name implied to distinguish it from other rules;
  • Rule Status. The column shows whether the rule is enabled or disabled;
  • Website. The website a particular rule is assigned to;
  • Action. The column allows you to delete or edit rule right on the spot.

The Rules grid is a Magento 2 grid so it allows you to sort and filter grid attributes, customize its view, etc. On this page, you can also create a new rule using the Add Rule button.

Rule Editing

The Rule editing page contains the following configuration options:

  • Rule Name. The text field to be filled with a rule name;
  • Rule Status. The drop-down allowing to enable or disable the rule;
  • Website. The multi-selector to assign the rule to a particular Magento website;
  • Apply to Shipping Amount. The toggle switch button that allows you to choose either applying rewards and discounts to shipping charges or not.

Rule Conditions

Rule conditions are provided on the same page in a human-readable form.

  • Customer Registration. First of all, you need to determine whether friends registration is mandatory to get the discount on their first purchase. We offer you to set it mandatory in order to avoid the chance that one customer receives several discounts.
  • Friend Discounts. Next, you need to determine the discount amount and make it either fixed or % of its first order.
  • Brand Advocate Rewards. These rewards are fixed so you need only to determine their amounts.

That's it. The rules are configured. Now their terms are clearly displayed in the customer accounts of brand advocates on the frontend.

Advocates

As soon as the rule configuration is finished, the extension is ready to work and invite new customers. So, the next backend section is mostly intended to provide you with additional options to track and manage the program more consciously.
The Advocates section can be found as follows: Marketing > Refer a Friend by Aheadworks > Advocates.

Advocates Grid

The main page of the section contains the Advocates grid and referral program performance statistics.

The Performance area of the page contains two indicators. Quantity of Orders Made by Friends displays the share of orders made by friends in % out of the total number of orders in the store for last 30 days. Total Amount Made by Friends is the same indicator related to the monetary value of friends' and all website orders.

The Advocates grid comprises the following columns:

  • Advocate Name. Contains customer names;
  • Email. Contains customer emails;
  • Web Site. Displays the web site a customer operates in;
  • Invited Friends, Total. Shows the number of invited friends by this particular customer;
  • Current Balance. Balances of rewards earned by brand advocates;
  • Nearest Expiration Date. Displays the dates of reward expirations.
  • Action. Contains active links to Advocate Information pages.

Advocate Information Page

The Advocate Information Page contains two distinct areas: Summary and Transactions History.

Summary

This area allows you to track the performance of individual brand advocates, including their number of invited friends, current reward balances, and nearest expiration dates.

Transactions History

The Transactions History section area shows the history of all transactions in a dedicated grid. The grid contains the following columns:

  • Date. Displays the date when the transaction occurred;
  • Action. Describes the essentials of the transaction;
  • Amount. Displays balance increments or decrements in green and red accordingly;
  • Comment for Admin. Comments to the transactions available to admins;
  • Reward Balance. The balance available after the transaction.

The same as any Magento grid, this one makes it possible to sort and filter data and customize the view.

The greatest benefit and value brought by this section is that it allows you to manually update particular reward balances. You can use this opportunity in case of order refunds or in order to additionally award particular brand advocates for their prominent achievements. Each such transaction can be accompanied by comments visible to admins only.



Other Features

In addition to the functionality described above, the extension also provides some more benefits for store owners and development teams.

  • GDPR Compliance (Right to erasure)

In order to follow the GDPR requirements, the module erases all refer-a-friend activities in case if a customer profile is deleted.

  • Web API and Unit Tests

The code of the extension is covered by unit tests and includes REST API, so you can test its compatibility and integrate it with other solutions much easier.

 

Product Page

 


You can always find the latest version of the software, full documentation, demos, screenshots and reviews at http://ecommerce.aheadworks.com
License agreement: https://ecommerce.aheadworks.com/end-user-license-agreement/
Contact Us: http://ecommerce.aheadworks.com/contacts/
Copyright © 2018 aheadWorks Co. http://www.aheadworks.com


  • No labels