odoo-addon-delivery-cbl


Nameodoo-addon-delivery-cbl JSON
Version 17.0.1.0.0.7 PyPI version JSON
download
home_pagehttps://github.com/OCA/delivery-carrier
SummaryIntegrate CBL webservice
upload_time2025-08-05 02:48:20
maintainerNone
docs_urlNone
authorSygel, Odoo Community Association (OCA)
requires_python>=3.10
licenseAGPL-3
keywords
VCS
bugtrack_url
requirements openupgradelib roulier
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

============
Delivery CBL
============

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

.. |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-OCA%2Fdelivery--carrier-lightgray.png?logo=github
    :target: https://github.com/OCA/delivery-carrier/tree/17.0/delivery_cbl
    :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-delivery_cbl
    :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 `CBL <https://https://www.cbl-logistica.com/>`__ to the
available carriers.

The following operations are supported:

- Register shippings
- Generate shipping labels when shippings are registered. The PDF is
  generated using the labelary API (http://api.labelary.com/).
- Validate shippings (both manually and automatically)
- Cancel shippings
- Generate de CBL Manifest

**Table of contents**

.. contents::
   :local:

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

To configure this module, you need to:

1. Add a Shipping Method with Provider ``CBL`` and introduce the User,
   Password, Client Code and Client Token.
2. Activate the "Cash On Delivery" option if shippings are paid by cash,
   assuming that the picking has a related sales order.
3. Activate the "Needs Confirmation" option if shippings need to be
   confirmed after the tracking number is created in order to be
   oficially included in the CBL pending shippings database. It is
   crucial to have the same configuration both in Odoo and in your CBL
   account. Contact CBL for more information on how they can configure
   this feature.

**NOTE** Contact CBL to get testing credentials.

Usage
=====

To carry out the shipment, the shipping method previously created must
be set on the delivery order:

- Once the outgoing delivery is “Validated (Done)", the shipping
  information is automatically transmitted to CBL. If everything is
  correct, a tracking number and the corresponding labels are generated.
- Shipments can be cancelled by clicking the "Cancel" button located
  next to the picking's tracking number. Keep in mind that using a
  carrier with the "Needs Confirmation" option unchecked, while having
  the opposite configuration set in CBL, may cause issues when
  attempting to cancel a shipment. In such cases, contact CBL so they
  can adjust the confirmation policy accordingly.
- If a shipment could not be generated or has been cancelled, a new one
  can be created by clicking the "Send to Shipper" button at the top of
  the stock picking.
- Shipments that require confirmation after the tracking number has been
  assigned can be confirmed as follows:

  - Individually: By clicking the "Confirm" button in the "Tracking
    Number" field, located under the "Additional Info" tab within the
    "Shipping Information" section.
  - [Improved] Bulk method: In the list view of outgoing deliveries,
    select all deliveries for the carrier whose status is “Validated
    (Done)", click the "Actions" gear icon → "Confirm CBL pickings". A
    wizard will appear listing the deliveries to be confirmed. Verify
    that all required pickings are included, then click the "Confirm
    Shipments" button.
  - Additionally, there is a scheduled action ("CBL: Confirm Shipments")
    that automatically validates pending CBL shipments once per day by
    default.

- To generate the manifest, you need to Inventory > Operation >
  Manifest, select a CBL carrier and set the date range to select the
  picking.

Known issues / Roadmap
======================

- During the development of the shipping label generation feature, we
  initially evaluated the use of the Zebrafy library to convert ZPL
  labels into PDF format. However, Zebrafy is based on the presence of
  graphic fields (^GF) in the ZPL source, which are not always included
  in the labels generated by CBL.
- To ensure broader compatibility, it's opted to use the external
  service Labelary.com, returns the corresponding label in PDF format
  via an HTTP request.
- To provide flexibility, a new field cbl_label_format has been added to
  the delivery.carrier model, allowing the user to select between ZPL
  (default) and PDF formats. The method cdl_generate_labels will only
  invoke the external Labelary service if the selected format is PDF.
  Otherwise, the label is stored directly in ZPL format without any
  transformation.

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:%20delivery_cbl%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
-------

* Sygel

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

- Manuel Regidor manuel.regidor@sygel.es
- Valentín Vinagre valentin.vinagre@sygel.es
- Ángel Rivas angel.rivas@sygel.es

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/delivery_cbl>`_ project on GitHub.

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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/OCA/delivery-carrier",
    "name": "odoo-addon-delivery-cbl",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Sygel, Odoo Community Association (OCA)",
    "author_email": "support@odoo-community.org",
    "download_url": null,
    "platform": null,
    "description": ".. image:: https://odoo-community.org/readme-banner-image\n   :target: https://odoo-community.org/get-involved?utm_source=readme\n   :alt: Odoo Community Association\n\n============\nDelivery CBL\n============\n\n.. \n   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n   !! This file is generated by oca-gen-addon-readme !!\n   !! changes will be overwritten.                   !!\n   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n   !! source digest: sha256:30ab49cd70622be624b11de2613b9601f6f4382cd7496431703ef0f065340536\n   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n    :target: https://odoo-community.org/page/development-status\n    :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png\n    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n    :alt: License: AGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fdelivery--carrier-lightgray.png?logo=github\n    :target: https://github.com/OCA/delivery-carrier/tree/17.0/delivery_cbl\n    :alt: OCA/delivery-carrier\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n    :target: https://translation.odoo-community.org/projects/delivery-carrier-17-0/delivery-carrier-17-0-delivery_cbl\n    :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n    :target: https://runboat.odoo-community.org/builds?repo=OCA/delivery-carrier&target_branch=17.0\n    :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nThis module adds `CBL <https://https://www.cbl-logistica.com/>`__ to the\navailable carriers.\n\nThe following operations are supported:\n\n- Register shippings\n- Generate shipping labels when shippings are registered. The PDF is\n  generated using the labelary API (http://api.labelary.com/).\n- Validate shippings (both manually and automatically)\n- Cancel shippings\n- Generate de CBL Manifest\n\n**Table of contents**\n\n.. contents::\n   :local:\n\nConfiguration\n=============\n\nTo configure this module, you need to:\n\n1. Add a Shipping Method with Provider ``CBL`` and introduce the User,\n   Password, Client Code and Client Token.\n2. Activate the \"Cash On Delivery\" option if shippings are paid by cash,\n   assuming that the picking has a related sales order.\n3. Activate the \"Needs Confirmation\" option if shippings need to be\n   confirmed after the tracking number is created in order to be\n   oficially included in the CBL pending shippings database. It is\n   crucial to have the same configuration both in Odoo and in your CBL\n   account. Contact CBL for more information on how they can configure\n   this feature.\n\n**NOTE** Contact CBL to get testing credentials.\n\nUsage\n=====\n\nTo carry out the shipment, the shipping method previously created must\nbe set on the delivery order:\n\n- Once the outgoing delivery is \u201cValidated (Done)\", the shipping\n  information is automatically transmitted to CBL. If everything is\n  correct, a tracking number and the corresponding labels are generated.\n- Shipments can be cancelled by clicking the \"Cancel\" button located\n  next to the picking's tracking number. Keep in mind that using a\n  carrier with the \"Needs Confirmation\" option unchecked, while having\n  the opposite configuration set in CBL, may cause issues when\n  attempting to cancel a shipment. In such cases, contact CBL so they\n  can adjust the confirmation policy accordingly.\n- If a shipment could not be generated or has been cancelled, a new one\n  can be created by clicking the \"Send to Shipper\" button at the top of\n  the stock picking.\n- Shipments that require confirmation after the tracking number has been\n  assigned can be confirmed as follows:\n\n  - Individually: By clicking the \"Confirm\" button in the \"Tracking\n    Number\" field, located under the \"Additional Info\" tab within the\n    \"Shipping Information\" section.\n  - [Improved] Bulk method: In the list view of outgoing deliveries,\n    select all deliveries for the carrier whose status is \u201cValidated\n    (Done)\", click the \"Actions\" gear icon \u2192 \"Confirm CBL pickings\". A\n    wizard will appear listing the deliveries to be confirmed. Verify\n    that all required pickings are included, then click the \"Confirm\n    Shipments\" button.\n  - Additionally, there is a scheduled action (\"CBL: Confirm Shipments\")\n    that automatically validates pending CBL shipments once per day by\n    default.\n\n- To generate the manifest, you need to Inventory > Operation >\n  Manifest, select a CBL carrier and set the date range to select the\n  picking.\n\nKnown issues / Roadmap\n======================\n\n- During the development of the shipping label generation feature, we\n  initially evaluated the use of the Zebrafy library to convert ZPL\n  labels into PDF format. However, Zebrafy is based on the presence of\n  graphic fields (^GF) in the ZPL source, which are not always included\n  in the labels generated by CBL.\n- To ensure broader compatibility, it's opted to use the external\n  service Labelary.com, returns the corresponding label in PDF format\n  via an HTTP request.\n- To provide flexibility, a new field cbl_label_format has been added to\n  the delivery.carrier model, allowing the user to select between ZPL\n  (default) and PDF formats. The method cdl_generate_labels will only\n  invoke the external Labelary service if the selected format is PDF.\n  Otherwise, the label is stored directly in ZPL format without any\n  transformation.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/delivery-carrier/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/delivery-carrier/issues/new?body=module:%20delivery_cbl%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n-------\n\n* Sygel\n\nContributors\n------------\n\n- Manuel Regidor manuel.regidor@sygel.es\n- Valent\u00edn Vinagre valentin.vinagre@sygel.es\n- \u00c1ngel Rivas angel.rivas@sygel.es\n\nMaintainers\n-----------\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n   :alt: Odoo Community Association\n   :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nThis module is part of the `OCA/delivery-carrier <https://github.com/OCA/delivery-carrier/tree/17.0/delivery_cbl>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n",
    "bugtrack_url": null,
    "license": "AGPL-3",
    "summary": "Integrate CBL webservice",
    "version": "17.0.1.0.0.7",
    "project_urls": {
        "Homepage": "https://github.com/OCA/delivery-carrier"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "20e8b3fd23f8f961fb8c8f2e348be388db519f5fa78126ed6cebf70af26f9c27",
                "md5": "037868c4c7a932b1b9e9c881ac9c8d36",
                "sha256": "3d149656a7d3c46b0bf2a4bd5872e69270f29408a42070ee70e3d23be3f42197"
            },
            "downloads": -1,
            "filename": "odoo_addon_delivery_cbl-17.0.1.0.0.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "037868c4c7a932b1b9e9c881ac9c8d36",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 67141,
            "upload_time": "2025-08-05T02:48:20",
            "upload_time_iso_8601": "2025-08-05T02:48:20.652869Z",
            "url": "https://files.pythonhosted.org/packages/20/e8/b3fd23f8f961fb8c8f2e348be388db519f5fa78126ed6cebf70af26f9c27/odoo_addon_delivery_cbl-17.0.1.0.0.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-05 02:48:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "OCA",
    "github_project": "delivery-carrier",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "openupgradelib",
            "specs": []
        },
        {
            "name": "roulier",
            "specs": []
        }
    ],
    "lcname": "odoo-addon-delivery-cbl"
}
        
Elapsed time: 0.45342s