Freight Consolidation — Document Integration
by Viindoo
| Lines of Code | 1316 |
| Technical name | viin_document_freight_consol |
| License | OPL-1 |
| Website | https://viindoo.com/apps/modules/19.0/viin_document_freight_consol |
| Read description for | v 17.0 v 18.0 |
| Required Apps | Invoicing (account) Project (project) Purchase (purchase) Discuss (mail) Inventory (stock) Employees (hr) Sales (sale_management) |
| Included Dependencies | Logistics Shipment Tracking Location Route Extension Freight Sale Viindoo Unified Routing Framework Logistics Shipment Sale Integration Logistics Package Type Freight Forwarder Management Tracking Location QR Code Mixin Logistics Sales Team Freight Project & Operations Tasks Viindoo Base Documents Management Accounting Foundation Freight Consolidation Project Customization Logistics Routes Integration API Request Logger Logistics Accounting Supplier-Based Pricelist Freight & Document Integration Multilingual Tracking Token Expiration |
| Extensions | WoWship – All-in-one Freight & Shipment Management Suite |
Give every house shipment its own bill of lading and delivery order
Two guided wizards on the shipment form prepare the House Bill of Lading and the Delivery Order for LCL house shipments - filed and tagged the same way as the rest of your freight paperwork, right from the Required Documents tab you already use.
At a Glance
The facts of Freight Consolidation - Document Integration, version 0.1.0, in one place. Published by Viindoo.
Extends viin_document -
see its documentation.
Extends viin_document_freight -
see its documentation.
One House B/L per house, not one B/L for the whole master
Once a master shipment is split into houses, each house ships to its own consignee and needs its own paperwork. Prepare HBL opens right on the house shipment, already carrying the HBL number recorded on it, and turns that into a correctly tagged document request in one step.
Issue the Delivery Order once the cargo is actually split
Issue D/O only appears on a house import shipment, and only before its D/O has gone out. That is not a limitation - a Delivery Order belongs to the consignee's own house shipment, so the button only shows up once a master has been split into houses that can each receive one.
Two more document types, no new screen
House B/L and Delivery Order join the same Freight Document Type list you already use for Shipping Instruction and Draft B/L. Pick one when adding a row by hand, or let either wizard do it, and the request comes out tagged the same way - there is no separate menu to go looking for.
Key Features
Prepare HBL wizard
A button next to Prepare Draft B/L, visible on any house or standalone (direct) shipment - not only ones split from a master. It opens pre-filled with the House Bill of Lading number already on the shipment; add the due date and any carrier-facing remarks, confirm, and it creates a document request tagged "House BL (HBL)" and "Main Leg - Sea". Saves retyping the HBL number and tagging the request by hand.
Issue D/O wizard
A button that appears once a shipment is a house import shipment with no Delivery Order issued yet. Confirming it records the D/O number on the shipment, stamps the moment it was issued, and creates a document request tagged "Delivery Order (DO)" and "Main Leg - Sea". Saves tracking by hand whether a D/O has already gone out, and tagging that request separately.
House B/L and Delivery Order in the Required Documents type list
Adds "House B/L (HBL)" and "Delivery Order (D/O)" to the Freight Document Type choices on the Required Documents tab, each mapped to the right tags automatically - whether the row comes from a wizard or was typed in by hand. Saves the manual tagging step for these two types too, the same way the tab already saves it for Shipping Instruction and Draft B/L.
How It Works
On a house export shipment split from a Sea Export LCL consolidation - already In Transit, with its HBL number already recorded - a coordinator opens Required Documents and clicks Prepare HBL. The wizard opens with that HBL number carried over; they add the due date and a note for the notify party, confirm, and the module creates a House B/L document request already tagged "House BL (HBL)" and "Main Leg - Sea", filed straight into that house shipment's own folder.
On the import side, Issue D/O only shows up once a master shipment has been split into houses - that split happens through the Deconsolidate action Freight Consolidation provides on the master. Once a house import shipment exists, Issue D/O sits next to Prepare HBL; confirming it records the D/O number, stamps the moment it was issued, and creates a tagged Delivery Order request. Come back later and the button is gone - the house shipment already has its D/O.
Prepare HBL, already carrying the shipment's own HBL number
Issue D/O appears once a house import shipment exists
Prepare a House Bill of Lading in one guided form
Open a house or direct shipment's Required Documents tab and click Prepare HBL. The form opens already carrying the shipment's own HBL number - add a due date and any carrier-facing remarks, and confirm.
Tags applied automatically - no manual tagging step
Confirming the wizard creates a tracked House B/L request already tagged "House BL (HBL)" and "Main Leg - Sea" - the same tagging the rest of your freight paperwork gets, without touching the Tags field yourself.
Issue D/O appears once a house import shipment exists
Split a master shipment into houses with the Deconsolidate action, and each resulting house import shipment gets its own Issue D/O button on the Required Documents tab - right next to Prepare HBL.
Confirm the Delivery Order details, and you're done
Click Issue D/O, fill in the D/O number and due date, and confirm. The shipment's D/O number and issue timestamp are recorded in the same step.
The Delivery Order is tracked and tagged the same way
The resulting request is tagged "Delivery Order (DO)" and "Main Leg - Sea" automatically, and the Issue D/O button disappears from the shipment - it already has its own D/O.
HBL and D/O sit in the same checklist as every other document
House B/L and Delivery Order show up in the same unified Required Documents tab as Shipping Instruction and Draft B/L - one checklist for every document a shipment needs, not a separate screen for these two.
See Freight Consolidation - Document Integration in Action
Explore the Prepare HBL and Issue D/O wizards, and the unified Required Documents checklist, on a live database.
Try the Live DemoNeed help with Freight Consolidation - Document Integration?
Support
apps.support@viindoo.comTechnical Requirement
- Odoo version: 19.0
- Editions: Odoo Community Edition, Viindoo SaaS
-
Required modules:
Freight & Document Integration (
viin_document_freight), Freight Consolidation (viin_freight_consol) - Installation: Activates automatically once both required modules are present - no separate install step.
- License: OPL-1
Frequently Asked Questions
Which Odoo edition does this need?
Community Edition or Viindoo SaaS. It does not require Odoo Enterprise.
Does it install itself?
Yes. It activates automatically the moment its two dependencies - Freight & Document
Integration (viin_document_freight) and Freight Consolidation
(viin_freight_consol) - are both present on your database. There is no separate
install step to remember once your freight stack is running.
What does it depend on?
Directly, Freight & Document Integration (viin_document_freight) and
Freight Consolidation (viin_freight_consol). Functionally, it needs shipments
that are actually split into houses - masters, houses, and the deconsolidation step itself
all come from Freight Consolidation, not from this module.
Why can't I see the Issue D/O button on a shipment yet?
It only shows up on a house shipment, on the import direction, before a D/O has been issued. If you are looking at a master shipment, split it into houses first with the Deconsolidate action from Freight Consolidation - Issue D/O appears on each resulting house shipment once that is done. Split first, then issue each house's own D/O: that is how a Delivery Order actually works, not a gap in the module.
Does it work without demo data?
Yes. The two wizards, the two extra document types, and their tag mapping are regular data, present the moment the module installs. Demo data is only used to illustrate the shipments captured in this listing.
Freight Consolidation — Document Integration
Note
Extends viin_document - see its documentation: ../../viin_document/doc/index.rst
Note
Extends viin_document_freight - see its documentation: ../../viin_document_freight/doc/index.rst
This module bridges LCL Consolidation shipments with the Freight document workflow. On a house or direct shipment it adds two guided forms - Prepare HBL and Issue D/O - to the Required Documents tab you already use for the Shipping Instruction and Draft B/L, so the House Bill of Lading and the Delivery Order show up in the same tracked checklist as every other paper you are chasing for that shipment.
It ships no screens, tags or folders of its own - filing, tagging and access all come from Freight & Document Integration (see the note above). This module only adds the two forms described here and the two document types they create.
Installation
This module activates itself - there is no Activate button to click for it directly. It turns on automatically as soon as both of the following apps are installed:
- Freight & Document Integration (technical name viin_document_freight).
- Freight Consolidation (technical name viin_freight_consol).
Once both are present, open Apps, remove the default filter, search for viin_document_freight_consol and confirm its state shows Installed.
Configuration
Nothing needs to be set up before you use this module - it has no settings, tags or workspaces of its own to configure. The workspace, the document tags and the access rules a document ends up with all come from Freight & Document Integration; see that module's own documentation for how they work.
Usage
Prepare a House Bill of Lading (HBL)
The Prepare HBL button is available on any house or direct shipment - it is hidden on a master shipment, since a master never has its own HBL.
- Open Freight Forwarding ‣ Operations ‣ All Shipments and open a house or direct shipment (search by shipper or by its HBL No.).
- Click the Required Documents tab.
- Click Prepare HBL, next to Prepare SI and Prepare Draft B/L.
- The Prepare House B/L form opens, pre-filled with a Document Name, a Summary of House Bill of Lading, and the shipment's own HBL No. if it already has one. Fill in the required HBL Due Date, and add any B/L Remarks the carrier needs to see.
- Click Prepare HBL in the footer to save.
If you typed an HBL No. that the shipment did not already have, it is written back to the shipment's own HBL No. field. The dialog closes and opens the new Required Document's own record, with Freight Document Type set to House B/L (HBL) and Tags showing House BL (HBL) and Main Leg – Sea - applied automatically, with no tagging step of your own.
Back on the shipment, the Required Documents tab now lists this HBL alongside any Shipping Instruction or Draft B/L already on the checklist. If an HBL request already exists for this shipment, clicking Prepare HBL again reopens the same form pre-filled with its saved values, and updates that same row instead of creating a second one.
Issue a Delivery Order (D/O)
The Issue D/O button appears only on a house shipment whose Direction is Import and whose Delivery Order has not been issued yet. House import shipments are usually created by running the Deconsolidate action on a master shipment (a feature of the Freight Consolidation module) - once you have one, continue below.
- Open Freight Forwarding ‣ Operations ‣ All Shipments and open a house import shipment.
- Click the Required Documents tab. Issue D/O appears next to Prepare SI, Prepare Draft B/L and Prepare HBL.
- Click Issue D/O. The Prepare Delivery Order form opens, pre-filled with a Document Name and a Summary of Delivery Order. Fill in the D/O No. if it is not already set, and the required D/O Due Date.
- Click Issue D/O in the footer to save.
Saving stamps the shipment's D/O Issued date and writes the D/O No. back onto the shipment if it was not already set. As with the HBL form, the dialog closes on the new Required Document's own record, with Freight Document Type set to Delivery Order (D/O) and Tags showing Delivery Order (DO) and Main Leg – Sea.
Because the shipment's D/O is now issued, Issue D/O no longer shows on a later visit to this shipment's Required Documents tab - only Prepare SI, Prepare Draft B/L and Prepare HBL remain.
Troubleshooting
- I do not see Prepare HBL on a shipment. It is hidden on a master shipment - open the house or direct shipment instead.
- I do not see Issue D/O on a shipment. It only shows on a house shipment whose Direction is Import and whose D/O has not been issued yet. On an export or direct shipment, or once the D/O is already issued, the button does not appear.
- The screen I land on after saving looks like a plain record, not a form built for this. That is expected - a Required Document has no dedicated screen of its own; you land on Odoo's standard record screen, listing every field including a few (Goods Description for SI, Marks & Numbers, Special Instruction) that this HBL or D/O did not use.
- My HBL or D/O number did not update on the shipment. The wizard only writes the number back when the shipment does not already have one - if the shipment already carries an HBL No. or D/O No., re-running the wizard does not overwrite it.
FAQ
- Does this module need Odoo Enterprise?
- No - it runs on Odoo Community.
- Do I need to install this module myself?
- No. It activates automatically once Freight & Document Integration and Freight Consolidation are both installed.
- Do I need to set up tags or a workspace before using it?
- No. Every tag and the workspace a document is filed into come from Freight & Document Integration, already configured.
- Can I run Prepare HBL or Issue D/O twice on the same shipment?
- Yes. Running it again reopens the same form pre-filled with the saved values and updates the existing document request rather than creating a duplicate.
- Why does the D/O wizard have no B/L Remarks field?
- B/L Remarks is specific to the HBL form - a Delivery Order does not carry carrier remarks the same way a Bill of Lading does.
This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file).
You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one).
It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software.
The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.