Base module for carrier labels

Beta License: AGPL-3 OCA/delivery-carrier Translate me on Weblate Try me on Runboat

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

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 :

{
    "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. 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.

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

Credits

Authors

  • Camptocamp
  • Akretion

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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 project on GitHub.

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