Website Affiliate
| Lines of Code | 4161 |
| Technical name | viin_affiliate_website |
| License | OPL-1 |
| Website | https://viindoo.com/apps/modules/19.0/viin_affiliate_website |
| Read description for | v 10.0 v 11.0 v 12.0 v 13.0 v 14.0 v 15.0 v 16.0 v 17.0 v 18.0 |
| Required Apps | Invoicing (account) Discuss (mail) eCommerce (website_sale) Website (website) |
| Included Dependencies | Affiliate Management Viindoo Base Sales with Affiliates Accounting Foundation |
| Extensions | Affiliate Website Project Integration Affiliate Website CRM Livechat Integration |
Affiliates share your website, follow what they earn and request their payout
Manage Share Links, Commissions and Payouts on website
Visitors sign up on your website, create tracked links and earn commission on the clicks and orders those links bring. Their dashboard shows what is available for payout and leads to the Payouts page, where they request it and finance pays a draft vendor bill or purchase receipt.
For businesses that reward customers, partners and followers for the buyers they send to their Odoo website.
Built on Sales with Affiliates, which puts affiliate codes on sales orders: this app brings the programme to your website.
At a Glance
The facts of Website Affiliate in one place. Published by Viindoo.
How It Works
From a visitor on your website to a payout your finance team can pay, in five steps.
A visitor joins the programme
The Affiliate Program page invites visitors to join. After signing up, a visitor holds a personal affiliate code and a link to share.
Affiliates create and share tracked links
On the Affiliate Links page an affiliate names a link, picks a page of your website to promote and chooses a medium and a source from the ones you allow. One click copies the link, another shares it to social networks or by e-mail, and the Clicks column shows what each link brings.
Clicks become commissions
Clicks are recorded with their IP address, country and browser, and bots are set aside. Human clicks are confirmed at once and gather in an online referrer. At a thousand confirmed clicks the commission is created automatically; your team can also generate it by hand from the referrer.
Affiliates follow what they earn
The Commissions page shows the total commission, what is still unpaid and the balance available for payout, with the clicks of each link below. Available for payout opens the Payouts page of Affiliate Management, where the affiliate requests the payout. Odoo prepares a draft vendor bill or purchase receipt for finance to validate and pay.
Website orders pay the affiliate as usual
A visitor who follows an affiliate link and orders on your website earns the affiliate the commission of the order - by default for the first confirmed order of each customer, a value of the commission policy. A website order has no seller, so the commission is paid as usual whatever your policy for orders sold by the affiliate.
What You Get
Affiliates serve themselves. Sign-up, links, clicks, commissions and the balance available for payout all live on your website, so affiliates find their own figures.
Links you can tell apart. Every link carries a medium and a source you allow. Affiliates see clicks and commission per link, medium and source in their performance analysis.
Clicks that count. Each click keeps its IP address, country and browser. Bots are set aside, a repeat click on the same link from the same IP address counts once unless your commission policy records duplicates, and a cancelled click stops counting.
Pay per click, by the thousand. Confirmed clicks earn commission at the amount per thousand clicks of your referral commission rule, for all affiliates or for chosen ones. A commission keeps the amount it was created with when the rule changes later.
A balance that leads to payout. The dashboard shows what is available for payout and takes the affiliate to the Payouts page to request it. Finance receives a draft vendor bill or purchase receipt to validate and pay.
Website orders pay as usual. Commission on an order placed through an affiliate's link is paid whatever your policy for orders sold by the affiliate. By default only the first confirmed order of a customer earns commission; the commission policy changes that.
Your limits and your rules. Set how many links an affiliate creates per day, which websites run the programme, which sources and mediums affiliates can choose and how long the referral cookie lasts.
Compare affiliates at a glance. Add click columns to the Affiliate Codes list to compare visitors, human and bot clicks, and confirmed and cancelled clicks per affiliate.
Cancel a doubtful click. Cancel a click with a reason: it stops counting, and what was already billed for it is taken back.
More Screens
Every screen below comes from Odoo 19.0 with demo data.
Decide how many links an affiliate creates per day and which websites run the programme
Choose the sources and mediums affiliates can pick for their links
Compare visitors and clicks per affiliate
The commission earned by the clicks of a referrer
What This App Does Not Do
Read this before you buy. Everything below is something the app deliberately leaves to another app or to you.
This app adds what a thousand clicks earn to the referral commission rule; every other rate is set there.
Request payout prepares a draft vendor bill or purchase receipt. Your finance team validates it and registers the payment with the usual Odoo accounting tools.
Bots that announce themselves are set aside. It is not a fraud system.
Works Well With
Apps from the same stack, built to fit this one:
Affiliate Sales
Required. Puts affiliate codes on sales orders so orders earn commission.
Sales with AffiliatesAffiliate Management
Commission rules, the minimum payout and the payout documents your finance team pays.
Affiliate ManagementWho Should Use Website Affiliate?
Affiliate
Follows clicks, commissions and the balance available for payout on your website, and requests a payout without asking you for the figures.
Affiliate programme administrator
Sets the daily link limit, the websites, the sources and mediums, and what a thousand clicks earn.
Affiliate manager
Compares the clicks of the affiliates, cancels doubtful clicks and generates the click commission of a referrer.
Marketing
Sees which affiliates send real visitors and which send bots.
Frequently Asked Questions
What does Website Affiliate do?
It puts your affiliate programme on your Odoo website. Visitors sign up as affiliates, create tracked links with a medium and a source and share them. Clicks are recorded and bots are set aside; confirmed clicks earn commission by the thousand and website orders earn commission as usual. The affiliate follows the commissions and the balance available for payout on a dashboard that leads to the Payouts page.
How does an affiliate get paid?
The Commissions page shows the balance available for payout and opens the Payouts page of Affiliate Management, where the affiliate presses Request payout. Odoo creates a draft vendor bill (an affiliate that is a company) or purchase receipt (an individual) for your finance team to validate and pay.
What does a click earn?
Each confirmed click earns a thousandth of the Amount Per Thousand Clicks of your online referral commission rule. The commission is created automatically at a thousand confirmed clicks, or by your team from the online referrer at any time. It keeps the amount it was created with: changing the rule changes only the commissions created afterwards.
Does every click count?
Bot clicks are set aside, a repeat click on the same link from the same IP address counts once unless your commission policy records duplicates, and your team can cancel a click with a reason. A cancelled click stops counting and what was already billed for it is taken back.
Do orders on my website pay the affiliate?
Yes. A visitor who arrives through an affiliate link and orders on your website earns the affiliate the commission of the order. By default only the first confirmed order of a customer counts; the commission policy lets you pay every order. A website order has no seller, so the commission is paid as usual whatever your policy for orders sold by the affiliate.
What does Website Affiliate not do?
Commission amounts come from the rules of Affiliate Management. It does not pay your affiliates: your finance team validates and pays the draft vendor bill or purchase receipt. Bot detection is by user agent and is not a fraud system.
Who is Website Affiliate for?
Affiliates: follow clicks, commissions and the balance available for payout without asking you. Affiliate programme administrators: set the limits, the sources and mediums and what a thousand clicks earn. Affiliate managers: compare affiliates, cancel doubtful clicks and generate click commissions. Marketing: see which affiliates send real visitors rather than bots.
Which Odoo version and editions does it support?
Odoo 19.0 - Odoo Community, Odoo Enterprise, Viindoo Cloud. Upgrades to a newer Odoo series are a separate purchase for that series.
What does it depend on?
It installs on top of eCommerce, Sales with Affiliates, Link Tracker, UTM Trackers, Signup and Google reCAPTCHA integration. Odoo installs them with it.
How do I set it up?
Open Affiliate > Configuration > Settings to set the daily link limit and the websites that run the programme. Under Configuration > UTMs, switch on the sources and mediums affiliates may choose. In the Referral Commission Rules, set what a thousand clicks earn. Then invite affiliates to the Affiliate Program page of your website.
What works well with it?
Sales with Affiliates (required) puts affiliate codes on sales orders; Affiliate Management holds the commission rules, the minimum payout and the payout documents. Affiliate Website CRM Livechat Integration and Affiliate Website Project Integration carry the affiliate into leads and projects.
Can I try it before buying?
Yes - the live demo linked on this page opens the Affiliate Codes list of Affiliate Management, the app this one extends, on a working database.
How do I get support?
Open a ticket at viindoo.com/ticket with your Odoo version and the technical name viin_affiliate_website; pre-sales questions go to viindoo.com/contactus.
See Website Affiliate in Action
Live demo: v19demo-int.viindoo.com/web#action=viin_affiliate.action_affiliate_code
Need help with Website Affiliate?
For questions, implementation support or a custom feature, contact Viindoo.
Pre-Sales & Partnership
viindoo.com/contactusTechnical Support
viindoo.com/ticketUpgrades to a newer Odoo series are a separate purchase for that series.
All Viindoo apps: Viindoo Apps
Technical Requirement
Changes log
1.1.8 - Latest on the 19.0 line
- The Commissions page of the affiliate shows Available for payout, which opens the Payouts page where the affiliate requests a payout.
- The affiliate navigation offers Payouts.
- The Unpaid click column explains what it counts.
- Click commissions keep the amount per thousand clicks they were created with; cancelled clicks lower them.
- Affiliate users generate the click commission of a referrer by hand from the referrer form.
- Commissions on website orders are paid as usual whatever the policy for orders sold by the affiliate.
1.1.6
- Available for Odoo 19.0.
- The affiliate is stamped on the website order at the address step, on the payment page and on express checkout, before the customer pays.
- First-referral-only sales commission, referral cookie lifetime, duplicate clicks from the same IP and the click threshold for removing click commission are commission policy rules, scheduled from an exact date and time.
- Affiliate portal pages run on the Odoo 19 website interactions; performance charts use the Chart.js library shipped with Odoo.
Extend it further
Follow the affiliate beyond the click, into your leads and your projects:
Affiliate Website CRM Livechat Integration
Leads from a live chat or a contact form carry the affiliate code of the link the visitor came through.
Affiliate Website Project Integration
A click burndown chart per affiliate to follow how effective their links are.
Note
Extends Sales with Affiliates - see its documentation: viin_affiliate_sale.
Overview
This guide is for the affiliates who follow their commissions and their payouts on the website, and for the people who run the affiliate programme: the affiliate programme administrator and the affiliate managers and coordinators.
Website Affiliate puts the affiliate programme of Affiliate Management on the website. A visitor registers as an affiliate, creates links with their affiliate code and shares them. The affiliate earns commissions on the orders placed on the website through those links (by default the first confirmed order of each customer) and on the clicks they bring, and follows them on the website, together with the balance available for payout.
| Role | What they do | Access right to assign |
|---|---|---|
| Affiliate | Signs up on the website, creates and shares links, follows the clicks, the commissions and the balance available for payout, and requests a payout. | A portal user whose contact holds an affiliate code |
| Affiliate programme administrator | Sets up the programme on the website: the settings, the sources and mediums of the links, and the amount a thousand clicks earn. | Affiliate / Administrator. To open Affiliate ‣ Configuration ‣ Settings the user also needs Role / Administrator. |
| Affiliate manager | Compares the clicks of all affiliates and generates their click commissions. | Affiliate / User: All affiliates |
| Affiliate coordinator | Does the same for the affiliates they are responsible for. | Affiliate / User: Own affiliates |
Installation
- Navigate to Apps.
- Search with keyword viin_affiliate_website.
- Press Install.
Instruction
Instruction video: Website Affiliate
1. Set up the affiliate programme on the website.
For the affiliate programme administrator.
- Go to Affiliate ‣ Configuration ‣ Settings. Besides the settings of Affiliate Management, the page holds the settings of the website:
- Show Affiliate Code Upon Sign Up: when a visitor registers through a referral link, the sign-up form shows the field of the referral code.
- Limit Creating Link Per Day: the number of links an affiliate can create each day on the website. Enter 0 for no limit.
- Websites: the websites that offer the affiliate programme. Left empty, the programme is available on all websites.
- Go to Affiliate ‣ Configuration ‣ Commission Policies, open the policy in force and press Schedule Policy Change. The Website section holds the values of the website: Only Calculate Sales Commission For First Referral (on by default: only the first confirmed order of a customer earns the affiliate a commission), Affiliate Cookie Lifetime (in seconds), Record Duplicate Clicks IP (a repeat click on the same link from the same IP address is recorded only when it is on) and Limit Clicked Count For Remove Commission (in clicks: when an affiliate deletes a link with fewer clicks than this limit, those clicks are not counted for the commission). Like the other policy values they are locked once commissions use the policy.
- Go to Affiliate ‣ Configuration ‣ UTMs ‣ Sources and Mediums to create the sources and mediums of the links. An affiliate chooses them when creating a link, and only the ones with Available For Affiliate Portal switched on are offered.
- Go to Affiliate ‣ Configuration ‣ Commission Rules ‣ Referral Commission Rules and press New to set what a thousand clicks earn. Choose the Referral Source Online and enter the Amount Per Thousand Clicks. Fill the Affiliates field to give the rule to chosen affiliates only.
2. Follow the commissions and the balance available for payout.
For the affiliates.
The affiliate signs in on the website and uses the affiliate navigation: Affiliate Links, Commissions, Payouts and Performance analysis.
- The Commissions page opens with the Overview: Total commission, Total unpaid commission, the unpaid commissions from sale orders and from clicks, and Available for payout. Available for payout is the confirmed commission not yet on a bill or receipt, minus the deductions waiting for the next payout. For a sales order only the part the customer has paid counts. Press it, or Payouts in the navigation, to open the Payouts page. The information icon next to Overview explains each figure.
- The Clicks tab lists, for each affiliate link, the Total click, the Unpaid click, the Verified clicks and the Cancelled clicks. Move the pointer over the icon of a column to read what it counts: Unpaid click counts the confirmed clicks not yet included in a bill or receipt.
- The Payouts page shows the balance available for payout, the minimum payout and the payout documents of the affiliate, and holds the Request payout button. A request creates a draft vendor bill or purchase receipt that finance validates and pays like any vendor document. The page is described in the Affiliate Management documentation.
3. Compare the clicks of the affiliates.
For the affiliate managers and coordinators.
Go to Affiliate ‣ Affiliate ‣ Affiliate Codes. Press the icon of the optional columns at the right of the list header and tick Website Visitor Count, Clicked Count, Human Clicked Count, Bot Clicked Count, Confirmed Click Count and Cancelled Click Count to compare the visitors and the clicks of each affiliate.
The reports of the Affiliate ‣ Reports menu are described in the Affiliate Management documentation.
4. Generate the click commission of a referrer.
For the affiliate managers and coordinators.
Every click on an affiliate link is recorded, except a repeat click on the same link from the same IP address (unless Record Duplicate Clicks IP is on in the commission policy); clicks of bots are set aside, and the human clicks of an affiliate gather in an online referrer: Affiliate ‣ Referrer ‣ Online Referrer, whose Clicks button lists them. When an online referrer holds 1000 confirmed clicks that no commission counts yet, its commission is created and confirmed automatically. To pay fewer clicks, generate the commission by hand:
- Open the referrer in Affiliate ‣ Referrer ‣ Online Referrer.
- If its status is Draft, press Confirm.
- Press Generate Referral Commission, then Confirm in the dialog. The button is shown while the referrer has confirmed clicks that no commission counts yet.
The commission opens with the status Confirmed. Its amount is the number of confirmed clicks multiplied by the amount of one click, which is the Amount Per Thousand Clicks of the rule divided by 1000. A rule restricted to the affiliate wins over the general rule.
The commission keeps the amount per thousand clicks that applied when it was created: editing the rule changes only the commissions created afterwards. A cancelled click no longer counts, so cancelling clicks lowers the commission, which pays only the confirmed clicks. To cancel a click, open it from the Clicks button of the referrer, press Cancel and give the reason. What was already billed for the cancelled clicks is taken back as a clawback, as described in the Affiliate Management documentation.
5. Orders placed on the website.
For the affiliate programme administrator and the affiliate managers.
A visitor who follows an affiliate link and orders on the website earns the commission of the order for that affiliate. A website order has no seller: the salesperson assigned to the order never makes the affiliate its seller. The commission is therefore paid as usual whatever the value of When the Seller Is the Affiliate in the commission policy (Pay, Hold for review or Do not pay): it is confirmed, and its Own Sale column does not show Seller is the affiliate. By default only the first confirmed order of a customer earns the affiliate a commission: the later orders of that customer placed through a link carry no affiliate. Turn off Only Calculate Sales Commission For First Referral in the Website section of the commission policy to pay every order. When the customer of the order is the affiliate, the rule of Sales with Affiliates for such orders applies.
This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file).
You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one).
It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software.
The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
