View source | Discuss this page | Page history | Printable version   
Main Page
Upload file
What links here
Recent changes

PDF Books
Add page
Show collection (0 pages)
Collections help


Module:Retail API



This module provides the Openbravo Retail API. It contains the definition of the different Retail API entities and exposes web services to import and export the information.

Retail API Entity Mapping

Bulbgraph.png   Before starting reading this section, we recommend to take a look at the External Integration Infrastructure User Guide.

The definition of the standard Retail API entities is present in the Entity Mapping window. These definitions can be modified and/or extended with custom modules as any other entity mapping definition.


The export mappings (From Openbravo to External System integration direction) allows to define export filters which can be created under the Export Filters subtab.

Each of the records present in this tab will result in a new filter of the entity export endpoint. In addition, a default filter "byID" is automatically added for each export entity. Note that the definition of the byID filter is not displayed in this tab.


The export filters require the following information:


If an export filter uses parameters, the metadata information of each parameters should be added in the Export Filter Parameters tab:


Retail API Web Services

The Retail API module provides a set of

Open API Specification

The specification of the Retail API Web Services can be seen and tested with this live environment.

Status Web Service

The import of elements through any of the available Retail API import web services is done in an asynchronous way using EDL. This web services usually return the ID of the EDL request in charge of the import task.

The Status Web Service allows to check the status of that kind of EDL requests in order to know whether the import process has (successfully) ended or not. This service can be invoked through a GET request to the following URL:


Updating the Open API Specification

Bulbgraph.png   Before starting reading this section, we recommend to take a look at the OpenAPI User Guide.

If any of the Retail API entities is modified or a new export filter is added, the Open API specification of the web services should be updated accordingly.

To help with this task the Retail API module provides an ant task called generate.doc. This task should be invoked inside the Retail API module as follows:

Bulbgraph.png   To execute this task it is required to also have the OpenAPI module installed.
ant generate.doc

Once this tasks is completed the Open API specification file (org.openbravo.retail.api-RetailAPI.json) will be updated.

Deploying the Retail API

To deploy and visualize the Retail API with Swagger UI, the steps described here needs to be followed.

Process to change the Retail API

The main goal of this project is to provide a business, functionally-relevant webservice-based API that customers can use to integrate their systems with Openbravo.

In order to achieve this goal, the API should remain reasonably stable over different releases so that customers can update Openbravo without fear of breaking their integrations.

That said, sometimes it is unavoidable to make changes. The way these changes should happen is the following:

The API changes documentation can be found here.

Retrieved from ""

This page has been accessed 28,221 times. This page was last modified on 18 May 2020, at 06:55. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.