Author: |
LasLabs, Odoo Community Association (OCA), Versada |
License: |
LGPL-3 |
Branch: |
11.0-mig-website_sale_affiliate |
Repository: |
versada/e-commerce |
Dependencies: |
sale,
and
website_sale |
Languages: |
PO File (8432, 89.8%),
Python (707, 7.5%),
XML (207, 2.2%),
and
reStructuredText (46, 0.5%) |
Other branches: |
10.0 |
Other repositories: |
AITIC/e-commerce,
AbrahamTrey/e-commerce,
BillTheBest/e-commerce,
CB-Gran-Canaria/e-commerce,
Callino/e-commerce,
Change2improve/e-commerce,
ClearCorp/oca-e-commerce,
Dobtor-OCA/e-commerce,
Dreamsting/e-commerce,
ERPLibre/e-commerce,
ForgeFlow/e-commerce,
Gabinete-Digital/e-commerce,
Gofekra/e-commerce,
Ingeos/e-commerce,
JuanjoA/e-commerce,
KolushovAlexandr/e-commerce,
LasLabs/e-commerce,
LeaMartinek/e-commerce,
LevelPrime/e-commerce,
MadsackMediaStore/e-commerce,
MariajMesa/e-commerce,
MathBenTech/e-commerce,
Mefistous/e-commerce,
NeatNerdPrime/e-commerce,
NextERP-Romania/e-commerce,
Nitrokey/odoo-e-commerce,
Nitrokey/odoo-modules,
Numigi/e-commerce,
OCA-MUK/e-commerce,
OCA/e-commerce,
ORETEK/e-commerce,
OpenPymeMx/e-commerce,
RosleStores/e-commerce,
SanteLibre/e-commerce,
SequarSrl/e-commerce,
SetRac/e-commerce,
SimoRubi/e-commerce,
Spearhead-Odoo/e-commerce,
SportPursuit/e-commerce,
Strusovsky/e-commerce,
TDu/e-commerce,
TRESCLOUD/e-commerce,
Tecnativa/e-commerce,
TimotheeBa/e-commerce,
VisiionSolucionesTecnologicas/e-commerce,
aaltinisik/e-commerce,
acsone/e-commerce,
agrista/odoo-e-commerce,
akretion/e-commerce,
alfa2267/e-commerce,
anhvu-sg/e-commerce,
antilhue/e-commerce,
apetbiz/e-commerce,
ateneolab/e-commerce,
aurestic/e-commerce,
bacgroup/e-commerce,
billrich126/e-commerce,
brain-tec/e-commerce,
bvkl/e-commerce,
camptocamp/e-commerce,
celm1990/e-commerce,
coopiteasy/e-commerce,
cor9003/e-commerce,
daramousk/e-commerce,
digitalliuzg/e-commerce,
dkrimmer84/e-commerce,
durvilchat/e-commerce,
eLBati/e-commerce,
ernestotejeda/e-commerce,
exosoftware/oca-e-commerce,
fallewi/e-commerce,
fanguloa/e-commerce,
fcayre/e-commerce,
flotho/e-commerce,
francoisdelarbre/e-commerce,
george-taotaome/e-commerce,
grap/e-commerce,
grindtildeath/e-commerce,
haroldtamo/e-commerce,
iRichGit/e-commerce,
iledarn/e-commerce,
isoscl/e-commerce,
it-projects-llc/e-commerce,
itblabla/e-commerce,
jetrosantos26/e-commerce,
jromeroarg/e-commerce,
killvis/e-commerce,
larmar/e-commerce,
lfreeke/e-commerce,
lideritjnma/e-commerce,
lodeblomme/e-commerce,
maitaoriana/e-commerce,
mamcode/e-commerce,
mettadipa/e-commerce,
minhhq09/e-commerce,
moltisinc/e-commerce,
monksoftware/e-commerce,
myceliandre/e-commerce,
nanxiaomo/e-commerce,
necrodevz/e-commerce,
nhomar/e-commerce,
njeudy/e-commerce,
noorealam96/e-commerce,
nucleoosystem/e-commerce,
odoosoft/e-commerce,
onurugur/e-commerce,
oscarolar/e-commerce,
oxidos/e-commerce,
pscloud/e-commerce,
rjpathan/e-commerce,
rohitramnani1994/e-commerce,
rruebner/e-commerce,
rsullivan2704/e-commerce,
saas-addons/e-commerce,
saigonsofttech/e-commerce,
samsagaz/e-commerce,
sanube/e-commerce,
sendalpegat/e-commerce,
shivaniamrutiya/e-commerce,
simahawk/e-commerce,
skmezanul/e-commerce,
smellems/e-commerce,
soongxueyong/e-commerce,
steingabelgaard/e-commerce,
support-atharva/e-commerce,
suryaprakashreddyk/e-commerce,
sylvainvh/e-commerce,
tafaRU/e-commerce,
tarteo/e-commerce,
valmarnet/e-commerce,
vdedyukhin/e-commerce,
wahello/e-commerce,
wtaferner/e-commerce,
x0rzkov/odoo-e-commerce-automation,
xichun/e-commerce,
xuanox/e-commerce,
yelizariev/e-commerce,
ygenofficial/e-commerce,
yogesh-serpentcs/e-commerce,
yusniermatos/e-commerce,
and
zeroheure/e-commerce |
<a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.svg">
</a>
<a name="affiliate-program"></a>
<h2>Affiliate Program</h2>
<p>This module allows for the creation of affiliates and the tracking of sales conversions generated by them.</p>
<a name="usage"></a>
<h3>Usage</h3>
<p>To use this module, you must first create at least one affiliate (found in Sales/Affiliate Program).</p>
<p>Once an affiliate has been created, append one of the following to a compatible shop or product url (see below) to track the affiliate's conversions:</p>
<ul class="simple">
<li>?aff_ref=<em>affiliate_id</em></li>
<li>?aff_ref=<em>affiliate_id</em>&aff_key=<em>custom_key</em></li>
</ul>
<p>The "affiliate_id" is the ID displayed on the affiliate's record, e.g. "1".</p>
<p>The "custom_key" (optional) is a url-friendly string of your choice used to track a specific campaign, e.g. "anniversary_sale". Associated affiliate requests will be named after this key, if provided.</p>
<p><strong>Example:</strong> /shop?aff_ref=1&aff_key=anniversary_sale</p>
<a name="compatible-urls"></a>
<h4>Compatible URLs</h4>
<ul class="simple">
<li>/shop</li>
<li>/shop/category/{category}</li>
<li>/shop/category/{category}/page/{page}</li>
<li>/shop/page/{page}</li>
<li>/shop/product/{product}</li>
</ul>
<a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/113/10.0"><img alt="Try me on Runbot" src="https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas" /></a>
<a name="known-issues-roadmap"></a>
<h3>Known issues / Roadmap</h3>
<ul class="simple">
<li>Evaluate usefulness of IP as a fallback affiliate request identifier</li>
</ul>
<a name="bug-tracker"></a>
<h3>Bug Tracker</h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/e-commerce/issues">GitHub Issues</a>. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.</p>
<a name="credits"></a>
<h3>Credits</h3>
<a name="images"></a>
<h4>Images</h4>
<ul class="simple">
<li>Odoo Community Association: <a class="reference external" href="https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg">Icon</a>.</li>
</ul>
<a name="contributors"></a>
<h4>Contributors</h4>
<ul class="simple">
<li>Brent Hughes <<a class="reference external" href="mailto:brent.hughes@laslabs.com">brent.hughes@laslabs.com</a>></li>
<li>Darko Nikolovski <<a class="reference external" href="mailto:darko@versada.eu">darko@versada.eu</a>></li>
</ul>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="maintainer"></a>
<h4>Maintainer</h4>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>This module is maintained by the OCA.</p>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>To contribute to this module, please visit <a class="reference external" href="https://odoo-community.org">https://odoo-community.org</a>.</p>