Author: |
GRAP |
License: |
AGPL-3 |
Branch: |
12.0 |
Repository: |
grap/grap-odoo-business |
Dependencies: |
base,
l10n_fr_department,
product,
product_label,
product_origin_l10n_fr_department,
product_standard_margin,
queue_job,
sale,
sale_recovery_moment,
and
uom |
Languages: |
PO File (305, 13.8%),
Python (1145, 51.9%),
XML (623, 28.2%),
and
reStructuredText (133, 6.0%) |
Other branches: |
8.0 |
Other repositories: |
OdooBulgaria/odoo-addons-misc,
Supercagette/odoo-addons-misc,
bealdav/odoo-addons-misc,
dhecar/odoo-addons-misc,
grap/odoo-addons-misc,
legalsylvain/odoo-addons-misc,
minimedj/odoo-addons-misc,
mohamedhagag/odoo-addons-misc,
quentinDupont/odoo-addons-misc,
rkhalil1990/odoo-addons-misc,
and
salahable/odoo-addons-misc |
<h1 class="title">Sale - eShop</h1>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/grap/grap-odoo-business/tree/12.0/sale_eshop"><img alt="grap/grap-odoo-business" src="https://img.shields.io/badge/github-grap%2Fgrap--odoo--business-lightgray.png?logo=github" /></a></p>
<p>This module is the 'odoo' part of the project Odoo eShop.</p>
<p>the 'client' part is available here : <a class="reference external" href="https://github.com/grap/odoo-eshop">https://github.com/grap/odoo-eshop</a></p>
<a name="eshop-categories"></a>
<h2>eShop Categories</h2>
<p>Add a new model <code>eshop.category</code> to have the possibility to dispatch products
for the eshop.</p>
<div class="figure">
<img alt="https://raw.githubusercontent.com/grap/grap-odoo-business/12.0/sale_eshop/static/description/eshop_category_tree.png" src="https://raw.githubusercontent.com/grap/grap-odoo-business/12.0/sale_eshop/static/description/eshop_category_tree.png" style="width: 800px;" />
</div>
<div class="figure">
<img alt="https://raw.githubusercontent.com/grap/grap-odoo-business/12.0/sale_eshop/static/description/eshop_category_form.png" src="https://raw.githubusercontent.com/grap/grap-odoo-business/12.0/sale_eshop/static/description/eshop_category_form.png" style="width: 800px;" />
</div>
<a name="customers"></a>
<h2>Customers</h2>
<p>Add new fields on <code>res.partner</code> to handle authentication on the eshop.
It is maid with a couple <code>email</code> and <code>eshop_password</code>.</p>
<div class="figure">
<img alt="https://raw.githubusercontent.com/grap/grap-odoo-business/12.0/sale_eshop/static/description/res_partner_form.png" src="https://raw.githubusercontent.com/grap/grap-odoo-business/12.0/sale_eshop/static/description/res_partner_form.png" style="width: 800px;" />
</div>
<a name="products"></a>
<h2>Products</h2>
<p>Add new fields on <code>product.product</code> that handles display on eShop.</p>
<ul class="simple">
<li>'eShop Category': category in the eShop</li>
<li>'Start date' and 'End Date' to disable temporarily the sale on the eShop</li>
<li>'Minimum Quantity', that will force user to buy at least that quantity</li>
<li>'Rounded Quantity', that will round quantity purchased</li>
</ul>
<p>Furthermore, it is possible to allow consumers to buy less than the minimum
quantity, setting 'Unpack Quantity' value. In that case, a surcharge can
be applied in the field 'Unpack Surcharge'.</p>
<div class="figure">
<img alt="https://raw.githubusercontent.com/grap/grap-odoo-business/12.0/sale_eshop/static/description/product_product_form.png" src="https://raw.githubusercontent.com/grap/grap-odoo-business/12.0/sale_eshop/static/description/product_product_form.png" style="width: 800px;" />
</div>
<a name="companies"></a>
<h2>Companies</h2>
<p>General settings are available via company form.</p>
<div class="figure">
<img alt="https://raw.githubusercontent.com/grap/grap-odoo-business/12.0/sale_eshop/static/description/res_company_form.png" src="https://raw.githubusercontent.com/grap/grap-odoo-business/12.0/sale_eshop/static/description/res_company_form.png" style="width: 800px;" />
</div>
<p>The important fields are :</p>
<ul class="simple">
<li>'has Eshop', that enable all the connexion</li>
<li>'eShop URL'</li>
<li>'Invalidation Cache URL', to enable invalidation cache system. (see below)</li>
</ul>
<p>Some of cosmectics fields are available in a wizard, to be change by end users.</p>
<p>you have to go in 'Sale' / 'Configuration' / 'eShop Sale' / 'eShop Settings'</p>
<div class="figure">
<img alt="https://raw.githubusercontent.com/grap/grap-odoo-business/12.0/sale_eshop/static/description/wizard_res_company_eshop_setting_form.png" src="https://raw.githubusercontent.com/grap/grap-odoo-business/12.0/sale_eshop/static/description/wizard_res_company_eshop_setting_form.png" style="width: 800px;" />
</div>
<a name="other-models"></a>
<h2>Other models</h2>
<p>Furthermore, other models like <code>account.tax</code> has extra fields that will
be displayed on the eshop.</p>
<a name="technical-informations"></a>
<h2>Technical Informations</h2>
<ul class="simple">
<li>The connection from the eShop into odoo, is made with a unique user, that
has to be member of the group "Is eShop".
Then, an extra authentication is available via partners.</li>
<li>Some datas are cached by the eShop, to avoid useless call to odoo. So,
if data changes, the cached should be invalidated. for that purpose,
an extra abstract model <code>eshop.mixin</code> is available. Models synchronized
with eShop should inherit of that model, and defined two values :</li>
</ul>
<ol class="arabic simple">
<li><code>_eshop_invalidation_type</code> : <code>single</code> / <code>multiple</code> to indicate
if all the eShops should be invalidated, or only the one of the current
object</li>
<li><code>_eshop_invalidation_fields</code> : the list of the fields that trigger
invalidation</li>
</ol>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#installation" id="id1">Installation</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a></li>
</ul>
</div>
<a name="installation"></a>
<h3><a class="toc-backref" href="#id1">Installation</a></h3>
<p>If <code>auth_admin_passkey</code> is installed, and correctly set,
the authentication in the eshop can be used with the file password,
present in the key <code>auth_admin_passkey_password</code>.</p>
<a name="known-issues-roadmap"></a>
<h3><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h3>
<p>For the time being, password are not encrypted in the database, for
the partner authentication.</p>
<a name="bug-tracker"></a>
<h3><a class="toc-backref" href="#id3">Bug Tracker</a></h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/grap/grap-odoo-business/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 smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/grap/grap-odoo-business/issues/new?body=module:%20sale_eshop%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="credits"></a>
<h3><a class="toc-backref" href="#id4">Credits</a></h3>
<a name="authors"></a>
<h2>Authors</h2>
<ul class="simple">
<li>GRAP</li>
</ul>
<a name="contributors"></a>
<h2>Contributors</h2>
<ul class="simple">
<li>Sylvain LE GAL (<a class="reference external" href="https://www.twitter.com/legalsylvain">https://www.twitter.com/legalsylvain</a>)</li>
</ul>
<a name="maintainers"></a>
<h2>Maintainers</h2>
<p>This module is part of the <a class="reference external" href="https://github.com/grap/grap-odoo-business/tree/12.0/sale_eshop">grap/grap-odoo-business</a> project on GitHub.</p>
<p>You are welcome to contribute.</p>