33< head >
44< meta http-equiv ="Content-Type " content ="text/html; charset=utf-8 " />
55< meta name ="generator " content ="Docutils: https://docutils.sourceforge.io/ " />
6- < title > Sendcloud Shipping </ title >
6+ < title > README.rst </ title >
77< style type ="text/css ">
88
99/*
360360</ style >
361361</ head >
362362< body >
363- < div class ="document " id ="sendcloud-shipping ">
364- < h1 class ="title "> Sendcloud Shipping</ h1 >
363+ < div class ="document ">
365364
365+
366+ < a class ="reference external image-reference " href ="https://odoo-community.org/get-involved?utm_source=readme ">
367+ < img alt ="Odoo Community Association " src ="https://odoo-community.org/readme-banner-image " />
368+ </ a >
369+ < div class ="section " id ="sendcloud-shipping ">
370+ < h1 > Sendcloud Shipping</ h1 >
366371<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
367372!! This file is generated by oca-gen-addon-readme !!
368373!! changes will be overwritten. !!
369374!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370- !! source digest: sha256:dbe01d1d34d6b43fe7239a4179838085ee43b5a8e5eef4ad0a384761109282be
375+ !! source digest: sha256:83af6b1722602375b6a207a308583c71889c8974194fe72a8fb65299232c2765
371376!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372- < 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/lgpl-3.0-standalone.html "> < img alt ="License: LGPL-3 " src ="https://img.shields.io/badge/licence-LGPL--3-blue.png " /> </ a > < a class ="reference external image-reference " href ="https://github.com/OCA/delivery-carrier/tree/17.0/delivery_sendcloud_oca "> < 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-17-0/delivery-carrier-17-0-delivery_sendcloud_oca "> < 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=17.0 "> < img alt ="Try me on Runboat " src ="https://img.shields.io/badge/runboat-Try%20me-875A7B.png " /> </ a > </ p >
377+ < 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/lgpl-3.0-standalone.html "> < img alt ="License: LGPL-3 " src ="https://img.shields.io/badge/license-LGPL--3-blue.png " /> </ a > < a class ="reference external image-reference " href ="https://github.com/OCA/delivery-carrier/tree/17.0/delivery_sendcloud_oca "> < 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-17-0/delivery-carrier-17-0-delivery_sendcloud_oca "> < 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=17.0 "> < img alt ="Try me on Runboat " src ="https://img.shields.io/badge/runboat-Try%20me-875A7B.png " /> </ a > </ p >
373378< p > This module provides sendcloud shipping integration with Odoo</ p >
374379< p > This module mostly implements what’s described in
375380< a class ="reference external " href ="https://docs.sendcloud.sc/api/v2/shipping/ "> https://docs.sendcloud.sc/api/v2/shipping/</ a > </ p >
@@ -407,13 +412,13 @@ <h1 class="title">Sendcloud Shipping</h1>
407412</ ul >
408413</ div >
409414< div class ="section " id ="installation ">
410- < h1 > < a class ="toc-backref " href ="#toc-entry-1 "> Installation</ a > </ h1 >
415+ < h2 > < a class ="toc-backref " href ="#toc-entry-1 "> Installation</ a > </ h2 >
411416< p > Create an account on sendcloud.com and choose a plan. Go to integrations
412417and select Odoo integration to use the Odoo integration or select api
413418integration if you only want to use the api integration (see readme for
414419more information).</ p >
415420< div class ="section " id ="odoo-integration ">
416- < h2 > < a class ="toc-backref " href ="#toc-entry-2 "> Odoo Integration</ a > </ h2 >
421+ < h3 > < a class ="toc-backref " href ="#toc-entry-2 "> Odoo Integration</ a > </ h3 >
417422< p > Verify that the value of “web.base.url” parameter in System Parameters
418423is set with the correct url (eg.: “< a class ="reference external " href ="https://demo.onestein.eu "> https://demo.onestein.eu</ a > ” instead of
419424“< a class ="reference external " href ="http://localhost:8069 "> http://localhost:8069</ a > ”).</ p >
@@ -445,13 +450,13 @@ <h2><a class="toc-backref" href="#toc-entry-2">Odoo Integration</a></h2>
445450module with the Odoo integration.</ p >
446451</ div >
447452< div class ="section " id ="sendcloud-panel-settings ">
448- < h2 > < a class ="toc-backref " href ="#toc-entry-3 "> Sendcloud panel settings</ a > </ h2 >
453+ < h3 > < a class ="toc-backref " href ="#toc-entry-3 "> Sendcloud panel settings</ a > </ h3 >
449454< p > When you configure the Integration settings in the online Sendcloud
450455panel (< a class ="reference external " href ="https://panel.sendcloud.sc/ "> https://panel.sendcloud.sc/</ a > ) those settings are also sync-ed with
451456the Integration settings Odoo side.</ p >
452457</ div >
453458< div class ="section " id ="synchronize-sendcloud-objects ">
454- < h2 > < a class ="toc-backref " href ="#toc-entry-4 "> Synchronize Sendcloud objects</ a > </ h2 >
459+ < h3 > < a class ="toc-backref " href ="#toc-entry-4 "> Synchronize Sendcloud objects</ a > </ h3 >
455460< p > After the setup of the integration with Sendcloud server is completed,
456461second step is to synchronize the objects present in Sendcloud server to
457462Odoo. To synchronize Sendcloud objects for the first time:</ p >
@@ -497,7 +502,7 @@ <h2><a class="toc-backref" href="#toc-entry-4">Synchronize Sendcloud objects</a>
497502< p > < img alt ="image10 " src ="https://raw.githubusercontent.com/OCA/delivery-carrier/17.0/delivery_sendcloud_oca/static/description/Image_110.png " /> </ p >
498503</ div >
499504< div class ="section " id ="initial-sync-of-past-orders ">
500- < h2 > < a class ="toc-backref " href ="#toc-entry-5 "> Initial sync of past orders</ a > </ h2 >
505+ < h3 > < a class ="toc-backref " href ="#toc-entry-5 "> Initial sync of past orders</ a > </ h3 >
501506< p > Once all the previous configuration steps are completed, it is possible
502507to synchronize all the past Odoo outgoing shipments to Sendcloud. Those
503508shipments are the ones already setup with a Sendcloud shipping method.</ p >
@@ -510,7 +515,7 @@ <h2><a class="toc-backref" href="#toc-entry-5">Initial sync of past orders</a></
510515fulfillment will continue.</ p >
511516</ div >
512517< div class ="section " id ="auto-create-invoice ">
513- < h2 > < a class ="toc-backref " href ="#toc-entry-6 "> Auto create invoice</ a > </ h2 >
518+ < h3 > < a class ="toc-backref " href ="#toc-entry-6 "> Auto create invoice</ a > </ h3 >
514519< p > When sending a product outside the EU, Sendcloud requires an invoice
515520number. In case shipment is made with a product that can be invoiced
516521based on delivered quantities, this combination of factors prevents the
@@ -522,7 +527,7 @@ <h2><a class="toc-backref" href="#toc-entry-6">Auto create invoice</a></h2>
522527testing.</ p >
523528</ div >
524529< div class ="section " id ="test-mode ">
525- < h2 > < a class ="toc-backref " href ="#toc-entry-7 "> Test Mode</ a > </ h2 >
530+ < h3 > < a class ="toc-backref " href ="#toc-entry-7 "> Test Mode</ a > </ h3 >
526531< p > To enable the Test Mode, go to the “General Settings”: under the
527532Sendcloud section you can find the “Enable Test Mode” flag. Enabling the
528533Test Mode allows you to access extra functionalities that are useful to
@@ -548,7 +553,7 @@ <h2><a class="toc-backref" href="#toc-entry-7">Test Mode</a></h2>
548553</ div >
549554</ div >
550555< div class ="section " id ="usage ">
551- < h1 > < a class ="toc-backref " href ="#toc-entry-8 "> Usage</ a > </ h1 >
556+ < h2 > < a class ="toc-backref " href ="#toc-entry-8 "> Usage</ a > </ h2 >
552557< p > In short this is how the module works:</ p >
553558< ul class ="simple ">
554559< li > the user creates a sale order in Odoo; the user clicks on “Add
@@ -557,13 +562,13 @@ <h1><a class="toc-backref" href="#toc-entry-8">Usage</a></h1>
557562< li > when confirming the sale order, a delivery document is generated
558563(stock.picking)</ li >
559564< li > when confirming the picking, a parcel (or multiple parcels) for the
560- specific sales order are created in Sendcloud under Shipping >
561- Created labels</ li >
565+ specific sales order are created in Sendcloud under Shipping > Created
566+ labels</ li >
562567< li > the picking is updated with the information from Sendcloud (tracking
563568number, tracking url, label etc…)</ li >
564569</ ul >
565570< div class ="section " id ="map-of-sendcloud-odoo-data-models ">
566- < h2 > < a class ="toc-backref " href ="#toc-entry-9 "> Map of Sendcloud-Odoo data models</ a > </ h2 >
571+ < h3 > < a class ="toc-backref " href ="#toc-entry-9 "> Map of Sendcloud-Odoo data models</ a > </ h3 >
567572< table border ="1 " class ="docutils ">
568573< colgroup >
569574< col width ="69% " />
@@ -585,20 +590,20 @@ <h2><a class="toc-backref" href="#toc-entry-9">Map of Sendcloud-Odoo data models
585590Warehouse address | | Shipping Method | Shipping Method |</ p >
586591</ div >
587592< div class ="section " id ="multicollo-parcels ">
588- < h2 > < a class ="toc-backref " href ="#toc-entry-10 "> Multicollo parcels</ a > </ h2 >
593+ < h3 > < a class ="toc-backref " href ="#toc-entry-10 "> Multicollo parcels</ a > </ h3 >
589594< p > In Inventory > Configuration > Delivery Packages, set the carrier to
590595Sendcloud. In the out picking, put the products in different Sendcloud
591596packages to create Multicollo parcels.</ p >
592597</ div >
593598< div class ="section " id ="service-point-picker ">
594- < h2 > < a class ="toc-backref " href ="#toc-entry-11 "> Service Point Picker</ a > </ h2 >
599+ < h3 > < a class ="toc-backref " href ="#toc-entry-11 "> Service Point Picker</ a > </ h3 >
595600< p > The module contains a widget, the Service Point Picker, that allows the
596601selection of the service point. The widget is placed in the “Sendcloud
597602Shipping” tab of the picking. The widget is visible in case the
598603following is true:</ p >
599604< ul class ="simple ">
600- < li > the configuration in the Sendcloud panel has the Service Point flag
601- to True (in the Sendcloud integration config)</ li >
605+ < li > the configuration in the Sendcloud panel has the Service Point flag to
606+ True (in the Sendcloud integration config)</ li >
602607< li > the Shipping Method selected in the picking is provided by Sendcloud</ li >
603608< li > the Shipping Method has field sendcloud_service_point_input ==
604609“required”</ li >
@@ -607,46 +612,46 @@ <h2><a class="toc-backref" href="#toc-entry-11">Service Point Picker</a></h2>
607612</ ul >
608613</ div >
609614< div class ="section " id ="cancel-parcels ">
610- < h2 > < a class ="toc-backref " href ="#toc-entry-12 "> Cancel parcels</ a > </ h2 >
615+ < h3 > < a class ="toc-backref " href ="#toc-entry-12 "> Cancel parcels</ a > </ h3 >
611616< p > When canceling parcels a confirmation popup will ask for confirmation.</ p >
612617</ div >
613618< div class ="section " id ="delivery-outside-eu ">
614- < h2 > < a class ="toc-backref " href ="#toc-entry-13 "> Delivery outside EU</ a > </ h2 >
619+ < h3 > < a class ="toc-backref " href ="#toc-entry-13 "> Delivery outside EU</ a > </ h3 >
615620< p > Install either OCA module ‘product_harmonized_system’ or Enterprise
616621module ‘account_intrastat’ for delivery outside of EU. Both include
617622extra field ‘country of origin’.</ p >
618623</ div >
619624< div class ="section " id ="troubleshooting ">
620- < h2 > < a class ="toc-backref " href ="#toc-entry-14 "> Troubleshooting</ a > </ h2 >
625+ < h3 > < a class ="toc-backref " href ="#toc-entry-14 "> Troubleshooting</ a > </ h3 >
621626< p > If the communication to the Sendcloud server fails (eg.: while creating
622627a parcel), the exchanged message is stored in a Log section, under
623628Logging > Actions.</ p >
624629</ div >
625630</ div >
626631< div class ="section " id ="bug-tracker ">
627- < h1 > < a class ="toc-backref " href ="#toc-entry-15 "> Bug Tracker</ a > </ h1 >
632+ < h2 > < a class ="toc-backref " href ="#toc-entry-15 "> Bug Tracker</ a > </ h2 >
628633< p > Bugs are tracked on < a class ="reference external " href ="https://github.com/OCA/delivery-carrier/issues "> GitHub Issues</ a > .
629634In case of trouble, please check there if your issue has already been reported.
630635If you spotted it first, help us to smash it by providing a detailed and welcomed
631636< a class ="reference external " href ="https://github.com/OCA/delivery-carrier/issues/new?body=module:%20delivery_sendcloud_oca%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior** "> feedback</ a > .</ p >
632637< p > Do not contact contributors directly about support or help with technical issues.</ p >
633638</ div >
634639< div class ="section " id ="credits ">
635- < h1 > < a class ="toc-backref " href ="#toc-entry-16 "> Credits</ a > </ h1 >
640+ < h2 > < a class ="toc-backref " href ="#toc-entry-16 "> Credits</ a > </ h2 >
636641< div class ="section " id ="authors ">
637- < h2 > < a class ="toc-backref " href ="#toc-entry-17 "> Authors</ a > </ h2 >
642+ < h3 > < a class ="toc-backref " href ="#toc-entry-17 "> Authors</ a > </ h3 >
638643< ul class ="simple ">
639644< li > Onestein</ li >
640645</ ul >
641646</ div >
642647< div class ="section " id ="contributors ">
643- < h2 > < a class ="toc-backref " href ="#toc-entry-18 "> Contributors</ a > </ h2 >
648+ < h3 > < a class ="toc-backref " href ="#toc-entry-18 "> Contributors</ a > </ h3 >
644649< ul class ="simple ">
645650< li > < tt class ="docutils literal "> Onestein < span class ="pre "> <https://www.onestein.nl></ span > </ tt > __</ li >
646651</ ul >
647652</ div >
648653< div class ="section " id ="maintainers ">
649- < h2 > < a class ="toc-backref " href ="#toc-entry-19 "> Maintainers</ a > </ h2 >
654+ < h3 > < a class ="toc-backref " href ="#toc-entry-19 "> Maintainers</ a > </ h3 >
650655< p > This module is maintained by the OCA.</ p >
651656< a class ="reference external image-reference " href ="https://odoo-community.org ">
652657< img alt ="Odoo Community Association " src ="https://odoo-community.org/logo.png " />
@@ -659,5 +664,6 @@ <h2><a class="toc-backref" href="#toc-entry-19">Maintainers</a></h2>
659664</ div >
660665</ div >
661666</ div >
667+ </ div >
662668</ body >
663669</ html >
0 commit comments