Affiliate Pro User Guide

From MageWorld Wiki
(Redirected from AffiliatePro-user-guide)
Jump to: navigation, search

Contents

Configuration

Go to System => Configurations => Mage World => Affiliate (or Affiliate Pro => Configurations) to configure the module.

General Settings

caption
  • In the Enable Affiliate Pro field, select ‘Yes’ to enable the module.

New Affiliate

  • In the Auto sign up new registered customers to Affiliate Program field, if you select ‘Yes’, the affiliate registration form will not appear at the “Create an account” page and when a customer creates an account on your site, he will be automatically assigned as an affiliate.
  • In the Extend default customer registration form to allow sign up box for Affiliate program field, select ‘Yes’ to overwrite the default registration form. Then, one section for Affiliate signup will be shown on the Create an account Page. Please be aware that if any other module overwrote the registration form, a confliction might appear.
  • In the Enable customer to voluntarily sign up for affiliate program on default customer registration form field, select one of the three values (Disable, Enable/signup check box, Enable/signup form/Enable).
  • In the Auto approve Affiliate registration field, select ‘Yes’ to automatically approve the affiliate registration. In case of No, the administrator has to go to Affiliate Pro=>Manage Members=> Pending Members to approve the registration manually.
  • In the Assign affiliate to group when registration auto-approved field, you can select a group. If you choose to automatically approve the registration, after registering, the affiliate will belong to the group that you have defined here.
  • In the Length of the manual referral code (set # of characters) field, specify the number of characters of referral code.

Customers

caption
  • In the Show manual affiliate referral code field on extended customer registration form field, select ‘Yes’ to display the referral code box on signing up for a new account. That is used for customers when creating an account (not for an Affiliate).
  • In the Extend shopping cart page to allow Affiliates to enter credit field, select ‘Yes’ to overwrite the shopping cart page.
  • In the Show manual referral code block on extended shopping cart page field, select ‘Yes’ to allow customers to insert the referral code at the shopping cart page.
  • In the Reassign customer to new affiliate when they use new manual referral code field, select ‘Yes’ or No. In case of Yes, if a customer enters a new referral code, the system will change the parent affiliate of this customer to a new Affiliate who has that new referral code and update referral information.
  • In the Do not display 'Share this page' link on following pages field, insert the page that you don’t want customers to share. The selected page will not have the Share this page link in the footer.

Frontend overview

Create an account page

caption

Footer

caption

Shopping cart

caption

Manage Affiliate Commission and Customer Discount

caption
  • In the Program Executing Priority field, select one of the three values (By maximum commission/By maximum discount/By priority).
  • In the Calculate affiliate commission field, select one of the two values (Before discount or After discount). This field allows you to calculate affiliate discount and commission before or after Magento promotional discount.
  • In the Include taxes when calculating Affiliate commission field, select ‘Yes’ if you count affiliate commission and discount with tax.
  • In the Apply discount and commission for affiliates when they purchase themselves field, select ‘Yes’ to allow affiliates to receive discount and commission when they purchase products.
  • In the Add commission to account balance when order status is field, you can select an order status. The Default is “complete”, which means if an order is completed, the commission will be added to Affiliate account balance.
  • In the Auto-subtract commission in case of customer refund field, select ‘Yes’ to automatically subtract commission when the order is refunded.
  • In the Reverse commission from account balance when order status is field, you can select an order status. Then, when the order within affiliate commission is turned to this status, the system will automatically subtract commission that has been added before from affiliate balance.
  • In the Hold commission in a number of days field, define the number of days to hold back affiliate’s commission.
  • In the Commission for referral visitor field, Admin can set the amount of commission for referral visitor. For example: Affiliate A will get commission, if any visitor goes to the store via this Affiliate’s link.
  • In the Commission for referral sign-up field, Admin can set the amount of commission for referral sign-up. When a visitor goes to your store and sign-up an account via the link of Affiliate A then Affiliate A will get commission.
  • In the Commission for referral subscribe field, Admin can also set the amount of commission for referral subscribe (signup for newsletter).

Manage Affiliate Withdrawal Requests

caption
  • In the Enable Affiliate Withdrawal field, select ‘Yes’ to enable or ‘No’ to disable affiliate withdrawal.
  • In the Payment Method field, click the button “Add payment method” to add payment methods on your site, insert information for Payment Method Code, Payment Method Title, Payment Processing Fee. In the Payment Processing Fee field, insert an amount of money as the payment processing fee for every withdrawal. For each payment method, admin can set different payment processing fee. In the Enable Frontend field, select ‘Yes’ to show or select ‘No’ to hide the payment method on the frontend.
  • In the Minimum Withdrawal Amount and Maximum Withdrawal Amount field, insert the minimum and maximum amount of money that you allow affiliates to withdraw.
  • In the Withdrawal Period field, select weekly or monthly.
  • Withdrawal processing day: In the Withdrawal Period field, if you select Weekly option, the Withdraw processing day field will show weekly days to select, if you select Monthly option, it will show monthly dates for selecting. This is applied for automatic withdrawal option.

Affiliate- Customer Invitation

caption
  • In the Use Affiliate's email address when sending invitations to friends in 'My invitations' or with link on product and category pages field, select ‘Yes’ to show affiliate emails when an affiliate sends an invitation to his friends. If No, the system will use the value of the Email Sender (who reply emails will be sent to if affiliate does NOT use own email return address above) field.
  • The Email Template For Recipients field manages email templates that are used by an affiliate to invite friends.
  • In the 'Referred but unregistered Customer' Cookie to expire in (set # of days) field, insert a number of days. This is the valid period of referral links – it is activated from the time that a customer clicks on the link. When an affiliate invites a customer and this customer clicks on the referral link, in the valid period (number of days in Affiliate Cookie Times), he will be recorded as referred by this affiliate for next visits or purchases.

Affiliate – Widget

caption
  • Widget width : Enter the width of Widget
  • Widget title : Enter the title for widget, the title will be shown on widget at the frontend
  • Widget product quantity : Specify the quantity of products which are displayed on widget

Affiliate – Paypal

caption

Shop Owner will enter the information about Paypal Bussiness at here. When an affiliate requests withdrawal by Paypal method, he can withdrawfrom this Paypal account.

  • Enable Automatic Withdraw By Paypal: Select Yes or No to active or inactive this feature.
  • Enter the information of Paypal including API Username, API Password, API Signature, API Endpoint, Paypal Notification Subject, Paypal Notification Note.
  • Paypal Balance Minimum (When the balance is lower than this number, an email will be sent to notification email below)
  • Notification Email When Paypal Account Balance Is Low, insert an email address that a notification email will be sent to when Paypal balance reaches the value at Paypal Balance Minimum field.

Admin Email Notification Template

The admin notification template tab manages notification emails for the administration.
The module supports multiple comma-separated email addresses.

caption

Affiliate Email Notification Templates

caption

These fields allow the admin to choose email senders and email templates for referral. Sample templates are available (choose default ones).
The affiliate system will notify Affiliate members of balance changes, new programs, referral account’s status and more.
You can view and edit sample templates by going to app\locale\en_US\template\email\mw_affiliate

Manage programs

The Manage Affiliate Program menu allows you to create marketing campaigns that decide the commission and discount rule.

Add a new program

Go to Affiliate Pro => Manage Programs, and click the button Add Program.
Basically, a program has general information, conditions, actions, assigned Affiliate groups and program transactions.

Program details

caption
  • In the Notify affiliate via email field, tick the checkbox to notify affiliates of the program.
  • Define program name, description, store view, priority for the program.
  • In the Status field, select Enabled to activate the program.
  • In the Start Date and End Date fields, insert the active time for the program. The system will automatically close the program when it reaches the expiration date.
  • The Total Members field reports the number of affiliates of the program
  • The Total Commission field reports the total amount of the commission.

Conditions
The Conditions tab allows you to set rules for the program, which is designed based on Magento shopping cart rules.

caption

Affiliate Commission/ Customer Discount

The Affiliate Commission/ Customer Discount tab allows you to define commission and discount for the program.

caption

Use the Affiliate will earn commission on individual cart items if they meet the following conditions tab if you want to narrow the conditions. This means that the items in shopping cart not only have to satisfy condition at Conditions tab, but also meet the conditions you define here.

Add Group

The Add Group tab allows you to assign the program to specific affiliate groups. Click the button reset filter and select groups.

caption

Program Transaction

Program transaction shows a list which includes the information of transaction time, product name, affiliate account (who received commission), order number, product value, product commission, discount and status. If the status is complete, the commission will be added to the affiliate balance.

caption

Manage Affiliate

To manage affiliate members and approve new ones, please go to Affiliate Pro => Manage Affiliate This menu includes 3 tabs: Active Affiliate, Pending Affiliates and All customers.

Active Affiliates

The active affiliates tab lists all active affiliates; you can click one to view details.
The administrator can lock affiliate accounts here. If an affiliate account is locked, he will no longer receive commission and discount as well as use affiliate functions till this account is unlocked.

caption

View an active affiliate

The affiliate member information page lists all information that relates to affiliates such as general, credit balance, history of credit, invitation, withdrawal, and so on.
General Information tab stores the information of affiliate account, payment method, referral code, affiliate parent, payment method, withdrawal notice email, withdrawal method and reports current balance, total amount of received commission and total amount paid out.

caption

Manual Adjustment/Payout tab

In the Manual Adjustment field, the administrator can add or subtract affiliate balance manually.
In the Manual Payout field, the administrator can insert an amount of money. This amount will be considered as a completed withdrawal of the affiliate. This field is used when the administrator wants to pay directly for the affiliate and the system will update affiliate’s current balance and the Total Paid Out field in the General Information tab.

caption

Transaction History tab shows a list which includes the information of Transaction Time, Type of Transactions, Transaction Detail, Amount (Add or subtract credit for each event) and Balance.

caption

Invitation History tab shows the information about Invitation Time, Customer Email Address, Ip Address, Status (type of referral).

caption

Withdrawal History tab shows the transactions of withdrawal including withdrawal Time, Withdrawal Amount, Payment Processing Fee, Net Amount (After calculating payment processing fee) and status (pending or complete). Admin can also choose a withdrawal transaction and change its status at the Actions box.

caption

Commission History tab lists all transactions related to affiliate’s commission.

caption

Affiliate Programs tab shows all programs that affiliate joined in, however only 1 affiliate program with highest priority is applied for this affiliate.

caption

Affiliate Websites tab shows the information of Affiliate’s website.

caption

Affiliate Network tab lists all sub-levels of Affiliate.

caption

Pending Affiliates

If you don’t set to automatically approve the affiliate registration (in configuration), when a customer signs up for the affiliate system, his information will be listed in this page. Then, the administrator can choose to approve or not to approve pending members by selecting members and changing their status at the Actions box.

caption

All Customers

Customers page lists all customers on your site.
You can change the affiliate parent here, applying for both general customers and affiliates. Select customers, choose to change the Affiliate parent at the Actions box, insert the affiliate parent’s email to the Affiliate parent field, and click Submit.

caption

Manage Affiliate Groups

To manage affiliate groups, please go to Affiliate Pro => Manage Affiliate Groups.

Add a new group

Click the button Add Group; you will see the affiliate group information page which has three tabs: general information, programs and members.

General information

caption
  • In the Group Name field, define a name for the group.
  • In the Maximum number of days affiliate will earn commission from new referral field, specify a number of days.
  • In the Maximum numbers of orders affiliate will earn commission from new referral field, specify a number of orders.
  • In the Maximum commission affiliate will earn from each referral field, specify an amount of money. If you insert $50 for example, consider the case that Affiliate A invites customer B. The customer B places orders that brings the affiliate A an amount of commission. If this amount reaches $50, the Affiliate A will not receive any more commission from customer B’s next orders.

Programs

  • Assign the group for available programs at the Programs tab.

Members

  • Select members that belong to the group at the Members tab.

Manage Banners

You can create an affiliate banner by going to Affiliate Pro => Manage Banners.
A banner can be visible on specific store views, assigned to specific links and affiliate groups.
In the Members tab, you can assign the banner for specific affiliates.

caption

Manage Affiliate Websites

This page shows the information about all affiliates websites including Customer Email, Website and status (verified or not verified).

caption

Manage Withdrawals

This menu includes Pending Withdrawals and All Withdrawals
You can change the transaction status of any withdrawal manually.
You can export withdrawal transactions to CSV or XML file.

caption
caption

View All Transactions

Commission history

The Affiliate history tab provides a general look of all Affiliate commission and discount statistics.
Click on View to see details

caption

This page allows admin to change the commission status of orders (commission status, not related to the order status).
There are two ways to change this status: change by action (tick orders, then change the status at the action box) or Update Affiliate transaction via CSV (click on this button, then upload CSV file).
Sample CSV file (note the order ID that you want to change):

caption

Transaction History

The Transaction history tab lists all information that relates to balance change (including time, affiliate email, transaction type, changing amount, end balance).

caption

Affiliate Reports

The Affiliate Pro module supports you to manage Affiliate statistics at Affiliate Pro => Affiliate Reports.
Affiliate Reports tab includes 4 sub-tabs: Overview, Affiliate Sales, Affiliate Invitation, and Affiliate Website(s)

caption

Overview

The report can be shown in different time ranges “Last 24h, Last week, Last month, Last 7 days, Last 30 days or Custom”

caption

In the dropdown of Date Range field, select one of the predefined periods for report data aggregating:

- Last 24h
- Last week
- Last month
- Last 7 days
- Last 30 days
- Custom
=> Click on the Refresh button to view reports
+ Line Chart shows total sales that are generated by Affiliates, total commission of Affiliates and total amount of discount in chosen time range.
+ Pie Chart (Sales by Programs) presents percentages of sales by each affiliate program in chosen time range.
+ Pie Chart (Commission by Programs) presents percentages of commission by each affiliate program in chosen time range (for the type of commission come from referrals such as: referral visitor, referral sign-up, referral subscribe, those type of commission will belong to non-program group)
+ “Statistics” box on the right side shows: Total sales, total orders, total commission, total withdrawals (withdrawal status is complete), total withdrawal fees, total transactions, average commission per order, average commission per affiliate, average order value and total affiliate.
+ “Top Affiliate by Sales” box on the right side shows 10 top affiliates who have highest sales.

Affiliate Sales

In the From and To fields, you use calendar icon to specify the starting and ending dates of the period for report data aggregating.

Select types of showing by Day, Month, and Year in dropdown of the Show By field.
+ Click on the Refresh button to view detailed information about Affiliate account, # of customers referred, # of order, # of sales items, total sales, total commission, total referred customer discount.

caption

In the Export to field, you can select the CSV or Excel option and click on the Export button to export the report information.

Affiliate Invitation

In the From and To fields, you can use calendar icon to specify the starting and ending dates of the period for report data aggregating.
Select type of showing by Day, Month, and Year in dropdown of the Show By field.
Click on the Refresh button to view detail information about: Affiliate account, # of clicks, # of new accounts, and # of purchases

caption

Select the CSV or Excel option and click on the Export button to export the report information, in the Export to field.

Affiliate Website(s)

In the From and To fields, you can use calendar icon to specify the starting and ending dates of the period for report data aggregating.
Select type of showing by Day, Month, and Year in dropdown of the Show By field.
Click on the Refresh button to view detail information about: Affiliate website, # of clicks, # of new accounts, # of purchases

caption

Select the CSV or Excel option and click on the Export button to export the report information, in the Export to field.

Sample order with affiliate information:

caption

Affiliate Registration Link

This module provides a registration link for the admin and he can place this link anywhere on site. Please add the following direction after your site address affiliate/accountnew/createaffiliate

For example:

http://www.mage-world.com/index.php/affiliate/accountnew/createaffiliate.
If a non-affiliate member clicks on this link, he will be directed to the registration page. Otherwise (in case of an affiliate member), he will see My Affiliate page.

Setting Multi-level Affiliate

Go to Affiliate Pro/Manage Programs, create a new program.
Fulfill all necessary fields and pay attention to the Affiliate Commission/Customer Discount tab.

caption

If you insert one and only one value in the Commission field, the affiliate system will count commission by one level. If you insert a string of value like “10%, 9%, 8%”, it will count commission by three levels. So, you can use this feature for the purpose of multi-level marketing on your site.

Multi-level affiliate overview

  • Tracking commission: This affiliate version offers the system of tracking commission and discount for more than 1 level. For example, the affiliate A invites the affiliate B, the affiliate B invites the affiliate C and so on, you can set the commission level for this like 10%, 9%, 8% (at the step of creating programs). So, if a customer of affiliate C completes an order, the affiliate C will get 10% commission, the affiliate B will get 9% commission and the affiliate A will get 8% commission. If a customer of affiliate B completes an order, the affiliate B will get 10% commission and A will get 9% commission.
  • Tracking discount: Insert a value for the Discount field (when setting programs) by levels, for example 10, 9, 8, 7. In case that the affiliate A invites the customer B, so according to the theory, the affiliate A will get commission and the customer B will get discount. However, if you set such a string of discount, it will be counted as follow: the customer B will be discounted $10 for the first order, $9 for the second order, $8 for the third order and from the fourth order and the next ones, the discount rate will be $7 (0 is valid here).

Using Ajax invitation form for CMS page

Insert the code below at any CMS page, it will show the invitation button named Invite Friends at the frontend.

{{block type="core/template" name="invitation_form_ajax" as="invite_form_ajax" template="mw_affiliate/customer/account/invitation/invite_form_ajax.phtml"}}

When a customer clicks on this button, the invitation form will be extended.

caption

How does the Affiliate use the system?

Sign up for the Affiliate system

Guest can sign up for the Affiliate system while registering for the site at the Create an account page. Registered customer can sign up for the Affiliate system at My Account/ My Affiliate Account.

When a customer have had affiliate account on your site, after he log in, he will see My Affiliate Account tab at My Account.
The My Affiliate Account page at the frontend has eleven tabs: My account info, my transaction history, my commission history, my withdrawal request, my invitations, my affiliate banner and my affiliate program, my affiliate network, my affiliate websites, my affiliate widget and my affiliate report. Please follow the next part to view the details of these tabs.

Change affiliate account

An affiliate member can change his affiliate account at My Account/My Affiliate Account / My Account Info.

caption

He can choose to make withdrawals automatically or manually. In case of manual withdrawals, insert the request amount and submit it at My Account/My Affiliate Account/My Withdrawal Request.

Reserve level is the amount of money that a customer wishes to always be remained in his account. This field is not required and its value depends on each customer.
Referral site: insert the customer’s site or the site that directs the customer to the store.

View Transaction History

Your affiliates can view their current balance and detail transactions at My Account/My Affiliate Account/My Transaction History.

caption

View Commission History

Your affiliates can view and track their commission history at My Account/My Affiliate Account/My Commission History.

caption

Make a withdrawal

An affiliate member can choose to make withdrawals automatically or manually. In case of manual withdrawals, he can go to My Account/ My Affiliate/ My Withdrawal Request.

caption

How to earn commission?

Use the invitation link

For any pages that the affiliate visits, he will see Share this page at the site footer

caption

When an affiliate clicks on Share this page, he will be directed to My Account/ My Affiliate Account/ My invitation. In this section, he will see the referral link; he can share this link anywhere.

Invite Friends via various channels

Your affiliates can earn commission by inviting their friends to your website via various channels at My Account/ My Affiliate Account/ My invitation
Your affiliates can easily invite friends to your website via email, social media or manual referral codes from their own personal Affiliate account. Your affiliates can also embed this personal referral link into banners, blogs, IM etc.
At the same page, affiliates can view their invitation history.

caption

Use the ‘Invite friends’ button

The admin can allow affiliates to invite their friends though the Invite friends button (or link) at any page of the store. The Affiliate will see this button (or link) on the frontend. When he clicks on it, a popup as below will appear, so he can invite friends.

caption

Use banners

You can upload differently customized banners and your affiliates can place affiliate banners on their websites, blogs or any social network, then they can earn commission for referrals.
To take banners, your affiliates can go to My Account/ My Affiliate Account/ My Affiliate Banners.

caption

Use Affiliate Website

Please go to My Account/ My Affiliate Account/ My Affiliate Websites. At this page, an affiliate can add his website domain. After the website of an affiliate is verified, if any visitors go to your website via this affiliate’s website, he can earn commission for referrals.

caption

Use Affiliate Widget

Another way for your affiliate to earn commission is using affiliate widget. An affiliate can place affiliate widget at his website, forum, blog.., if any visitors go to your site via this Affiliate’s widget, he can also earn commission for referrals.
Please go to My Account / My Affiliate Account/ My Affiliate Widget.
At here, your affiliates can customize their own affiliate widget and click on ‘Get code’ button to get code of affiliate widget.

caption

View Affiliate Programs

An affiliate can see the programs he belongs to at glance and how much commission he receives from each referred purchase at the tab My Account/My Affiliate Account/ My Affiliate Program.

caption

View Affiliate Network

All sub- levels of an affiliate will be shown at the tab My Account/My Affiliate Account/ My Affiliate Network.

caption

View Affiliate Report

This new feature allows affiliates to view and track reports by going to My Account / My Affiliate Account/ My Affiliate Report.
Affiliate can select different time ranges at the Date range box to view reports:

+ Line chart shows total sales (include sales from their purchases and their referred customer’s purchases) and total commission in chosen time range.
+ Pie Chart (My commission sources) presents percentages of each commission source in chosen time range: commission from my purchases is commission from affiliate’s purchases; commission from my group sales is commission from referred customers’ purchases; commission from other sources is commission from referral visitor, referral sign-up and referral subscribe.
+ Pie Chart (My commission by programs) presents percentages of commission by each affiliate program in chosen time range (for the type of commission come from referrals including referral visitor, referral sign-up and referral subscribe, those types of commission will belongs to non-program group)

Affiliates can also view their total purchases, total orders (only from their own purchases) and their total commission, total affiliate network in chosen time range at this page.

caption

How to use credit ?

An Affiliate member can make withdrawals or use credit for the checkout (buying products)

Use credit for the checkout

If an Affiliate wants to buy products, he can use credit. In the Shopping Cart page, he can enter an amount of credit (that he wants to spend) into the Use Credit area.

caption

How to use the referral code?

caption

If the admin sets the field: Apply discount and commission for affiliates when they purchase themselves to YES. Then an Affiliate can purchase products with the referral code for getting discount and commission. In the case that affiliate A uses the referral code of another affiliate B, then affiliate A can get discount in the affiliate program which affiliate B joins.

Personal tools
Namespaces

Variants
Actions
Navigation
General
Free Gift
Onestep Checkout Pro
Reward Points Pro
Reward Points Lite
Affiliate Pro
Affiliate Lite
Help Desk Pro
Daily Deal
Easy Banner
Cms Pro
Mega Menu
Follow Up Email
Easy Testimonial
Easy FAQ
Store Credit Pro
Ajax Cart Pro
Promobox
Delivery Schedule
Social Gifts
Toolbox