Notice: There is no legacy documentation available for this item, so you are seeing the current documentation.
How to Install and Use the Order Details for Affiliates Add-on for AffiliateWP
This add-on adds a new area to the affiliate’s dashboard that allows a logged-in affiliate to see specific information about the order that generated their referral.
In this article, we’ll show you how to install and set up the Order Details for Affiliates add-on for AffiliateWP.
- Supported Integrations
- Installing the Order Details for Affiliates Add-on
- Settings for Order Details for Affiliates
- Usage
1. Supported Integrations
2. Installing the Order Details for Affiliates Add-on
Before we get started, be sure to install and activate AffiliateWP on your WordPress site.
Once you’ve got AffiliateWP installed and your license is verified, you’ll be able to quickly install and activate the Order Details for Affiliates add-on.
3. Settings for Order Details for Affiliates
After installing the Order Details for Affiliates add-on, the next step is to enable Order Details for Affiliates which can be done in one of two ways:
- Globally enable access for all affiliates. This can be done via the Allow Global Access To Order Details checkbox located in AffiliateWP » Settings » Integrations.
- Enable access on a per-affiliate level. This can be done by editing an affiliate and enabling the Order Details Access checkbox located from AffiliateWP » Affiliates » Edit.
Also in AffiliateWP » Settings » Integrations you can disable order details that you do not want to be visible:
Note: The order details will be shown for referrals with a status of Unpaid and Paid only.
4. Usage
You can modify the information shown by using the included template file.
Copy the dashboard-tab-order-details.php template file from the add-on’s template folder, place it inside your child theme’s affiliatewp folder and edit it as you see fit.
The default shortcode with no additional parameters will show 100 orders with referral status values equal to Paid or Unpaid.
[affiliate_order_details]
The number parameter can be used to control how many orders are shown:
[affiliate_order_details number="5"]
The status parameter can be used to filter an affiliate’s order referrals by Paid or Unpaid:
[affiliate_order_details status="paid"]
[affiliate_order_details status="unpaid"]