Website: http://magehit.com Contact: sale@magehit.com

Affiliate Guide Version 4.0.5 - Jan 2017

❖ Configuration

Go to System >> Configurations >> MageHit >> Affiliate Pro (or Affiliate Pro >> Configuration) to

configure the extension.

+ General Settings

- 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 the default customer

registration form field, select one of the three values (Disable, Enable/signup check box,

Enable/signup form/Enable). In the Free gift label field, upload free gift label image.

In the Auto approve Affiliate registration field, select ‘Yes’ to automatically approve the affiliate

registration. In case of selecting 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 Length of the manual referral code (set # of characters) field, specify the number of

characters of referral code.

Customers :

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.

+ Manage Affiliate Commission and Customer Discount

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

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

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

In the Widget width : Enter the width of Widget

In the Widget title : Enter the title for widget, the title will be shown on widget at the frontend

In the Widget product quantity : Specify the quantity of products which are displayed on widget

+ Affiliate – Paypal

Enable Automatic Withdraw By Paypal: Select Yes or No to activate or inactivate 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 email

notification 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.

+ Affiliate Email Notification Templates

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\magehit_affiliate

❖ Manage Program

The Manage Affiliate Program menu allows you to create marketing campaigns that decide the

commission and discount rule.

Add a new program

To add new rule, 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

In the Notify affiliate via email field, tick the checkbox to notify affiliates of the program.

In the program name, description, store view, priority, fill in the information for the program in

these fields

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.

In the Total Members field, reports the number of affiliates of the program.

In 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.

Affiliate Commission/ Customer Discount

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

program.

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.

- 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.

❖ 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.

>> 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, withdrawal notice email, withdrawal method and reports current balance, total amount of received

commission and total amount paid out.

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.

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.

Invitation History tab shows the information about Invitation Time, Customer Email Address, Ip Address,

Status (type of referral).

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.

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

Affiliate Programs tab shows all programs that affiliate joined in, however only 1 affiliate program

with the highest priority is applied for this affiliate.

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

Affiliate Network tab lists all sub-levels of Affiliate.

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.

All Customers

Customers page lists all customers on your site.

You can change the affiliate parent here 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.

❖ 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

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

number of days.

In the Maximum numbers of orders affiliate will earn commission from new referral field,

specify 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

❖ Manager Banner

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.

❖ Manager Affiliate Websites

This page shows the information about all affiliates websites including Customer Email, Website and status

(verified or not verified).

❖ Manager 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.

❖ Manager Transactions

❖ Commission history

❖ The Affiliate history tab provides a general look of all Affiliate commission and discount statistics.

Click on View to see details

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):

Transaction History

The Transaction history tab lists all information that relates to balance change (including time, affiliate

email, transaction type, changing amount, and balance).

❖ Manager 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)

❖ Actions

Sample order with affiliate information:

Affiliate Registration Link

This module provides a registration link for the admin and you can place this link anywhere on site. Please

add the following direction after your site address affiliate/accountnew/createaffiliate

For example:

http://www.mysite.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.

Affiliate Account

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.

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 Commission History

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

Commission History.

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.

Invite friends

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.

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.

View Affiliate Website

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.

How to use the referral code?

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.

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.

❖ Apply extension to themes or customize page:

-Insert code to display credit and refer code in checkout cart:

open file : app/design/frontend/{namespace}/{theme}/layout/checkout.xml

Find handle 'checkout_cart_index' and in block : checkout.cart

Add new block

<block type="core/template" name="credit.checkout.cart.credit" as="credit"

template="magehit_credit/checkout/cart/credit.phtml"/>

<block type="core/template" name="credit.checkout.cart.referral.code"

as="referral_code" template="magehit_credit/checkout/cart/referral_code.phtml"/>

-And display frontend to apply credit & referral code affiliate :

open file : app/design/frontend/{namespace}/{theme}/template/checkout/cart.phtml

Add new code in postion to display affiliate box:

<?php echo $this->getChildHtml('credit');?>

<?php echo $this->getChildHtml('referral_code') ?>