View source | View content page | Page history | Printable version   

Projects:Integration Magento Connector



This documentation describes the functional and technical details for the standard Openbravo connector to Magento, delivered as set of extension modules including:

Magento is a digital commerce platform that provides online merchants with flexibility and control over the look, content and functionality of their online stores.

The aim of the Openbravo connector to Magento is to enable the integration between the two systems, therefore Magento can act as another POS processing sales, but online as an “e-commerce” sales channel.

The version of Magento to be used needs to be starting from 2.0. New versions of Openbravo connector to Magento module can be released if required, depending on the functionality added in further published Magento versions.

Magento Configuration

Before using the connector, a clean Magento instance is needed with a basic configuration.

Current connector only supports single store configuration:


Then, it is needed to configure the country, currency, payment methods, shipping methods, etc. to use.

Following document explains how to do a clean set up and a basic configuration of Magento 2:


More documentation can be found in Magento documentation

Openbravo Configuration

Now, we will explain how to set up the connector in Openbravo and how to run it.


Before starting Openbravo configuration, it is necessary to apply Magento Connector - Mappings module's dataset.


This dataset will create in Openbravo some Magento default values like:

Those new records will be mapped in External ID Mappings window using the default External Instance Identifier: MAGCON_MAGENTO.



To be able to communicate with your Magento instance, you need to set it up in Magento Access Configuration window, introducing the instance URL and the access token.

Once configured, you can check connection by clicking on Check Magento Access Configuration button.

After checking the connection, you need to click on Get Hierarchy button to map Magento Web Site, Store and Store View and be able to link it with Magento Touchpoint.



A new Organization should be created to map with Magento store including default values in Retail Configuration section.

This organization will be used to define the master data exported to Magento and to register the orders imported from Magento. Magento orders could be accessed from other stores using Cross Store operations.


Another option would be to link Magento touchpoint to an existing physical store, sharing the same master data.


Current connector doesn't support multi warehouse integration. Thus, Magento organization must define a one unique warehouse. The stock of this warehouse will be the one integrated with Magento.


A new Magento Touchpoint Type should be created for E-commerce Channel, including needed Magento Payment Methods.


A new Magento Touchpoint should be created for above Organization and Touchpoint Type, including needed Magento Payment Methods and linked to Magento Store View.


Export/Import Process

Two new records need to be created in EDL Configuration window for Retail API Based Export Process and JSON Based Import Process processes and DebugAndStore output type.



We can schedule export and import background processes from Process Request window.

It is possible to run the process exporting/importing all configured entities or to define in the Entity to Integrate tab which entities we want to integrate.

The first time the integration process is run, it will search for every data to integrate using Retail API (full refresh). Next time, it will only search for data pending to integrate since last synchronization (incremental refresh).



Integration Entities

This section describes the entities to exchange between the two systems, together with the import and export flow to take into account.

Integration entities are defined in Entity Mapping window, using Retail API integration API type.


Entities to Export: Openbravo -> Magento

Export To Magento Synchronization Process will export Openbravo master data visible for Magento touchpoint to Magento, in order to automatically set up Magento store.


Openbravo will export Taxes to Magento to be able to define which rate applies to each Product available in Magento.

Following entities are included in this integration:


Openbravo will export Characteristics to Magento to be able to define the list of characteristics that applies to each Product available in Magento.

Following entities are included in this integration:


Openbravo will export every item or service Product in the Magento assortment to Magento together with the description, price, image and available stock.

Every Product related with a generic one, will be consider as a variant product in Magento. Magento will show generic products in the catalog to the end customer, but not variant products. End customer will be able to select the generic product and choose between available options for it. Chosen options will define the variant product purchased by the customer.

Following entities are included in this integration:


Openbravo will export “Fixed Percentage Discount”, “Price Adjustment with discount percentage”, “Price Adjustment with discount amount” and “Buy X pay Y of same product” discounts to Magento as cart discounts and “Price Adjustment with fixed unit price” discounts as special price discounts.

Following entities are included in this integration:

Entities to Import: Magento -> Openbravo

Import From Magento Synchronization Process will import every sale registered in Magento into Openbravo, in order to make them accessible from Web POS.


Openbravo will import every customer registered in Magento store.

Following entities are included in this integration:


Openbravo will import every Order created in Magento store.

Imported orders will create a booked Sales Order in Openbravo with the Payment Method used in Magento, with a line for each item purchased in Magento and with one more line indicating the Shipping Method used in Magento.

Following entities are included in this integration:

Use Cases

We will describe briefly the main flows that can be done using the connector.

Home Delivery

Sale in Magento and deliver home using AWO.

Payment could be done in Magento (online payment) or in Openbravo using Web POS (store payment).

To allow online payments, a payment extension like PayPal should be integrated with the connector.

Buy Online Pick Up In Store

Sale in Magento and deliver in store using Web POS.

Payment could be done in Magento (online payment) or in Openbravo using Web POS (store payment).

To allow online payments, a payment extension like PayPal should be integrated with the connector.

To allow store pickup, a pickup extension like Wyomind should be integrated with the connector.

Buy Online Return In Store

Sale in Magento and return in store using Web POS.

Advanced Functionality

Further versions of the standard Openbravo connector to Magento might support advanced functionality, such as:


File:Openbravo Connector to Magento-Functional&Technical Desingv4.pdf

Retrieved from ""

This page has been accessed 3,905 times. This page was last modified on 29 August 2019, at 12:17. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.