Metadata-Version: 2.1
Name: odoo-addon-base_delivery_carrier_label
Version: 17.0.1.1.0
Requires-Python: >=3.10
Requires-Dist: odoo-addon-delivery_carrier_info>=17.0dev,<17.1dev
Requires-Dist: odoo>=17.0a,<17.1dev
Summary: Base module for carrier labels
Home-page: https://github.com/OCA/delivery-carrier
License: AGPL-3
Author: Camptocamp,Akretion,Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 17.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3

==============================
Base module for carrier labels
==============================

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

.. |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/licence-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-OCA%2Fdelivery--carrier-lightgray.png?logo=github
    :target: https://github.com/OCA/delivery-carrier/tree/17.0/base_delivery_carrier_label
    :alt: OCA/delivery-carrier
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/delivery-carrier-17-0/delivery-carrier-17-0-base_delivery_carrier_label
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/delivery-carrier&target_branch=17.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module adds some function and generic stuff to help for carrier
label generation. For example it adds the concept of option on carriers
that can differ depending on the picking or class to store carrier
accounts This module doesn't do anything by itself, it serves as a base
module for other carrier-specific modules.

**Table of contents**

.. contents::
   :local:

Configuration
=============

By default, automatic packaging is enabled.

You can disable it in Inventory / Configuration / Settings, by searching
"Default Packages".

When active, pickings without assigned packages will be grouped into a
single one for shipping. This ensures compatibility with connectors that
require at least one package to generate labels or tracking references.

   **NOTE:** If the Number of Packages field is manually set but no real
   packages are defined, this feature overrides it and creates only one
   package. This may cause confusion when relying solely on that field
   instead of using Odoo’s standard package objects.

Usage
=====

\*\* How does it works ? \*\*

In picking UI a button "Send to shipper" trigger label generation
calling send_to_shipper() in models/stock.picking.py

\*\* How to implement my own carrier ? \*\*

Define a method {carrier}_send_shipping() which is called by
\_send_shipping native method. Make it return a list of dict of this
form :

.. code:: python

   {
       "exact_price": price,
       "tracking_number": 'number'
       "labels": [{
           "package_id": package_id,
           "name": filename,
           "datas": file_content (base64),
           "file_type": extension,
           "tracking_number": package_number
       }]
   }

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/delivery-carrier/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/OCA/delivery-carrier/issues/new?body=module:%20base_delivery_carrier_label%0Aversion:%2017.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
-------

* Camptocamp
* Akretion

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

- David BEAL <david.beal@akretion.com>
- Sébastien BEAU <sebastien.beau@akretion.com>
- Yannick Vaucher <yannick.vaucher@camptocamp.com>
- Alexis de Lattre <alexis.delattre@akretion.com>
- Angel Moya <angel.moya@pesol.es>
- Ismael Calvo <ismael.calvo@factorlibre.com>
- Dave Lasley <dave@laslabs.com>
- Timothée Ringeard <timothee.ringeard@camptocamp.com>
- Pimolnat Suntian <pimolnats@ecosoft.co.th>
- Maksym Yankin <maksym.yankin@camptocamp.com>
- `Binhex <https://binhex.cloud//com>`__:

  - David Luis Mora <d.luis@binhex.cloud>

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

This module is maintained by the OCA.

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

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.

This module is part of the `OCA/delivery-carrier <https://github.com/OCA/delivery-carrier/tree/17.0/base_delivery_carrier_label>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
