Metadata-Version: 2.0
Name: odoo10-addon-website-sale-affiliate
Version: 10.0.1.0.0.99.dev1
Summary: Module summary
Home-page: https://laslabs.com
Author: LasLabs, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
License: LGPL-3
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Requires-Python: ~=2.7
Requires-Dist: odoo (<10.1dev,>=10.0)

.. image:: https://img.shields.io/badge/licence-LGPL--3-blue.svg
   :target: http://www.gnu.org/licenses/lgpl
   :alt: License: LGPL-3

=================
Affiliate Program
=================

This module allows for the creation of affiliates and the tracking of sales conversions generated by them.

Usage
=====

To use this module, you must first create at least one affiliate (found in Sales/Affiliate Program).

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:

* ?aff_ref=\ *affiliate_id*
* ?aff_ref=\ *affiliate_id*\&aff_key=\ *custom_key*

The "affiliate_id" is the ID displayed on the affiliate's record, e.g. "1".

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.

**Example:** /shop?aff_ref=1&aff_key=anniversary_sale

Compatible URLs
---------------

* /shop
* /shop/category/{category}
* /shop/category/{category}/page/{page}
* /shop/page/{page}
* /shop/product/{product}

.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
   :alt: Try me on Runbot
   :target: https://runbot.odoo-community.org/runbot/113/10.0

Known issues / Roadmap
======================

* Evaluate usefulness of IP as a fallback affiliate request identifier

Bug Tracker
===========

Bugs are tracked on `GitHub Issues
<https://github.com/OCA/e-commerce/issues>`_. 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.

Credits
=======

Images
------

* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.

Contributors
------------

* Brent Hughes <brent.hughes@laslabs.com>

Do not contact contributors directly about support or help with technical issues.

Maintainer
----------

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

This module is maintained by the OCA.

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.

To contribute to this module, please visit https://odoo-community.org.


