You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

105 lines
4.6 KiB

  1. ===============
  2. Loyalty Program
  3. ===============
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github
  15. :target: https://github.com/OCA/pos/tree/11.0/pos_loyalty
  16. :alt: OCA/pos
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/pos-11-0/pos-11-0-pos_loyalty
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/184/11.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module allows you to define a loyalty program in the point of sale,
  25. where the customers earn loyalty points and get rewards.
  26. This module is a forward-port to v10 of the pos_loyalty module from Odoo's
  27. saas-6 branch.
  28. The functionality was moved to the Enterprise edition in later versions.
  29. **Table of contents**
  30. .. contents::
  31. :local:
  32. Configuration
  33. =============
  34. To use this module, you need to:
  35. * Go to *Point of Sale > Configuration > Loyalty Programs* and define a new loyalty program with specific rules and rewards.
  36. * Assign the loyalty program to the desired Point of Sale.
  37. Usage
  38. =====
  39. The Loyalty Program defines rules for acquiring points and rewards on which they can be spent.
  40. Rules can be defined globally for all products (fields on loyalty.program) and / or rules that are applied only on specific product or PoS category (loyalty.rule records) on a *points per product sold* or *points per currency spent* basis. The specific rules (loyalty.rule) can be defined as cumulative, which means that they will be aggregated with other matching rules (loyalty.rule records and loyalty.program fields). In the case of non-cumulative rules only the points from that one matching rule are used. Additionally, *fixed points per order* can be added which are applied regardless of whether or not cumulative or non-cumulative rules were applied also.
  41. Rewards can be of three types:
  42. * *Gift* - give a single unit of product for free
  43. * *Discount* - give a discount to the whole order. It should be added at the end of the order so that the correct total price is used.
  44. * *Resale* - allow for customer to sell back his earned points. These are calculated by setting the price on the Resale product (*resale_product.list_price* * *customer.loyalty_points*)
  45. All rewards can define how many points they cost (point_cost) and how many are needed so that the customer can become eligable for the reward (minimum_points). for Gift and Discount rewards minimum_points are considered only if they are greater then the point_cost for that reward (minimum_points > point_cost). For Resale products only minimum_points can be used.
  46. Bug Tracker
  47. ===========
  48. Bugs are tracked on `GitHub Issues <https://github.com/OCA/pos/issues>`_.
  49. In case of trouble, please check there if your issue has already been reported.
  50. If you spotted it first, help us smashing it by providing a detailed and welcomed
  51. `feedback <https://github.com/OCA/pos/issues/new?body=module:%20pos_loyalty%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  52. Do not contact contributors directly about support or help with technical issues.
  53. Credits
  54. =======
  55. Authors
  56. ~~~~~~~
  57. * OpenERP SA
  58. * RGB Consulting SL
  59. * Lambda IS
  60. Contributors
  61. ~~~~~~~~~~~~
  62. * RGB Consulting SL (http://www.rgbconsulting.com)
  63. * Forward-port from Odoo SA saas-6 branch
  64. * Kiril Vangelovski <kiril@lambda-is.com>
  65. Maintainers
  66. ~~~~~~~~~~~
  67. This module is maintained by the OCA.
  68. .. image:: https://odoo-community.org/logo.png
  69. :alt: Odoo Community Association
  70. :target: https://odoo-community.org
  71. OCA, or the Odoo Community Association, is a nonprofit organization whose
  72. mission is to support the collaborative development of Odoo features and
  73. promote its widespread use.
  74. This module is part of the `OCA/pos <https://github.com/OCA/pos/tree/11.0/pos_loyalty>`_ project on GitHub.
  75. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.