How users can become an affiliate

User side

In order to become an affiliate, users need to be registered to your store.
The registration is done from “Affiliate Dashboard” page which is automatically created when you enable the plugin. The page contains the shortcode “[yith_wcaf_affiliate_dashboard]”.

Affiliate dashboard - WordPress page

Become an affiliate

The affiliation request can either be sent through the related registration form provided by the shortcode or automatically once any other registration form of the site is filled in.
In order to choose the solution that most suits your needs, click on the “Settings” tab of the settings panel of the plugin and select one of the two entries available in the “Registration form” option.

Referral registration

If you have selected the plugin registration form, the registration of the affiliates will be applied from the form of the “Affiliate Dashboard” page.

Become an affiliate - Referral registration

The user that makes an affiliation request is added to the affiliate user list in the Affiliates section of the plugin, with the default “Disabled” status. The administrator will have to activate the user as an affiliate with the related “Enable” option that you can find in bulk actions of the page. The admin will also have the option to Ban and Un-ban affiliates along the way.

New affiliate

Every new affiliation request will be notified next to the “Affiliates” label.

Administration side

Administrators can add a new affiliate from the settings panel of the plugin at any time.
They can choose from existing users or the creation of a new user by clicking on the “Create New” button.

Add new affiliate

Add New User

How to manage commissions

Commission settings

Every completed purchase on the shop related to an affiliate user will generate a commission to pay.
The commission concerning the affiliate is the sum of the commissions of all products added to the cart. To change the general settings of commissions, go the options panel of the plugin, click on the “Settings” tab and scroll the page to the “Commissions” section.

Commissions settings

Here you can edit the following options:

  • General rate: commission percentage applied to the amount of each product of the shop. A different percentage for each affiliate can be specified from the editing page of the user’s profile.
  • Avoid auto commission: if this option is activated, no commissions will be generated for those purchases that have the same refer ID of the user that made the order.
  • Exclude tax from commissions: exclude taxes from commission amount.
  • Exclude discount from commissions: exclude possible offers applied to the cart from the commission amount.

Commission list

All the commissions generated by the orders of the site are stored in the “Commissions” section of the options panel of the plugin.

Commissions list

The commission is created with the “On-Hold” status and automatically acquires the “Pending” status when the order to which it is associated is completed: this status change is notified next to the section label.

Notify pending commission

The plugin doesn’t include any payment system to pay commissions but lets you track those already paid. Select the commission, and click on the “Create a Payment” entry that you can find among the bulk actions of the page.

Create payment

Now the commission will change its state to “Pending” and the new entry will be created in the “Payments” tab. Only after it will be flagged as paid, the commission will change its status to “Completed”.

Commission - Status "Pending"


Thanks to the bulk actions of the page, it is possible to change the status of every commission to:

  • Pending: status of the commission when the linked order is completed.
  • Not Confirmed: default status of the commission when entered in the table.
  • Cancelled: status of the commission when the order is cancelled.
  • Refunded: status of the commission when the order is refunded.

Commissions can be filtered by product, user and date using the Ajax research fields at the top of the page.

Commission - Bulk actions

How to generate affiliation link

The affiliation link for any page of the site requires the addition of a reference variable in the query string with the related affiliate ID assigned. This is a possible example:
The ref variable can be changed freely by the administrators of the site from the plugin settings panel through the “Referral var name” option.

Referral var name

Each affiliate can generate the affiliation link from the dashboard (see here how to configure the Affiliate dashboard).

Clicking on the “Generate link” entry, users will be redirected to a page in which they can obtain dynamically the affiliation URL for a specific shop page.

Shortcode - Link generator

Affiliate dashboard

Once logged in, affiliate users can verify their information about affiliation activities consulting the “Affiliate Dashboard” page, or any other page of your shop that contains the [yith_wcaf_affiliate_dashboard] shortcode, indicated as affiliation page in the “Settings” tab of the options panel of the plugin.

Shortcode - Affiliate dashboard

In this page, we’ll analyze all the sections to which the affiliate can have access.

Commissions, Payments and Clicks

Within his/her dashboard, the affiliate can track all the actions related to the refer ID: visits, received commissions, and related payments.

Affiliate dashboard - WordPress page
Affiliate dashboard - Payments
Affiliate dashboard - Clicks

Affiliation link

Clicking on the “Generate link” entry, users will be redirected to a page in which they can obtain dynamically the affiliation URL for a specific shop page.

Shortcode - Link generator

Payment email

Users can change the payment email added during their registration at any time from the “Settings” section of the “Affiliate Dashboard” page.

Affiliate dashboard - Payment email

How the admin sets affiliate details

To have access and edit the affiliate information, select his/her user.


Users details

Through the fields included in the “Affiliate details” section you can:

  • remove the user from the list of affiliates
  • enable/disable the affiliate
  • edit the affiliation token associated to the user (by default, it matches with the user ID)
  • insert a tailored commission percentage for the user, different from the one set in “Affiliates -> General Settings
  • come into possession of the PayPal address specified by the user for the payment of his/her commissions

How to manage payments


All the payments are registered in Affiliates -> Payments.

Payments - Admin view

The payment of the commission can’t be automatically managed, therefore it is essential to enable the “Create a payment” entry for the commission that you need to pay.

Create a payment

The payment is now available in the payments tab and has the “On-Hold” status.


The free version of the plugin doesn’t include any automatic payment system. Administrators will have to pay through bank transfer or use PayPal with the email used by users during the registration step.
Once the payment will be completed, you will be free to change the status to Completed.

Switch payments to completed

If you want to pay the commission by PayPal, go to the user’s profile and check that he/she has inserted his/her billing address.

Payment email

Customize cookie

When users visit a site for the first time by clicking on a link containing the reference of an affiliate, a cookie will be stored in their navigation session. Cookie’s name and duration (in seconds) can be set within the “Settings” section of the plugin.


Set cookie via Ajax

If you want to set affiliate cookies with an Ajax call when the system detects referral query string in the URL and, therefore, avoid issues with the cache system, you must enable the option Set cookie via Ajax.

How to check stats

All statistics about plugin information are gathered in the “Stats” section of the options panel.


The statistics table contains the following information:

  • Total amounts of the confirmed commissions.
  • Amount of the paid commissions up to that moment.
  • Overall generated clicks from affiliation activities.
  • Completed order thanks to affiliation activities.
  • Conversion average percentage between clicks and purchase orders.


Affiliate dashboard

The [yith_wcaf_affiliate_dashboard] shortcode allows inserting a dedicated dashboard for the affiliate on the page.
The dashboard is divided into different sections: commissions, clicks, and payments.
There are three shortcode parameters that are related to the sections for which the elements pagination is provided:

  • pagination: (yes/no) enable/disable the pagination within the dashboard section
  • per_page: elements shown per page
  • current_page: page number shown in any section.
    Supposed that we have pagination for an elements list in the “Commissions” section, by specifying 2 as a parameter value, only page 2 will be shown in the section.

Shortcode - Affiliate dashboard

Registration form

The yith_wcaf_registration_form shortcode inserts the registration form on the page that the user can use to register as a new affiliate to the shop.
If a registered user views the page, only the “Become an affiliate” button will be shown. Thanks to this button, the user’s profile will be added to the affiliate ones.
On the contrary, the whole registration form will be shown.

Shortcode - Registration form

The shortcode parameters are:

  • show_name_field: (yes/no) show or hide the “name” field of the form
  • show_surname_field: (yes/no) show or hide the “surname” field of the form

Link generator

The [yith_wcaf_link_generator] shortcode inserts a form on the page that allows the user to get an affiliation link in a dynamic way according to the specified URL.

Shortcode - Link generator