User Guide of PrestaShop Affiliate program

PrestaShop Affiliate Program: Allow your customers to register as affiliates and earn the reward for referring the customers and purchases made by those customers.

Affiliation program is one of the best tools of marketing to promote your store online. It helps you in generating more traffic to your online store which further leads to increased sales.

NOTE: PrestaShop Affiliate Program module is compatible with PrestaShop multi-store feature.

Affiliate Registration Settings

• Show the “Become Affiliate” checkbox on the account creation form.
• Show or hide the “join as affiliate” tab on the customer account page for customers.
• Show become affiliate popup on store.
• Set time after which popup will display again once canceled by a customer.
• Display the terms and conditions checkbox in the affiliate registration form.
• Automatically or manually approve affiliate requests.

Ways to invite referrals

• Invite referrals via links, anchor tag, social networks, email, voucher, banner, referral code, and QR code.
• Affiliates can share the referral link with friends from category and product page.

Commission Settings

• Configure the commission that affiliates will receive for referral registration.
• Set global, category wise, product wise, and affiliate wise commission.
• Define the priority according to which the commission is assigned to affiliates.
• Set monthly commission for affiliates.
• Assign commission manually to the affiliates.
• Set commission that the affiliate will receive when a visitor clicks on the website.
• Define a range of clicks and commission to be assigned to affiliates when visitors click on the website.
• Select order statuses for assigning commission to affiliates.
• Give commission on discounted products and orders.
• Affiliates can view total commission received, redeemed, referrals registered, commission status, etc right from their accounts.
• View commissions assigned to affiliates and their status from a single tab.
• Approve, cancel, or delete multiple commissions in a few clicks.

Payout/Voucher Settings

• Affiliates can generate the pay out or voucher request from their accounts.
• Set the minimum amount that the affiliate has to redeem.
• Enable the partial use of the voucher and set the minimum amount required to apply the voucher in the cart.
• Restrict vouchers for specific categories.
• View the request generated for vouchers or pay out from the back office.
• Change the status of multiple requests at once.
• View a list of vouchers generated by the affiliates from the back office.
• Affiliates can check the status of the pay out or voucher requests from their accounts.

Affiliate Validity Settings

• Configure the number of days for which the visitor is considered an affiliate’s referral.
• Set the number of days for which the affiliate will receive a commission on referrals’ orders.
• Set the number of times an affiliate will get the commission.
• Configure the number of days after which an affiliate will deactivate on the site.

Referral Voucher Settings

• Enable the partial use of vouchers for referrals.
• Set the minimum purchase a referral has to make to receive a voucher.
• Set the number of vouchers an affiliate can share with referrals.
• Configure the number of times a referral can use the voucher.
• Restrict the use of vouchers for specific categories.

Statistics and Data Export

• View the total commission assigned to affiliates daily, weekly, or monthly.
• View total affiliates registered on the site and their commissions.
• See affiliate commissions according to the event.
• View affiliate wise commission.
• Export the details of affiliates and their commissions in PDF format.

Email Settings

• Send email notification to affiliates for various actions like affiliate request creation, commission assignment, voucher creation, etc.
• Configure various activities of affiliates for which you want to receive email notifications.

Banner Settings

• Add banners that affiliates can use for sharing the link.
• Multiple size types for banners to choose from.

Cashback Configuration

• Add cashback into the wallet of the referrals for placing orders on the store.
• Set the cashback type as a percentage or fixed value.
• Configure the order statuses on which the cashback will be assigned to the referral customers.
• Create a cashback voucher for the customers.
• Set the validity of the voucher and minimum amount required to apply the voucher in the cart.

Please note that for the cashback functionality, you need to install the PrestaShop Customer Wallet module.

• Firstly, go to the module manager in the back office and click on ‘upload a module’.
• After that, drag and drop the module file or select the file from the system.
• In this way, the module installation will be successful.

After the successful installation of the module, a few new tabs get available in the back office.

From these tabs, the admin can configure the module settings, manage affiliates, referrals, commissions, and more.

The module configuration consists of four sections:

1. Default Settings
2. Commission Settings
3. Banner Settings
4. E-mail Settings

Affiliate Registration Settings

Option to join as affiliate during registration

The field lets the admin decide whether he wants to display “become affiliate” option on the customer registration form.

After completing the registration process, a customer can view “My Affiliation Account” on the account page.

While creating an account, if a customer did not select “Become Affiliate” checkbox, then he can complete the affiliate registration by clicking on “Join As Affiliate” tab in customer account.

On clicking the “Join As Affiliate” tab, the affiliate registration form opens on the page where the customer can register as an affiliate.

Affiliate registration for customers

If disabled, then the “Join As Affiliate” option will not be available on the customer account page.

Show become affiliate popup

If enabled by admin, then a popup will appear to the customers where they can register as affiliates.

Also, the admin can set the time after which the popup will display again once canceled by a customer.

Approval of new affiliates

If enabled, then the affiliates get auto-approved. Else, the admin has to manually approve the affiliates from the back office.

The admin can view a list of affiliates registered on the store under the “Affiliate Details” tab.

On clicking the ‘View’ button, the admin gets redirected to customer information page where can see:

• Users referred by affiliate.
• Events for which affiliate has earned commission.
• Pay out/voucher requests generated by affiliate.
• Payment mode selected by affiliate and payment details he provided.

Ask customer for affiliate website and Agree terms and conditions

Enable the options to show website field and terms & conditions link in the affiliate registration form.

Way of affiliate link share

Under this tab, the admin can select the channels through which the affiliate can share the site link with friends.

Ways to invite referrals

The admin can select different ways through which the affiliates can invite referrals to the store.

Front End View

Under Affiliate Account, the affiliate can view various channels through which he can share the site link with his friends.

In the above screenshot, it can be seen that the affiliates can invite referrals by:

• Social media platforms like Facebook, Twitter, and Pinterest.
• Referral code
• QR code
• Voucher
• Email
• Links
• Anchor tag

Share by category page link

If enabled, then the affiliates can share the referral link for the category page with the referrals.

Share by product page link

The option lets the admin show a referral link for the product page. The affiliates can share it with referrals to invite them on the site.

Referral voucher settings

Voucher Validity

A voucher shared by an affiliate with the customer will be valid from the day of affiliate registration till the number of days set by the admin in the voucher validity field.

Suppose the admin has set the validity of the voucher as 30 days.

If a customer has registered as an affiliate on 10/08/2022 and shared a voucher with a referral, then the voucher will be valid till 09/09/2022.

Categories Restriction

The option lets the admin select the categories for which he wants to restrict the use of vouchers.

Front End View

Under Affiliate Account, an affiliate can view the voucher code, the number of vouchers he can share, and how many times a customer can use the voucher.

Affiliate Validity Settings

Days till visitor is consider as affiliate’s referral

Suppose an affiliate has shared a link with the user. The user clicks on the link and registers on the store.

Now, the referral will be active on the store from the day of registration till the number of days set by the admin here.

Days till affiliate get commission on referral’s orders

Once a referral has registered on the store, the affiliate will get commission on referral orders from the day of registration till the number of days set by admin.

If the admin has set 0 in this field, then the affiliate will get commission for an unlimited time period.

Here, unlimited time period means upto the number of days set in “Days till visitor is consider as affiliate’s referral” field.

Let me explain to you these two fields with the help of an example.

If the admin has set 10 days in “Days till visitor is consider as affiliate’s referral” and 0 in “Days till affiliate get commission on referral’s orders”.

Then the referral order commission can be assigned within 10 days of referral registration.

If the admin has set 10 days in “Days till visitor is consider as affiliate’s referral” and 3 in “Days till affiliate get commission on referral’s orders”,.

Then the referral order commission can be assigned within 3 days of referral registration.

Set Cron

Insert the line mentioned under the Affiliate Settings tab in cron tasks manager. The affiliates whose validity is about to expire will be deactivated on the store when the cron runs.

Order Status for Assigning or Canceling Commission

Under this tab, the admin can:

• Select the order statuses for assigning on canceling commission.
• Choose to calculate commission on tax included price of product.
• Allow commission on discounted products or orders.
• Choose to give commission to the affiliates for all the orders placed by referrals.

Under Commission Settings, the admin can set the commission that an affiliate will receive when his referrals register or place orders on the store.

Commission Settings consists of three sections:

1. Order Commission
2. Registration Commission
3. Website Click Commission

Registration Commission

The admin can set a commission that is assigned to the affiliate when a referral registers on the store.

Front End View

When a referral registers on the store via the link shared, the affiliate will receive a commission for the registration.

The affiliate can view the commission under the Summary tab of Affiliate account.

The admin can view details of a referral registered on the store under the Referral Details tab.

Order Commission

The admin can set commission for orders in four ways:

• Global Commission
• Category Wise Commission
• Product Wise Commission
• Affiliate Wise Commission

Global Commission

When a referral places an order, the commission is assigned to the affiliate according to the global value if the commission condition does not fall into other rules.

Front End View

After placing an order, once the status changes to the selected status like ‘Payment Accepted’, the affiliate will get commission.

Category Wise Commission

The admin can select the categories and set the commission that is assigned to the affiliate when a referral places an order for the products of the selected category.

Front End View

Product Wise Commission

Select the product and set the commission that is assigned to the affiliate when a referral places an order for the product.

Front End View

In the above screenshot, we can see the commission assigned to an affiliate for order placed by the referral for the selected product.

Affiliate Wise Commission

The admin can select the affiliates to whom the commission is assigned whenever their referral places an order on the site.

Front End View

Commission Priority

If the commission condition falls into multiple rules, then the commission will be assigned to the affiliate according to the priority set by the admin.

Let’s say, the admin has set the product at highest priority, then category, and then affiliate. Now, if a referral orders a product hummingbird printed t-shirt will fall under the clothes category.

In this case, an affiliate will receive the commission set by the admin for a product.

Monthly commission

The admin can define the sales range and set the commission that affiliates will receive if their referrals place orders whose value lies in the defined range in a month.

Suppose, the admin has set a 5% commission for the sales range $101 – $200.

Now, if the referrals place orders worth $110 in a month, then an affiliate will receive a 5% commission on the 1st of the month when the cron runs.

Also, the admin can set out of range commission that is assigned to the affiliate if order value crosses the defined range. Suppose the admin has set out of range commission as 15%.

Now, if the referrals place orders worth $220 in a month, then an affiliate will get a 15% commission.

Website Click Commission

With this extension, the admin can set the commission that affiliates will receive when a visitor clicks on the website using the link shared via an affiliate.

Fixed Commission Per Unique Click

When a visitor clicks on the link shared with him, the affiliate will receive a commission.

Commission for range

The admin can define the range of clicks and set the commission that an affiliate will receive when the visitors click on the website link.

Suppose the admin has a $3 commission for the website click range 10 – 20. Now, if the 11 different visitors click on the website link, then the affiliate will receive commission.

On every 1st of the month, the cron will execute and affiliate will receive commission.

The admin can view the commission assigned for different events like referral registration, orders, click, etc under the commission details tab.

The admin can view and change the status of the commission.

Bulk Mass Action

The admin can select the commissions and change their status.

Assign Commission Manually

On clicking the assign commission manually button, a form appears on the page. In the form, the admin can:

• Select commission type as general or order.
• Specify the reason.
• Set the commission he wants to assign to the affiliate.
• Select the customer to whom he wants to assign the commission.
• Select the commission state as pending approved on canceled.

Front View

Edit Commission

Once assigned, the admin can change the commission value.

Under this tab, the admin can set the minimum amount that a customer has to redeem and set the redeem type to real money, vouchers, or both.

Front View

Click on the PAY OUT button to generate the pay out request.

Now, the affiliate has to specify the amount he wants to redeem.

After specifying the amount, when the affiliate clicks on the pay out button, a pay out request gets generate. The affiliate can view it under Affiliate Commission Details.

Once generated, the admin can view it under the payment / voucher details tab.

Under the pay out / voucher generate tab, the admin can:

• View the current status of pay out request.
• Change the status of request to pending, approved, or canceled.
• Edit or delete the pay out request.

Front View

The affiliate can view the status of pay out request under affiliate commission details. Also, the affiliate can view the total and redeemed commission.

Total commission – This is the total commission (pending + canceled + approved) i.e. sum of all commissions.

Redeemed commission – This is the total redeemed commission which is paid by the admin.

Pending redeem amount – This is the commission for which the affiliate requested payout but the amount needs to be released from the admin’s side.

Payable commission – This commission needs to be paid to the affiliate once approved by the admin.

Withdrawal Vouchers Configuration

Voucher validity

If the voucher is created using commissions of different validities, then in this case validity of the voucher specified in this field is considered.

Categories restriction

The admin can select the product categories on which the affiliates can apply the voucher.

Generate Voucher

Click on the voucher generate button and specify the amount to generate a voucher.

After entering the amount, click on the generate button. After clicking on the generate button, a voucher request gets create.

Backend View

Click on the edit button to change the status of voucher request.

Front End View

Voucher History

Once approved, the admin can view the voucher under the voucher history tab.

Payment Modes

The admin can add payment mode and transfer the amount to transfer money to the affiliates who have requested for Pay out.

Click on the add payment mode button.

The affiliate can view the payment modes added by the admin under the “Payment Mode” tab of “My Account”.

The settings allow the admin to set the cashback that will be given to the customer (referral) for placing an order on the store.

Note: For adding cashback amount into the customer wallet, the admin has to install the PrestaShop Customer Wallet module.

Order status for cashback

The admin needs to configure the order statuses on which the cashback is added to the customer wallet.

Front End View

When a referral places an order on the store and the status of an order is changed to the selected status, cashback amount gets added to the customer’s wallet.

The admin can also enable the creation of the cashback voucher for the customer.

Highlight

If the voucher is not yet in the cart, it will display in the cart summary.

The admin can add a banner that can be used by affiliates for sharing the link.

Click on the “Add new banner” button.

Dimension size type

Percentage

Set the percentage according to which the banner will adjust.

Once added, the admin can view the banners under Banner Settings.

Configure the activities for which the email notifications will be sent to the admin and customers.

Admin Notifications

The admin can configure the affiliate’s activities for which he wants to receive email notifications.

Customer Notifications

The admin can choose to send email notifications to the affiliates when:

• They create affiliate request.
• Their account gets activate.
• Commission is assigned to them.
• Commission status is changed.
• They create a voucher.
• Their redeem request is approved or canceled.

Under Statistics, the admin can view the total commission assigned to the affiliates, redeemed by the affiliates, referrals, and website hits.

Affiliate Program Stats

Under Affiliate Program Stats, the admin can view:

• Total number of affiliates.
• Number of referrals the affiliates got registered.
• Total Commission assigned to affiliates and redeemed by the affiliates.
• Commission pending of affiliates.
• Total commission canceled of affiliates.
• Website hits.

Commission Type Wise Stats

Under this tab, the admin can view the events for which the commission has been assigned to the affiliates and how much commission is approved, pending, or canceled.

Affiliate Wise Stats

Under this tab, the admin can view:

• Total referrals of an affiliate.
• Total Commission assigned to affiliate and redeemed by an affiliate.
• Commission pending and canceled of an affiliate.
• Total orders placed by affiliate’s referrals.

Under Data Export, the admin can download details of affiliates and their commissions in a PDF format.

Click on the view button.

The admin can download the following details:

• Affiliate details.
• Total referrals.
• Total commission assigned to affiliate.
• Affiliate’s pending commission.
• Total commission canceled.
• Total commission redeemed by an affiliate.

For any kind of technical assistance or query, please raise a ticket at http://webkul.uvdesk.com or send us a mail at support@webkul.com

Also, please explore our PrestaShop development services & vast range of featureful PrestaShop Addons.