# oca/wms architecture

> Architecture diagram of the GitHub repository oca/wms, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-10). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/oca/wms
- Repository: https://github.com/oca/wms

## Overview

This repository is a collection of Odoo modules that together build a comprehensive Warehouse Management System (WMS) on top of the Odoo framework. The purpose of the project is to extend Odoo’s functionality to manage all aspects of warehouse operations—including sales integrations, picking and packing, delivery, storage strategies, and even mobile and receptionist interfaces—by modularizing the functionality into many easily installable addons.

##### Overall Structure and Project Context
- Recognize that the project is not a standalone application; rather, it is an ecosystem of Odoo modules. The entire system is built as multiple “addons” that extend core Odoo functionality.
- The key architectural feature is the modular design, where each addon encapsulates a specific business process (for example: “delivery_carrier_warehouse” for linking delivery methods to warehouses, “shopfloor” and “shopfloor_base” for handling real-time warehouse operations, and various “stock_release_channel*” modules for managing stock release strategies).

##### Main Components
- Odoo Core Environment: The centralized engine that runs the Odoo framework, including the ORM, web server, and PostgreSQL database.
- Business Modules (Addons):
o Sales and Delivery Integration Modules (e.g., sale_stock_available_to_promise_release, sale_stock_release_channel_partner_by_date, etc.).
o Shopfloor and Warehouse Operations Modules (e.g., shopfloor, shopfloor_base, shopfloor_mobile, shopfloor_workstation, shopfloor_reception).
o Stock and Inventory Management Modules (e.g., stock_available_to_promise_release, stock_dynamic_routing, stock_warehouse_flow, stock_storage_type).
o Release Channel Modules: A series of addons (e.g., stock_release_channel, stock_release_channel_auto_release, stock_release_channel_cutoff, and many others) that manage how orders and shipments are released.
o Mobile and REST Modules: Components such as shopfloor_mobile*, mobile base modules, and REST log components to provide a mobile or API interface.
- Shared Services: Common utilities such as migrations, controllers (often handling API endpoints for mobile apps), views (XML, templates) and standardized business models that interconnect the various modules.
- Packaging/Deployment Setup: The setup directories show how multiple modules are packaged within Odoo’s addons paths, ensuring proper deployment and configuration.

##### Relationships and Interactions
- Integration via Odoo’s Built-in MVC Pattern:
o Each module typically contains models (business logic and database schema), views (XML or templates providing UI components), and controllers (for custom API/web behaviors).
o Modules interact with each other when one extends or overrides models and views from another (for instance, “shopfloor” depends on functionality from “shopfloor_base”).
o Migrations, tests, and security files define the life-cycle and permissions, ensuring all overlaid functionality works coherently within the Odoo platform.
- Data Flow:
o End users (warehouse operators, sales clerks, and mobile app users) interact with a unified web or mobile interface driven by the installed modules.
o User actions trigger ORM operations, defined business rules, and workflow transitions that propagate through the interconnected modules.
o Modules such as release channel components coordinate via shared settings and scheduled actions (as seen in some modules’ cron/job configuration data) to influence warehouse process flows.

##### Architectural Patterns and Technologies
- Modular Design: Each addon is an independent module that can be installed or updated without affecting the whole system, aligning with Odoo’s extension capabilities.
- MVC Pattern: Emphasize that models, views, and controllers are the core design pattern across the system.
- API and Mobile Support: Some components (like shopfloor_mobile and shopfloor_mobile_base) show integration with modern front-end technologies (evidenced by JavaScript, HTML, and CSS in the static and templates directories), indicating a separation between backend business logic and frontend interfaces.
- Continuous Integration & Testing: The presence of .github workflows (test, pre-commit, stale) underlines robust CI/CD practices ensuring module reliability.

##### Putting It All Together
◦ Sales and Delivery Integration Cluster,
◦ Shopfloor and Mobile Operations Cluster,
◦ Stock/Inventory & Dynamic Routing Cluster,
◦ Release Channel Management Cluster.

## Diagram (Mermaid)

```mermaid
flowchart TD
    OdooCore["Odoo Core"]:::core

    subgraph "Sales & Delivery Integration"
        delivery_carrier_warehouse["delivery_carrier_warehouse"]:::sales
        sale_stock_available_to_promise_release["sale_stock_available_to_promise_release"]:::sales
        sale_stock_available_to_promise_release_block["sale_stock_available_to_promise_release_block"]:::sales
        sale_stock_release_channel_partner_by_date["sale_stock_release_channel_partner_by_date"]:::sales
        sale_stock_release_channel_partner_by_date_delivery["sale_stock_release_channel_partner_by_date_delivery"]:::sales
    end

    subgraph "Shopfloor Operations"
        shopfloor["shopfloor"]:::shopfloor
        shopfloor_base["shopfloor_base"]:::shopfloor
        shopfloor_mobile["shopfloor_mobile"]:::shopfloor
        shopfloor_mobile_base["shopfloor_mobile_base"]:::shopfloor
        shopfloor_mobile_base_auth_api_key["shopfloor_mobile_base_auth_api_key"]:::shopfloor
        shopfloor_reception["shopfloor_reception"]:::shopfloor
        shopfloor_rest_log["shopfloor_rest_log"]:::shopfloor
        shopfloor_workstation["shopfloor_workstation"]:::shopfloor
        shopfloor_workstation_mobile["shopfloor_workstation_mobile"]:::shopfloor
    end

    subgraph "Stock & Inventory Management"
        stock_available_to_promise_release["stock_available_to_promise_release"]:::stock
        stock_dynamic_routing["stock_dynamic_routing"]:::stock
        stock_warehouse_flow["stock_warehouse_flow"]:::stock
        stock_storage_type["stock_storage_type"]:::stock
        stock_storage_type_putaway_abc["stock_storage_type_putaway_abc"]:::stock
    end

    subgraph "Release Channel Management"
        stock_release_channel["stock_release_channel"]:::release
        stock_release_channel_auto_release["stock_release_channel_auto_release"]:::release
        stock_release_channel_batch_mode_commercial_partner["stock_release_channel_batch_mode_commercial_partner"]:::release
        stock_release_channel_cutoff["stock_release_channel_cutoff"]:::release
        stock_release_channel_delivery["stock_release_channel_delivery"]:::release
        stock_release_channel_geoengine["stock_release_channel_geoengine"]:::release
        stock_release_channel_partner_by_date["stock_release_channel_partner_by_date"]:::release
        stock_release_channel_partner_delivery_window["stock_release_channel_partner_delivery_window"]:::release
        stock_release_channel_partner_public_holidays["stock_release_channel_partner_public_holidays"]:::release
        stock_release_channel_plan["stock_release_channel_plan"]:::release
        stock_release_channel_plan_process_end_time["stock_release_channel_plan_process_end_time"]:::release
        stock_release_channel_plan_shipment_lead_time["stock_release_channel_plan_shipment_lead_time"]:::release
        stock_release_channel_process_end_time["stock_release_channel_process_end_time"]:::release
        stock_release_channel_propagate_channel_picking["stock_release_channel_propagate_channel_picking"]:::release
        stock_release_channel_shipment_advice["stock_release_channel_shipment_advice"]:::release
        stock_release_channel_shipment_advice_deliver["stock_release_channel_shipment_advice_deliver"]:::release
        stock_release_channel_shipment_advice_process_end_time["stock_release_channel_shipment_advice_process_end_time"]:::release
        stock_release_channel_shipment_advice_toursolver["stock_release_channel_shipment_advice_toursolver"]:::release
        stock_release_channel_shipment_lead_time["stock_release_channel_shipment_lead_time"]:::release
        stock_release_channel_show_volume["stock_release_channel_show_volume"]:::release
        stock_release_channel_show_weight["stock_release_channel_show_weight"]:::release
    end

    subgraph "Packaging/Deployment Setup"
        setup["setup"]:::packaging
    end

    %% Connections to Odoo Core (representative dependency)
    sale_stock_available_to_promise_release -->|"uses"| OdooCore
    shopfloor -->|"calls"| OdooCore
    stock_available_to_promise_release -->|"persists"| OdooCore
    stock_release_channel -->|"integrates"| OdooCore
    setup -->|"deploys"| OdooCore

    %% Module Dependencies and Interactions
    shopfloor -->|"extends"| shopfloor_base
    sale_stock_available_to_promise_release -->|"extends"| stock_available_to_promise_release
    sale_stock_release_channel_partner_by_date -->|"uses"| stock_release_channel_partner_by_date
    shopfloor_mobile -->|"calls"| shopfloor_mobile_base
    stock_release_channel_plan_process_end_time -->|"dependsOn"| stock_release_channel_plan

    %% Click Events
    click delivery_carrier_warehouse "https://github.com/oca/wms/tree/16.0/delivery_carrier_warehouse"
    click sale_stock_available_to_promise_release "https://github.com/oca/wms/tree/16.0/sale_stock_available_to_promise_release"
    click sale_stock_available_to_promise_release_block "https://github.com/oca/wms/tree/16.0/sale_stock_available_to_promise_release_block"
    click sale_stock_release_channel_partner_by_date "https://github.com/oca/wms/tree/16.0/sale_stock_release_channel_partner_by_date"
    click sale_stock_release_channel_partner_by_date_delivery "https://github.com/oca/wms/tree/16.0/sale_stock_release_channel_partner_by_date_delivery"
    click shopfloor "https://github.com/oca/wms/tree/16.0/shopfloor"
    click shopfloor_base "https://github.com/oca/wms/tree/16.0/shopfloor_base"
    click shopfloor_mobile "https://github.com/oca/wms/tree/16.0/shopfloor_mobile"
    click shopfloor_mobile_base "https://github.com/oca/wms/tree/16.0/shopfloor_mobile_base"
    click shopfloor_mobile_base_auth_api_key "https://github.com/oca/wms/tree/16.0/shopfloor_mobile_base_auth_api_key"
    click shopfloor_reception "https://github.com/oca/wms/tree/16.0/shopfloor_reception"
    click shopfloor_rest_log "https://github.com/oca/wms/tree/16.0/shopfloor_rest_log"
    click shopfloor_workstation "https://github.com/oca/wms/tree/16.0/shopfloor_workstation"
    click shopfloor_workstation_mobile "https://github.com/oca/wms/tree/16.0/shopfloor_workstation_mobile"
    click stock_available_to_promise_release "https://github.com/oca/wms/tree/16.0/stock_available_to_promise_release"
    click stock_dynamic_routing "https://github.com/oca/wms/tree/16.0/stock_dynamic_routing"
    click stock_warehouse_flow "https://github.com/oca/wms/tree/16.0/stock_warehouse_flow"
    click stock_storage_type "https://github.com/oca/wms/tree/16.0/stock_storage_type"
    click stock_storage_type_putaway_abc "https://github.com/oca/wms/tree/16.0/stock_storage_type_putaway_abc"
    click stock_release_channel "https://github.com/oca/wms/tree/16.0/stock_release_channel"
    click stock_release_channel_auto_release "https://github.com/oca/wms/tree/16.0/stock_release_channel_auto_release"
    click stock_release_channel_batch_mode_commercial_partner "https://github.com/oca/wms/tree/16.0/stock_release_channel_batch_mode_commercial_partner"
    click stock_release_channel_cutoff "https://github.com/oca/wms/tree/16.0/stock_release_channel_cutoff"
    click stock_release_channel_delivery "https://github.com/oca/wms/tree/16.0/stock_release_channel_delivery"
    click stock_release_channel_geoengine "https://github.com/oca/wms/tree/16.0/stock_release_channel_geoengine"
    click stock_release_channel_partner_by_date "https://github.com/oca/wms/tree/16.0/stock_release_channel_partner_by_date"
    click stock_release_channel_partner_delivery_window "https://github.com/oca/wms/tree/16.0/stock_release_channel_partner_delivery_window"
    click stock_release_channel_partner_public_holidays "https://github.com/oca/wms/tree/16.0/stock_release_channel_partner_public_holidays"
    click stock_release_channel_plan "https://github.com/oca/wms/tree/16.0/stock_release_channel_plan"
    click stock_release_channel_plan_process_end_time "https://github.com/oca/wms/tree/16.0/stock_release_channel_plan_process_end_time"
    click stock_release_channel_plan_shipment_lead_time "https://github.com/oca/wms/tree/16.0/stock_release_channel_plan_shipment_lead_time"
    click stock_release_channel_process_end_time "https://github.com/oca/wms/tree/16.0/stock_release_channel_process_end_time"
    click stock_release_channel_propagate_channel_picking "https://github.com/oca/wms/tree/16.0/stock_release_channel_propagate_channel_picking"
    click stock_release_channel_shipment_advice "https://github.com/oca/wms/tree/16.0/stock_release_channel_shipment_advice"
    click stock_release_channel_shipment_advice_deliver "https://github.com/oca/wms/tree/16.0/stock_release_channel_shipment_advice_deliver"
    click stock_release_channel_shipment_advice_process_end_time "https://github.com/oca/wms/tree/16.0/stock_release_channel_shipment_advice_process_end_time"
    click stock_release_channel_shipment_advice_toursolver "https://github.com/oca/wms/tree/16.0/stock_release_channel_shipment_advice_toursolver"
    click stock_release_channel_shipment_lead_time "https://github.com/oca/wms/tree/16.0/stock_release_channel_shipment_lead_time"
    click stock_release_channel_show_volume "https://github.com/oca/wms/tree/16.0/stock_release_channel_show_volume"
    click stock_release_channel_show_weight "https://github.com/oca/wms/tree/16.0/stock_release_channel_show_weight"
    click setup "https://github.com/oca/wms/tree/16.0/setup"

    %% Styles
    classDef core fill:#ffebcc,stroke:#b38f00,stroke-width:2px;
    classDef sales fill:#ccf2ff,stroke:#3399ff,stroke-width:2px;
    classDef shopfloor fill:#ccffcc,stroke:#33cc33,stroke-width:2px;
    classDef stock fill:#e0ffff,stroke:#00b3b3,stroke-width:2px;
    classDef release fill:#ffccff,stroke:#ff66ff,stroke-width:2px;
    classDef packaging fill:#ffffcc,stroke:#ffcc00,stroke-width:2px;
```
