Odoo Community Association

EDI WebService Core

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

Attach a webservice.backend to an EDI backend, and send EDI exchange files through it.

This module provides:

edi_webservice_component_oca provides the component-based equivalent (components/send.py) - a legacy integration style, kept in its own module so installing it (and component with it) is opt-in. edi_webservice_oca is now just a deprecated umbrella depending on both, kept to preserve existing installations.

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_core README for more details). On the webservice backend you can configure one or more webservice.endpoint records (path, HTTP method, …).

On the exchange type you want to send through a webservice, go to the “Execution handlers” tab, set “Sender” to “EDI WebService Send Handler”, then pick the “Endpoint” to call in the “Webservice settings” group that appears - it drives both the URL (backend URL + endpoint path) and the HTTP method.

Static headers and querystring params are best set directly on the webservice.endpoint record itself (its “Headers” and “URL Params” tabs) - prefer that over the exchange type’s advanced settings below, which are meant for one-off, per-exchange-type overrides rather than the endpoint’s own regular configuration.

If you still need extra call parameters beyond what the endpoint (and its own headers/URL params) provide, you can add them via the exchange type’s advanced settings:

execution_model:
  send:
    webservice:
      kwargs:
        headers:
          X-Custom-Header: foo
        url_params:
          foo: baz

On a webservice endpoint, the Exchange Types smart button lists the exchange types sending through it.

If you want to send data as bytes you can use the option send_as_bytes on the exchange type (same tab).

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

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.