View Product Page

Affiliates list and details

Affiliates list

Go to YITH > Affiliates > Affiliates to find the list of all your registered affiliate users.

From this screen, you can filter by name, email addres or token ID (minimum 3 characters) to find one specific affiliate.

Additionally, you will also be able to change the affiliate status either form the bulk actions or from the actions available for single affiliates:

  • Delete affiliate
  • Change status to approved
  • Change status to rejected
  • Ban affiliate
  • Unban affiliate
Single affiliate actions

When you change the affiliate status to rejected or banned from the affiliate’s actions, you will be able to set a custom message for this specific affiliate from a dedicated popup and explain why the affliate’s profile is being rejected or banned.

This message can also be set and updated in the user’s profile (see below → Affiliate details).

Create a new affiliate

By clicking on the + Add affiliate button, you can create a new affiliate. You will have two options, either select an existing user or create a new user and enable it as affiliate without leaving the page.

Add affiliate from existing user
Add affiliate from existing user
Add new affiliate and user
Create new user with affiliate role

Affiliate details

To have access and edit the affiliate information, open the user profile from the Users page.

Users

Scroll down until you find the Affiliates details section.

Here you can:

  • add/remove the user from the list of affiliates
  • edit the affiliate’s status (New request, Accepted, Rejected, Banned)
    • when you change the affiliate status to rejected or banned, you will be able to set a custom message.
  • edit the affiliation token associated to the user (by default, it matches with the user ID), but it can be changed to a meaningful text for example.
  • edit the affiliate’s rate: this value overrides the general settings
  • Affiliate payment email: here you can add an email address, as a reference info for your manual payments.
  • Affiliate Direct bank/wire transfer info: this is where you can find or edit the details added by the customer in the Affiliate dashboard > Settings if the Bank transfer payment method is enabled (from the general options).

Commissions

From the Commissions page, you can see a list with all the commissions generated in your shop.

The plugin will generate one commission for each item line in the order, so, for example, if you purchase 3 different products in the same order, the plugin will generate 3 commissions. If you purchase 3 items of the same product in the one order, instead, the plugin will generate only 1 commissione item.

You can see a table with the following information (each column title can act as a sorting filter):

  • Commission ID
  • Date
  • Affiliate
  • Order ID and customer
  • Product
  • Item total
  • Rate
  • Commission
  • Status

Additionally, you can also show the following columns and enable them from the “Screen options”.

  • Refunds (per item total)
  • Discounts (per item total)
  • Category
  • Payment ID: this will show the number of the related payment, if created.

Filters and bulk actions

Based on the commission status, you can filter the view of the commissions using the filters on top and filter for example only by Pending or Paid commissions.

Yet, you can further filter these views using the additional filters by:

  • product
  • affiliate user
  • date

You can also bulk edit them and apply the following actions:

  • change status to “pending”
  • change status to “not confirmed”
  • change status to “cancelled”
  • change status to “refunded”
  • create a payment manually
  • pay via Direct bank/wire transfer
  • move to trash

As you can see, you can both change the commission status, trash them or create a payment record. For more details about how to generate payments, please, refer to this page.

Commission payments

To generate a new payment record for your affiliates, you can go to the Commissions tab, select commissions and from the bulk actions generate a payment record by choosing either Pay manually or Pay via bank/wire transfer.

Once the payment is created, you will see on this page all the payment records created with the on hold status.

Payments list

Once the payment record is created, you can issue the payment to the affiliate offline and then change the payment status to Completed: all linked commissions will automatically get the Paid status.

From this screen you can also filter the payments by status, affiliate, date.

Payment filters

You can bulk edit them and choose any of the following actions:

  • Change status to “Completed”
  • Change status to “On hold”
  • Change status to “Cancelled”
  • Delete

The same options will also be available in the commission actions, and additionally you will be able to find Pay via Direct bank/wire transfer as an option for single payments.

Payment actions

If you select Pay with bank transfer from the payment actions, you will be able to see the payment details in the the Payment method column.

Payment info in payments table

For more details about the Payment with bank/wire transfer, please, refer to this page.

Commission status

The commission status is strictly linked to the order status.

When the order is submitted, the commissions are generated with the Not confirmed status. Then, when the order is paid and completed, the commission automatically gets the Pending status, which means that the commission is ready to be paid.

Here is a more detailed list with all the statuses that a commission can get and which order status can trigger it:

  • pending: if the order status goes to completed or processing
  • pending-payment: this status is not triggered by any order, it can only be triggered by automatic or manual payment and will be like this until the payment is confirmed by the gateway or set to completed by the admin manually.
  • paid: this is the status that the commission takes when the associated payment is set to completed status.
  • not-confirmed: this is the commission status when the order status goes to pending or on-hold.
  • cancelled: if the order status goes to cancelled or failed.
  • refunded: if the order status goes to refunded.

Please, note: when the commission is on pending payment or paid status, it can only be changed to Trashed. No other status change is allowed to prevent that a commission is erroneously paid twice.

The commission can be paid only when it’s on Pending status.

Example: a commission standard life cycle

This is the default life cycle of a commission, and the statuses it takes on:

  • order created > commission not confirmed
  • order completed > commission pending
  • commission payment created > commission pending payment
  • commission payment completed > commission paid

The admin can anyway manually change the commission status regardless of the order status, so for example, a pending commission can be changed to not confirmed even if the order is completed.

For more details about how to create a commissions payments, please, refer to the following pages:

Commissions payments for the free version
Commissions payments for the premium version

Manual payment

If you want to create payments manually, you can do the following.

From the commissions list page, you can filter and select the commissions by status, affiliate, product, date and from the bulk actions select “Create a payment manually“.

The plugin will automatically group the commissions of each affiliate user (so calculate the total amount to be paid) and create one payment record for each affiliate.

The manual payment record will be automatically set to the On hold status.

Example: you want to manually generate a payment record for all the pending commissions older than 30 days.

You can first click on the “Pending” view, then, filter the commissions by date (all commissions up to March 7), select them all and finally create a payment from the bulk actions.

Filtered commissions

This will create one payment record for each affiliate in the Commissions Payments table (in this case, one for Susanne and one for Elisabetta) with the on-hold status.

Now you can pay your commissions using any offline payment gateway you prefer, for example in cash or with a non-supported gateway, and once the payment is done, you can manually change the payment status to “Completed” either from the payment details or from the payment actions in the payments list.

Payment status to completed from payment details

This action will also change the status of the related commissions to “Paid“. For more details about the commission status, please, refer to this page.

Also, even if the payment record is created manually, you can also process the payment from this page by using any of the integrated gateways: the payment will be automatically set to completed.

Payment with Bank transfer

Payments via Bank transfer are currently very similar to manual payments, but if you enable them, your users will be able to enter their payment details (so the Account name, IBAN and Swift code) so you can quickly find them in the payment details when you will process the payment.

The payment, however, occurs manually, so you will have to create a bank transfer from your bank, the plugin will not do that on your behalf.

To enable this gateway, go to General options > Commissions & Payments > Payment gateways and make sure the gateway is enabled (it is enabled by default when you first activate the plugin).

General options - Payment gateways

Then, go to the Commissions list page, filter them based on your needs and select the commissions you want to pay.

Then, click on Bulk actions dropdown and select “Pay via Direct bank/Wire transfer“.

Pay via direct bank/wire transfer

This will create one payment record for each affiliate with the “on hold” status.

Payment with on hold status

If the payment details have not been set for the affiliate, you will be able to add them from the Gateway details in the Payment details, as you can see below.
Please, note, this option is available only if you’re using the premium version.

Gateways details

You can now issue the payment (manually) from your bank account and once it is done, you can manually change the payment status to “Change status to completed” from the payment actions.

Payment status to completed from payment details

This will also update all the related commissions’ status and set it to “Paid“. For more details about the commission status, please, refer to this page.

General options

In the General Options tab we will find two different sections:

General

General options

Query var name: enter the name of the query var used to store the referral tokens in the URL. Default to “ref”.
A typical referral URL is http://sitename/?ref=2, where “ref” is the var name: you can change to any text you like, and it will be changed in all your affiliates’ referral URLs.

The affiliate can find this token in the Affiliate Dashboard > Link generator tab:

Cookie options

Cookies options

Referral cookie name: enter a name to identify the cookie that will store the referral tokens. This name should be as unique as possible to avoid collision with other plugins. If you change this setting, all cookies created previously will no longer be valid. Default value is yith_wcaf_referral_token.

Set cookies via AJAX: enable to execute an AJAX call to set up affiliates cookies whenever the system finds a referral query string in the URL.

Affiliate registration – options

From the General options > Affilites Registration tab, you will be able to enable/disable the affiliate registration form and its options.

Registration form

The affiliate registration form includes the standard WooCommerce registration fields (username, email and password) that cannot be changed, and the additional affiliate fields:

  • First name
  • Last name
  • Privacy text
  • Terms

Below the fields, you will find an important option:

Add the registration form fields to the default WooCommerce registration form

Add the registration form fields to the default WooCommerce registration form: enable this option to add the affiliates registration form fields in the WooCommerce default registration form. In this way, all users who register to your site will also automatically submit an application as affiliates at the same time.

Note: if this option is enabled, you will never be able to see the Become an affiliate form, because all new users are automatically applying as affiliates during the registration. The only exception would be in case the user registered before the option was enabled.

WooCommerce register

Registration options

Just below, you will find the following option:

Registration options

Associate old commissions to new users with the same token: if enabled, when a new affiliate is registered, the system will check if there’s any preexisting commission for that default token. If there is any, it will be assigned to the user automatically.

Affiliate Dashboard – options

From this tab in the General options > Affiliate Dashboard, we can configure all the options related to the Affiliate Dashboard, that is the dashboard that will be displayed to the affiliates on the frontend.

Affiliate dashboard options

Where to show the Affiliate Dashboard:

  • In a specific page using the shortcode: if you select this option, you will be able to select the page and what to show to guest users in the options below

Choose the Affiliate Dashboard page: use this shortcode [yith_wcaf_affiliate_dashboard] in the page you want to use as dashboard.

To guest users in the Affiliate Dashboard show:

  • The affiliate registration form only
  • The affiliate registration form + the login form

These settings can also be changed through the shortcode attribute. For more details please see this page.

  • In a specific endpoint inside My Account page: select this option if you want to show the dashboard automatically in My account page

Show social share: enable to show social share buttons of referral URLs in Affiliate Dashboard > Link generator section.

Allow affiliates to share on: enable the social sharing options that you want to offer on your site. Their icons will be displayed in the Link generator section:

  • Facebook
  • Twitter
  • Pinterest
  • Whatsapp
  • Email

Social title: enter the title to use in Twitter and Pinterest sharing.

Social text: enter the text to use in Twitter, WhatsApp and Pinterest sharing. Use %referral_url% where you want to show the URL of your affiliate.

Pinterest image URL: enter the URL of the image to use in Pinterest sharing.

Commissions & Payments – options

From this page in the General options > Commissions & Payments you will be able to set up the following sections:

Commission options

Commissions options

Default commission rate: enter the default commission rate for all your store affiliates.

Prevent affiliates auto-commissions: enable to prevent affiliates from getting commissions from their own purchases.

Exclude taxes from commissions: enable to exclude taxes from referral commissions calculation. E.g. if a product costs €100 and there’s €20 tax added (for a total of €120), the affiliate commissions will be calculated on €100.

Exclude discounts from commissions: enable to exclude discounts from referral commissions calculation. E.g. if a product costs €100 and a €20 discount is applied, the affiliate commissions will be calculated on €80.

Payment gateways

In this section, you can enable the only payment method supported in the free version, the Direct bank/wire transfer.

For more details about how payments via direct bank/wire transfer work, please, visit this page.