Settings

This documentation is for the Referral Codes plugin

After the plugin installation, it’s time to set up the referral codes. First, we’ll set up the rewards for referrals and referees. Secondly, we’ll add the necessary tools in the website frontend for customers to use the codes.

Referral Reward

When a customer uses a referral code to place an order, the order will count towards the referral’s reward. You can choose to reward the referral every time referees place an order or wait until referees spend a certain amount.

Reward Options

Here are the options you have access to and how to use them. Go and edit the Referral Reward group in the Settings page.

• Enabled : Check this box if you want to reward the referral when a referee uses his/her code. If you use another plugin like WooRewards or WooVIP, you may want to keep this off. More details about this in the Play Together part of the documentation.
• Reward Type : Select the type of reward the referral will get between the following options
  • Coupon : A WooCommerce coupon. This is the default reward type.
  • Wallet Money : Only available if you have the WooVirtualWallet plugin.
• Behavior : This option will decide the referral reward’s amount.
  • Fix amount : The reward is a fix amount discount coupon. It doesn’t depend on the amount of money referees spend.
  • Percent of cart subtotal : The reward value will depend on the referee’s order subtotal. Subtotal is the order amount before tcoupons, taxes and shipping fees.
  • Percent of cart total : The reward value will be based on the referee’s order total. Total is the order amount after the coupons, taxes and shipping fees.
• Value : The reward’s value. This value is directly connected to the behavior option above. For example, if you set a value of 10 and a behavior “Percent of cart subtotal”, the reward’s amount will be 10% of the referee’s cart subtotal.
• Referee min. spent amount : The minimum amount a referee must spend in his order for the referral to be rewarded.
• Minimal unlockable amount : Referees must have spent at least that amount in their orders for the referral to get his reward.
• Order statuses to grant rewards : Select the referees order statuses that will count towards the referral’s reward.
• Order statuses to cancel rewards : Select the referees order statuses that will subtract the previously earned credit from the referral’s reward.

Reward Tips

If you want referrals to get a reward every time a referee places an order, leave the Minimal unlockable amount value to 0. Otherwise, every time a referee spends money, the order’s amount will count towards the minimal unlockable amount. Until the amount is reached, the money spent by referees will increase the referral’s standby amount. When the minimal unlockable amount has been reached, the referral’s reward will be generated.

Referee Reward

The referee’s reward is different from the referral’s one. The referee’s reward is created immediately after using a referral code and applied right away.

Here are the options you have access to and how to use them. Go and edit the Referee Reward group in the Settings page.

• Enable : Check this box if you want to reward the referee when he/she uses a code. If you enable it, the reward will automatically apply to the cart if it meets the condition.
• Mode : Select the reward type between the following options
  • Fix Amount : A WooCommerce fixed amount discount coupon.
  • Percent : A WooCommerce percentage discount coupon.
• Value : The reward’s value. This value is directly connected to the mode option above. For example, if you set a value of 10 and the percent mode, the reward’s amount will be 10% of the referee’s cart subtotal.
• Minimum Spend : For the reward to be applied, the referee’s cart must be above that value.
• Individual Use Only : If set, the referee’s reward can’t be used with any other coupon.

Code Restrictions

You can apply some extra rules to referral codes. We’ll detail here the different rules.

• Role restriction : This option lets you specify which customers can have and share a referral code.
• Forbidden codes : Referrals can edit their codes like they want. However, you can choose to stop them from using certain words. Enter the forbidden words in that area.
• Forbids existing slugs as code : In addition to forbidden words, prevents the use of your wordpress pages urls as codes.
• Prevent steals of identity : If you check this box, referrals can’t use names, nicknames or user logins of other users as a referral code.

Referral URL

Your referrals and influencers can get a direct URL that they can share with their audience. If they share this URL, people who visit it won’t have to enter the referral code, it will be automatically applied.

• Get Referral Code in URL : Enable this to let referrals share a link that looks like yoursite.test/referral_code.
• Redirect to this URL : If visitors use the referral URL, they will get to this URL once the referral code has been processed. In addition, you can override this value for each referral.

Frontend Display

Now that you’ve set the rewards, it’s time to display the relevant information to your customers. To that end, you should begin by displaying the referral code field on the cart and the checkout page. In order to do that, go to Referral Codes → Appearance  → WooCommerce. Once there, use the first group of options Referral Code Form.

Here are the options at your disposal :

• Cart Display : Select where you want to display the referral code form on the cart page.
• Reload cart page : In some cases, the referral code might not apply directly. If it happens, check this box to force the page reload to apply the code.
• Checkout Display : Select where you want to display the referral code form on the checkout page.
• Reload checkout page : In some cases, the referral code might not apply directly. If it happens, check this box to force the page reload to apply the code.
• Deny guests : Check this box if you don’t want guest visitors to use referral code.
• Usable only once : If you check the deny guests, you can prevent the same customer from using a referral code twice.
• Styling tool : By default, the input field will be adapted to your theme. However, you can override that and apply your own styles with the provided styling tool.

The My Account page

When you install and activate Referral Codes, the plugin creates a new WordPress “Referral” page. It also fills this page with some shortcodes to display referral content such as the referral code edition and the referral code history.

In addition, you can change some other options and customize the page like you want. To edit these options, go to Referral Codes → Appearance  → WooCommerce. Once there, use the group of options WooCommerce My Account.

You will find the following options :

• Enable : Select if you want to display a referral code tab in the My Account page
• Tab title : Enter the title of the page in the tab menu
• Slug : This will change the page’s url
• Role restriction : Select which user roles have access to this tab. As a result, only people with one of the selected roles will get the possibility to see, use and edit their referral code
• Content page : Decide which WordPress page will show.

In addition, you will find a direct link to edit the page you chose.

Referral reward email

Lastly, you should customize the email that the plugin will send to your referrals when they receive a reward.

Go to Referral Codes → Appearance → Emails and take a look at the options available :

• Header picture : Choose the image to display above the email. Likely, this will show your store’s logo. You should make it 600 pixels wide.
• Footer text : Enter a text to display under the email’s content. You should add a link to your website in this part.
• Subject : The email’s subject.
• Preheader : A small text that users will see under the email’s title before they open the email.
• Enable email sending : Choose if you want to send the email to referrals when they get a reward or not.
• Styling tool : Use the styling tool to customize the email’s content and adapt it to your needs.