Skip to content

Documentation

  1. Home
  2. Docs
  3. Referral Codes
  4. Codes Management

Codes Management

This documentation is for the Referral Codes plugin

Your customers can manage their referral codes themselves. Therefore, it’s totally possible that you’ll never have to manage your users referral codes. However, the plugin provides a full management interface for you to see your referrals activity.

Referral Codes List

Go to Referral Codes → Codes to see the list of your referrals and their codes status. First, let’s review all the columns you can see on the list and detail what information they give you.

List Columns

You will find these columns in the list :

  • User : The referral user. You will find there a link to open the user’s edition page
  • Referral Code : The user’s referral code. You have access to a button to copy the code to your clipboard
  • Standby Amount : If you chose to wait until the referral has generated a certain amount of spending before giving him a reward, you will see the accumulated amount here. Click on the value to see a transactions history.
  • Last converted : The last amount that was converted into a reward. Click on the value to see a transactions history.
  • Total : The total earnings of the referral during the period.
  • Count : The count of referral rewards for the period.
  • Redirection : The page where customers are redirected when they use this referral’s URL. If set, it overrides the default settings.

Information

Regarding the period, you can set it up in the list settings.

Actions

You can perform various actions on referrals and their codes :

  • Add : Click on the Add button under the list to create a new referral code. On the popup, find the user for which you want to create the code and enter the referral code. Save your settings.
  • Edit : On the list, you will see an Action column on the right. Find the user for which you want to edit the code. Click on the 3 dots and click the Edit button. Change the referral code and save your settings.
  • Delete : Like for code edition, you can delete a referral code when you want. Find the user for which you want to edit the code. Click on the 3 dots and click the Delete button.

Bulk Actions

With bulk actions, you can perform actions on several users at a time. Use the list checkboxes to select the users you want and perform one of the following actions :

  • Add/Subtract Standby Amounts : Set an amount that you want to add and click on Apply.
  • Force referral rewards : Use that action if you want to convert the standby amount of a referral into an actual reward. This will generate a reward even if the referral didn’t reach the minimum conversion amount.
  • Reset standby amounts : If you use this action, the standby amount of the referral will get back to 0.

List Settings

In the list settings, you can change what information you want to see in the codes list. To better understand the 2 options available, we’ll use some examples. By default, the referral codes list show an history from the first ever transaction to this day.

However, you may want to see periodical information instead of global information. In order to do this, you have 2 options :

  • Covered Period : The period you want to observe.
  • Reference date : If you set it, it will serve as a base reference for periods

Let’s take 3 examples that will demonstrate how this works

Information

In the following example, we’ll consider the year 2022. You start your referrals program on January first and your main referral, Vito Corleone, brings one referee order of $100 every first day of the month.

 

Example 1

You look at the referral codes list on October 10, 2022. The List settings are as follows :

  • Covered Period : Empty
  • Reference date : Empty

As a result, for Vito, you’ll see a Total column value of $1.000 and a Count value of 10 which corresponds to all referees orders placed since you started the program.

 

Example 2

You look at the referral codes list on October 10, 2022. The List settings are as follows :

  • Covered Period : 3 Months
  • Reference date : Empty

As a result, for Vito, you’ll see a Total column value of $300 and a Count value of 3 which corresponds to all referees orders placed in the last 3 months.

 

Example 3

You look at the referral codes list on October 10, 2022. The List settings are as follows :

  • Covered Period : 3 Months
  • Reference date : 2021-01-01

As a result, for Vito, you’ll see a Total column value of $100 and a Count value of 1 which corresponds to all referees orders placed in the current quarter. The first period was from 2021-01-01 to 2021-03-31. The second period was from 2021-04-01 to 2021-06-30 and so on. On october 10, you’re looking at the period that runs between 2021-09-01 and 2021-12-31.

Scroll To Top