Skip to main content
Odoo Community Association

EDI WebService Component

Beta License: AGPL-3 OCA/edi-framework Translate me on Weblate Try me on Runboat

Provides the component-based edi.webservice.send integration for EDI Exchange records (configured via an exchange type’s advanced settings, under components: send: usage: webservice.send), for setups that still rely on it - including any custom _inherit of this component.

It used to be part of edi_webservice_oca itself; it now lives here so that installing edi_webservice_oca no longer requires component unless you actually need this integration style.

This module itself is not deprecated: it’s the supported way to get component-based integration on demand. The integration style is the legacy one, though - new exchange types should use the model-based handler in edi_webservice_core_oca instead (selected via send_model_id).

Table of contents

Configuration

Go to “EDI -> Config -> Backends” and edit or create one. Find the tab “Webservice” and add a webservice. On the webservice record you can specify all the general parameters to connect to the service (see webservice README for more details).

If you want to take full control on if/how the webservice is used you can do it via exchange type’s advanced settings.

Hence, assuming your webservice has a URL configured as `https://my.endpoint/%7Bpath%7D`:

components:
  send:
    usage: webservice.send  # or any custom component usage inheriting from this
    work_ctx:
      webservice:
        method: post  # mandatory
        kwargs:
          url_params:
            path: endpoint1/foo

For each call related to this type, you’ll get a POST request against https://my.endpoint/endpoint/foo.

url_params can contain all the keys need for URL interpolation.

In addition, you can user url to override the full url used for the call per exchange type.

If you want to send data as bytes you can use the option send_as_bytes like:

[...]
      webservice:
        send_as_bytes: true
[...]

Bug Tracker

Bugs are tracked on GitHub 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.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Dixmit

  • Camptocamp

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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.

Current maintainers:

etobella simahawk

This module is part of the OCA/edi-framework project on GitHub.

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

Metadata

Release files for odoo-addon-edi-webservice-component-oca 18.0.1.0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for odoo-addon-edi-webservice-component-oca 18.0.1.0.0.3
File Interpreter ABI Platform
odoo_addon_edi_webservice_component_oca-18.0.1.0.0.3-py3-none-any.whl Python 3 none any Details

Release files / odoo_addon_edi_webservice_component_oca-18.0.1.0.0.3-py3-none-any.whl

Download URL odoo_addon_edi_webservice_component_oca-18.0.1.0.0.3-py3-none-any.whl
Size 30.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
73e94f604ce1a061975ff8689c5848cd04a7fa610281d70dc8c7d350bbd98a41
BLAKE2b-256 checksum
How to use checksums
789ce7a71d42b6bd38891faea5c98910b1e60bc553c3a75a264cfcb8531ae289
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Release history Release notifications | RSS feed

This release

18.0.1.0.0.3 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page