forked from OCA/delivery-carrier
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4f20ea5
commit f509ff0
Showing
32 changed files
with
485 additions
and
405 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,20 @@ | ||
| <?xml version="1.0" encoding="utf-8" ?> | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | ||
| <meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" /> | ||
| <meta name="generator" content="Docutils: https://docutils.sourceforge.io/" /> | ||
| <title>Base module for carrier labels</title> | ||
| <style type="text/css"> | ||
|
|
||
| /* | ||
| :Author: David Goodger ([email protected]) | ||
| :Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $ | ||
| :Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $ | ||
| :Copyright: This stylesheet has been placed in the public domain. | ||
| Default cascading style sheet for the HTML output of Docutils. | ||
| See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to | ||
| See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to | ||
| customize this style sheet. | ||
| */ | ||
|
|
||
|
|
@@ -366,66 +366,68 @@ <h1 class="title">Base module for carrier labels</h1> | |
| <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
| !! This file is generated by oca-gen-addon-readme !! | ||
| !! changes will be overwritten. !! | ||
| !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||
| !! source digest: sha256:fe69faaa91e456352be80aed4f0c80058e4aba36d968fcc8f9b0e5023561242c | ||
| !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> | ||
| <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/OCA/delivery-carrier/tree/16.0/base_delivery_carrier_label"><img alt="OCA/delivery-carrier" src="https://img.shields.io/badge/github-OCA%2Fdelivery--carrier-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/delivery-carrier-16-0/delivery-carrier-16-0-base_delivery_carrier_label"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/99/16.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> | ||
| <p><a class="reference external image-reference" 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 image-reference" 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 image-reference" href="https://github.com/OCA/delivery-carrier/tree/16.0/base_delivery_carrier_label"><img alt="OCA/delivery-carrier" src="https://img.shields.io/badge/github-OCA%2Fdelivery--carrier-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/delivery-carrier-16-0/delivery-carrier-16-0-base_delivery_carrier_label"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/delivery-carrier&target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p> | ||
| <p>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.</p> | ||
| <p><strong>Table of contents</strong></p> | ||
| <div class="contents local topic" id="contents"> | ||
| <ul class="simple"> | ||
| <li><a class="reference internal" href="#usage" id="id1">Usage</a></li> | ||
| <li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li> | ||
| <li><a class="reference internal" href="#credits" id="id3">Credits</a><ul> | ||
| <li><a class="reference internal" href="#authors" id="id4">Authors</a></li> | ||
| <li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li> | ||
| <li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li> | ||
| <li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li> | ||
| <li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li> | ||
| <li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul> | ||
| <li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li> | ||
| <li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li> | ||
| <li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| <div class="section" id="usage"> | ||
| <h1><a class="toc-backref" href="#id1">Usage</a></h1> | ||
| <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1> | ||
| <p>** How does it works ? **</p> | ||
| <p>In picking UI a button “Send to shipper” trigger label generation | ||
| calling <cite>send_to_shipper()</cite> in models/stock.picking.py</p> | ||
| <p>** How to implement my own carrier ? **</p> | ||
| <p>Define a method <cite>{carrier}_send_shipping()</cite> which is called by _send_shipping native method. | ||
| Make it return a list of dict of this form :</p> | ||
| <pre class="code python literal-block"> | ||
| <span class="p">{</span> | ||
| <span class="s2">"exact_price"</span><span class="p">:</span> <span class="n">price</span><span class="p">,</span> | ||
| <span class="s2">"tracking_number"</span><span class="p">:</span> <span class="s1">'number'</span> | ||
| <span class="s2">"labels"</span><span class="p">:</span> <span class="p">[{</span> | ||
| <span class="s2">"package_id"</span><span class="p">:</span> <span class="n">package_id</span><span class="p">,</span> | ||
| <span class="s2">"name"</span><span class="p">:</span> <span class="n">filename</span><span class="p">,</span> | ||
| <span class="s2">"datas"</span><span class="p">:</span> <span class="n">file_content</span> <span class="p">(</span><span class="n">base64</span><span class="p">),</span> | ||
| <span class="s2">"file_type"</span><span class="p">:</span> <span class="n">extension</span><span class="p">,</span> | ||
| <span class="s2">"tracking_number"</span><span class="p">:</span> <span class="n">package_number</span> | ||
| <span class="p">}]</span> | ||
| <span class="p">}</span> | ||
| <span class="p">{</span><span class="w"> | ||
| </span> <span class="s2">"exact_price"</span><span class="p">:</span> <span class="n">price</span><span class="p">,</span><span class="w"> | ||
| </span> <span class="s2">"tracking_number"</span><span class="p">:</span> <span class="s1">'number'</span><span class="w"> | ||
| </span> <span class="s2">"labels"</span><span class="p">:</span> <span class="p">[{</span><span class="w"> | ||
| </span> <span class="s2">"package_id"</span><span class="p">:</span> <span class="n">package_id</span><span class="p">,</span><span class="w"> | ||
| </span> <span class="s2">"name"</span><span class="p">:</span> <span class="n">filename</span><span class="p">,</span><span class="w"> | ||
| </span> <span class="s2">"datas"</span><span class="p">:</span> <span class="n">file_content</span> <span class="p">(</span><span class="n">base64</span><span class="p">),</span><span class="w"> | ||
| </span> <span class="s2">"file_type"</span><span class="p">:</span> <span class="n">extension</span><span class="p">,</span><span class="w"> | ||
| </span> <span class="s2">"tracking_number"</span><span class="p">:</span> <span class="n">package_number</span><span class="w"> | ||
| </span> <span class="p">}]</span><span class="w"> | ||
| </span><span class="p">}</span> | ||
| </pre> | ||
| </div> | ||
| <div class="section" id="bug-tracker"> | ||
| <h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1> | ||
| <h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1> | ||
| <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/delivery-carrier/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 | ||
| If you spotted it first, help us to smash it by providing a detailed and welcomed | ||
| <a class="reference external" href="https://github.com/OCA/delivery-carrier/issues/new?body=module:%20base_delivery_carrier_label%0Aversion:%2016.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> | ||
| </div> | ||
| <div class="section" id="credits"> | ||
| <h1><a class="toc-backref" href="#id3">Credits</a></h1> | ||
| <h1><a class="toc-backref" href="#toc-entry-3">Credits</a></h1> | ||
| <div class="section" id="authors"> | ||
| <h2><a class="toc-backref" href="#id4">Authors</a></h2> | ||
| <h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2> | ||
| <ul class="simple"> | ||
| <li>Camptocamp</li> | ||
| <li>Akretion</li> | ||
| </ul> | ||
| </div> | ||
| <div class="section" id="contributors"> | ||
| <h2><a class="toc-backref" href="#id5">Contributors</a></h2> | ||
| <h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2> | ||
| <ul class="simple"> | ||
| <li>David BEAL <<a class="reference external" href="mailto:david.beal@akretion.com">david.beal@akretion.com</a>></li> | ||
| <li>Sébastien BEAU <<a class="reference external" href="mailto:sebastien.beau@akretion.com">sebastien.beau@akretion.com</a>></li> | ||
|
|
@@ -439,7 +441,7 @@ <h2><a class="toc-backref" href="#id5">Contributors</a></h2> | |
| </ul> | ||
| </div> | ||
| <div class="section" id="maintainers"> | ||
| <h2><a class="toc-backref" href="#id6">Maintainers</a></h2> | ||
| <h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2> | ||
| <p>This module is maintained by the OCA.</p> | ||
| <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> | ||
| <p>OCA, or the Odoo Community Association, is a nonprofit organization whose | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.