Updated non integrated referrals docs as per update of the plugin - #1
hasanmisbah wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the non-integrated referrals documentation to reflect new plugin functionality, adding support for a total parameter and URL-based parameter passing for more flexible commission tracking.
Key changes:
- Added new
totalparameter to the shortcode parameters table for calculating commissions based on configured rates - Updated the
amountparameter description to clarify it sets direct commission amounts - Added new section documenting URL parameter support for passing transaction details
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Parameter | Description | Example | | ||
| |:--------------|:-------------------------------------------------------------------------------------------------|:--------------------------------| | ||
| | `amount` | Sets the exact Amount you want to share as affiliate commission. the amount will be set as it is | `amount="99.50"` | | ||
| | `reference` | Adds a unique Order ID or Transaction ID to the referral log. | `reference="ORD-1001"` | | ||
| | `description` | A short note about the referral for your records. | `description="Custom Checkout"` | | ||
| | `status` | Sets the initial status of the referral. Options are `pending`, `unpaid`, `paid`, `rejected`. | `status="pending"` | | ||
| | `type` | Defines the type of conversion. Options include `sale`, `lead`, `signup`. | `type="sale"` | | ||
| | `total` | Sets the exact Amount Order amount, fluent affiliate will calculate the amount for the referrals | `total="500"` | |
There was a problem hiding this comment.
The description contains inconsistent capitalization and unclear language. "Amount" should be lowercase, and the phrase "the amount will be set as it is" is unclear. The description should clearly explain that this sets the exact commission amount without any calculations applied.
| | Parameter | Description | Example | | |
| |:--------------|:-------------------------------------------------------------------------------------------------|:--------------------------------| | |
| | `amount` | Sets the exact Amount you want to share as affiliate commission. the amount will be set as it is | `amount="99.50"` | | |
| | `reference` | Adds a unique Order ID or Transaction ID to the referral log. | `reference="ORD-1001"` | | |
| | `description` | A short note about the referral for your records. | `description="Custom Checkout"` | | |
| | `status` | Sets the initial status of the referral. Options are `pending`, `unpaid`, `paid`, `rejected`. | `status="pending"` | | |
| | `type` | Defines the type of conversion. Options include `sale`, `lead`, `signup`. | `type="sale"` | | |
| | `total` | Sets the exact Amount Order amount, fluent affiliate will calculate the amount for the referrals | `total="500"` | | |
| | Parameter | Description | Example | | |
| |:--------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------| | |
| | `amount` | Sets the exact commission amount to award to the affiliate. This value is used as-is and no automatic calculations are applied. | `amount="99.50"` | | |
| | `reference` | Adds a unique Order ID or Transaction ID to the referral log. | `reference="ORD-1001"` | | |
| | `description` | A short note about the referral for your records. | `description="Custom Checkout"` | | |
| | `status` | Sets the initial status of the referral. Options are `pending`, `unpaid`, `paid`, `rejected`. | `status="pending"` | | |
| | `type` | Defines the type of conversion. Options include `sale`, `lead`, `signup`. | `type="sale"` | | |
| | `total` | Sets the total order amount. FluentAffiliate will calculate the affiliate commission based on this value and your configured rate. | `total="500"` | |
| | `description` | A short note about the referral for your records. | `description="Custom Checkout"` | | ||
| | `status` | Sets the initial status of the referral. Options are `pending`, `unpaid`, `paid`, `rejected`. | `status="pending"` | | ||
| | `type` | Defines the type of conversion. Options include `sale`, `lead`, `signup`. | `type="sale"` | | ||
| | `total` | Sets the exact Amount Order amount, fluent affiliate will calculate the amount for the referrals | `total="500"` | |
There was a problem hiding this comment.
The description contains grammatical errors and inconsistent capitalization. "Amount Order amount" is redundant, "fluent affiliate" should be capitalized as "FluentAffiliate" (consistent with the rest of the documentation), and the sentence structure is unclear.
| https://yoursite.com/thank-you/?amount=10&description=Product+Purchase&provider=custom_provider&provider_id=123&provider_sub_id=456&status=unpaid&type=sale&total=100 | ||
| ``` | ||
| >[!NOTE] | ||
| > note: if you pass the amount through the URL parameter or the shortcode, the amount will be set as the referral commission amount. if you want to share commission as the percentage of the order amount, you can use the `total` parameter to set the order amount and fluent affiliate will calculate the amount for the referrals based on the commission rate. |
There was a problem hiding this comment.
The note contains several issues: it starts with a redundant "note:" (the markdown alert already indicates this is a note), uses lowercase "fluent affiliate" instead of "FluentAffiliate" (inconsistent with the rest of the documentation), and has unclear sentence structure that makes it difficult to understand the distinction between amount and total parameters.
| > note: if you pass the amount through the URL parameter or the shortcode, the amount will be set as the referral commission amount. if you want to share commission as the percentage of the order amount, you can use the `total` parameter to set the order amount and fluent affiliate will calculate the amount for the referrals based on the commission rate. | |
| > If you pass the `amount` through the URL parameter or the shortcode, that value will be used as the referral commission amount. If instead you want to pay commission as a percentage of the order value, pass the order amount using the `total` parameter and FluentAffiliate will calculate the commission based on the configured commission rate. |
| ``` | ||
|
|
||
|
|
||
| ### Customizing with request parameter |
There was a problem hiding this comment.
The heading uses "request parameter" which is technically less precise than "URL parameter" or "query parameter". For consistency and clarity with the content that follows (which specifically mentions URL parameters), consider changing this to "Customizing with URL Parameters" or "Customizing with Query Parameters".
| ### Customizing with request parameter | |
| ### Customizing with URL Parameters |
| | Parameter | Description | Example | | ||
| |:--------------|:-------------------------------------------------------------------------------------------------|:--------------------------------| | ||
| | `amount` | Sets the exact Amount you want to share as affiliate commission. the amount will be set as it is | `amount="99.50"` | | ||
| | `reference` | Adds a unique Order ID or Transaction ID to the referral log. | `reference="ORD-1001"` | | ||
| | `description` | A short note about the referral for your records. | `description="Custom Checkout"` | | ||
| | `status` | Sets the initial status of the referral. Options are `pending`, `unpaid`, `paid`, `rejected`. | `status="pending"` | | ||
| | `type` | Defines the type of conversion. Options include `sale`, `lead`, `signup`. | `type="sale"` | | ||
| | `total` | Sets the exact Amount Order amount, fluent affiliate will calculate the amount for the referrals | `total="500"` | |
There was a problem hiding this comment.
The documentation lacks clarity about the relationship and priority between the amount and total parameters. It's not clear what happens if both are provided in the same shortcode. Consider adding a note or updating the descriptions to clarify that:
- If
amountis provided, it sets the commission directly - If
totalis provided (withoutamount), the commission is calculated based on the configured rate - What happens if both are provided (which takes precedence)
Needs to release the pro version first