This article details how to edit, delete, and add referrals in Arabianaffiliates, using the available interface within Arabianaffiliates’s settings.
Referrals can be added, edited, or deleted by navigating to Affiliates → Referrals:
Once you’ve clicked on Referrals in the above menu and are on the Referrals page, follow the relevant instructions below:
Manually adding referrals
On the Referrals page, referrals can be manually added by clicking on the Add New Referral button:
Once you’ve clicked Add New Referral, you will be presented with a form that looks like this:
In the Affiliate field, begin typing the name, email or login name of the affiliate you’d like to credit this referral to. A list of affiliates will be shown matching the partial name you have entered:
Simply click on the affiliate that you are creating this referral for.
Define the rest of the available fields you’d like for the new referral. If you’d like to connect this referral to an existing purchase or membership, see below. Once you’ve completed populating this information, click on the Add Referral button.
Editing existing referrals
To edit an existing referral, on the Referrals page, click on the Edit link for the referral which you’d like to edit:
On the edit page for that referral, adjust the fields you’d like, and then click the Update Referral button:
Linking referral data to order information
When adding or editing a referral, you can specify various types of information about the referral:
Here, you can define or adjust the amount of the referral. This number follows the referral type set in Arabianaffiliates settings (either a percentage, or a flat/fixed amount).
Added in version 2.2, this field is used to define the referral type: Sales, Opt-In, or Lead.
This field is used to describe the referral.
The reference is most frequently used to note the transaction ID (or order number) of a referring sale which you’d like to associate with this referral. For example, if you wish to link a referral with an existing order within WooCommerce:
Enter the WooCommerce order number in the reference field, and enter woocommerce for the Context field (described below), and then you can click through from this referral, directly to the WooCommerce order information page.
The context typically defines the payment system used to process the transaction. Commonly-used contexts are the name of the commerce plugin in use, such as woocommerce, gravityforms, or edd, for example.
Do not put anything in the custom field as it is only used for recurring referrals. If you need to enter a recurring referral manually, please see this document: Manually Creating Recurring Referrals
The status determines whether or not the referral is paid, pending, or rejected. You can specify which by selecting the desired option from the dropdown:
To delete a referral, on the Referrals page, click on the Delete link for the referral which you’d like to delete:
Creating a recurring referral
Need to create a recurring referral? We have a dedicated set of documents for that:
Manually Creating Recurring Referrals
To search specific referral data such as a reference number or description entry, click the Help tab at the top-right of the Referrals screen, then when the help options appear, click on Searching Referrals on the left side of the screen. The list shown provides several ways referrals can be searched:
Setting a global (default) referral rate
The referral rate determines how much the affiliate earns on each sale they generate for the store. For example, if an affiliate generates a $100 sale, their referral amount for the sale will be a percentage of that.
If the referral rate is set to 20%, affiliates will receive $20 on a $100 order.
The global referral rate (which will apply to all affiliates) is set in Affiliates → Settings:
Setting a per-affiliate referral rate
If you wish to set a custom rate for a specific affiliate, go to Affiliates → Affiliates, search for the affiliate by name or ID and click Edit:
Enter the Referral Rate you would like that specific affiliate to earn. Setting a referral rate on a per-affiliate basis will override all other referral rates.
Setting a per-product referral rate
Referral rates can also be set on a per-product basis (for some eCommerce plugin integrations). For per-product referral rates, see the setup documentation for the ecommerce or membership plugin you are using in the Integrations section.
Note: If an affiliate has a custom rate specified for their account, that rate will always take precedence over global and per-product rates.
Each time a referral is generated, it is assigned a status. There are four possible values that can be assigned:
pending – This is a referral that has been generated but is not yet confirmed
unpaid – This is a confirmed referral that is waiting to be paid out to the affiliate
rejected – This is a referral that was rejected
paid – This is a referral that has been paid to the affiliate
All referrals begin with a status of pending and are then updated to one of the other three statuses when particular events occur. A pending referral means that it is waiting to be confirmed as valid. Referrals are confirmed when orders in the e-Commerce platform are completed.
A referral is marked as rejected when the corresponding order in the e-Commerce platform is refunded or deleted. In Affiliates > Settings > Misc, there is an option to automatically mark referrals as rejected when orders are refunded or deleted. If enabled, Arabianaffiliates will mark referrals as rejected for you. If disabled, or your e-Commerce platform is not fully supported, referrals will need to be rejected manually.
Referrals are marked as unpaid when the corresponding order or signup is completed in your e-Commerce or membership platform. Once marked as unpaid, the referral is considered “earned” and should be paid out to the affiliate.
Referrals receive a status of paid as soon as they have been paid to the affiliate. Once marked as paid, a referral is considered closed and no further status changes are applied to it.
The below article outlines the hierarchy of referral rates, in order, with 1 being the lowest and 8 being the highest, depending on your configuration of Arabianaffiliates’s core features and add-ons.
1. Global referral rate
When a referral rate is defined in Affiliates → Settings → General, this is known as the global referral rate. This is the base referral rate and will apply to all referrals, unless the below settings/add-ons are active and have been configured.
2. Per-category referral rates
Version 2.2 of Arabianaffiliates introduced per-category rates for the WooCommerce and Easy Digital Downloads integrations. When a per-category referral rate has been defined, this referral rate will override only the global referral rate described above.
3. Per-product referral rates
When a per-product referral rate has been defined (by editing the product), this referral rate will override the global and per-category referral rates. Setting a per-product referral rate is only possible with full integrations that support per-product referral rates.
4. Tiered Affiliate Rates
When Tiered Affiliate Rates is installed and tiered rates have been defined, and an affiliate reaches the referrals or earnings threshold, all future referrals will be recorded at the next tiered rate (and so on, depending on the number of tiers defined). Tiered referral rates will override the other referral rates mentioned above, for all future referrals — this includes the global referral rate, and per-product referral rates.
5. Per-affiliate referral rate
When a per-affiliate rate is set in the Edit Affiliate screen, this rate will override all other referral rates for that specific affiliate — this includes the global referral rate, per-category and per-product referral rates, and tiered rates. Rate settings that the per-affiliate rate will not override are: Lifetime Commissions, Affiliate Product Rates and Recurring Referral rates on renewal payments.
6. Lifetime Commissions
When Lifetime Commissions is installed, and an affiliate has been linked to a customer through an initial purchase, the global Lifetime Referral Rate will be used for all future referrals when the linked customer makes a new purchase. The global Lifetime Referral Rate is defined in Affiliates → Settings → Integrations → Lifetime Commissions. If a per-affiliate Lifetime Referral Rate is defined on the Edit Affiliate screen, this rate will override the global Lifetime Referral Rate. The Lifetime Referral Rate will override all other rates, with the exception of those generated by the Affiliate Product Rates add-on mentioned below.
7. Affiliate Product Rates
When Affiliate Product Rates is installed and a product rate has been set in the Edit Affiliate → Product Rates screen, these referral rates will override any other referral rates for that specific affiliate and product with the exception of the Recurring Referral renewal rate mentioned in the next paragraph.
8. Recurring Referrals
When Recurring Referrals is installed, the first referral is generated by the Arabianaffiliates core plugin in the order above. All subsequent referrals for subscription payments are generated by the Recurring Referrals add-on. This means if a recurring rate is defined in Affiliates → Settings → Recurring Referrals, or on a per-affiliate basis defined on the Edit Affiliate screen, this rate will apply to all subsequent referrals (after the initial referral). This referral rate will continue to override all previous referral rates mentioned above for all future referrals.
For certain integrations, Arabianaffiliates allows you to automatically reject referrals if an order was refunded. If a customer requests a refund or returns a purchase, you can enable a setting that will reject the correlated affiliate referral if it has a current status of Unpaid.
Go to Affiliates → Settings → Misc and enable the Reject Unpaid Referrals on Refund setting.
Note, this will only reject Unpaid referrals. Any referrals that have a status of Paid cannot be manually or automatically rejected, or recalled from your affiliates or their account(s).
The Reject Unpaid Referrals on Refund feature supports refunds within the following integrations:
Easy Digital Downloads
Ninja Forms (when a form entry is deleted)
Paid Memberships Pro
Restrict Content Pro
As of version 2.2 of Arabianaffiliates, referral types were introduced. There are three possible values that can be assigned:
Sale – This is the default referral type that has been generated for a typical sale.
Opt-In – This referral type is automatically assigned with the [opt_in] shortcode. When placed on a page, the shortcode displays an opt-in form that integrates with MailChimp, ActiveCampaign, or ConvertKit. The opt-in referral type can also be assigned to any of the referrals created from the form integrations supported.
Lead – This referral type can be assigned to any of the referrals created from form submissions for lead generation.