Metadata-Version: 2.1
Name: odoo-addon-shopinvader_api_sale_loyalty
Version: 18.0.1.0.0.2
Requires-Python: >=3.10
Requires-Dist: odoo-addon-extendable_fastapi==18.0.*
Requires-Dist: odoo-addon-pydantic==18.0.*
Requires-Dist: odoo-addon-sale_loyalty_order_info==18.0.*
Requires-Dist: odoo-addon-shopinvader_api_cart==18.0.*
Requires-Dist: odoo==18.0.*
Summary: FastAPI services to add coupons and loyalties to carts.
Home-page: https://github.com/shopinvader/odoo-shopinvader
License: AGPL-3
Author: ACSONE SA/NV
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

============================
Shopinvader API Sale Loyalty
============================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:af82706c937567973407969e157b81b34745f107ae4161dd5604d8e348ed7fbb
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-shopinvader%2Fodoo--shopinvader-lightgray.png?logo=github
    :target: https://github.com/shopinvader/odoo-shopinvader/tree/18.0/shopinvader_api_sale_loyalty
    :alt: shopinvader/odoo-shopinvader

|badge1| |badge2| |badge3|

This module extends the functionality of Shopinvader to support Coupons
and Promotions from sale_loyalty core module. It is the new version
providing FastAPI services.

Not to be confused with shopinvader_promotion_rule, that implements
promotion programs from OCA module sale_promotion_rule, an alternative
to the core sale_loyalty module.

Available services:

- ``/loyalty/{code}`` under the ``loyalty`` router, to get all rewards
  claimable with a given coupon code
- ``/coupon`` under the ``cart`` router, to apply a given coupon to the
  cart. Allows to specify which reward and/or which free product to
  offer.
- ``/reward`` under the ``cart`` router, to apply a given reward
  (automatic promotion). Note that automatic promotions are applied
  automatically at cart update, when possible (if no choice must be
  done). This service allows to apply an automatic promotion for which
  the reward/free product choice is mandatory.

**Table of contents**

.. contents::
   :local:

Usage
=====

This addons provides 2 new routers: loyalty_router and
sale_loyalty_cart_router. The sale_loyalty_cart_router is declared with
the same tags as the one defined in the shopinvader_api_cart addon. As
this one, no prefix is added to the router, to allow to mount it as a
nested app. See the README of shopinvader_api_cart for more details on
how to do it.

As all api addons, installing this addon will not have any effect on the
existing fastapi app. You must add the routers to the app by yourself by
editing your fastapi.endpoint where you want to add the routes.

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

Bugs are tracked on `GitHub Issues <https://github.com/shopinvader/odoo-shopinvader/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/shopinvader/odoo-shopinvader/issues/new?body=module:%20shopinvader_api_sale_loyalty%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

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

Credits
=======

Authors
-------

* ACSONE SA/NV

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

- `Camptocamp <https://www.camptocamp.com>`__

  - Iván Todorovich <ivan.todorovich@gmail.com>

- `Acsone <https://www.acsone.eu>`__

  - Marie Lejeune <marie.lejeune@acsone.eu>

Maintainers
-----------

This module is part of the `shopinvader/odoo-shopinvader <https://github.com/shopinvader/odoo-shopinvader/tree/18.0/shopinvader_api_sale_loyalty>`_ project on GitHub.

You are welcome to contribute.
