User Guide of Odoo Akeneo Connector

Odoo PIM Integration module allows you to integrate your Odoo store with the Akeneo PIM platform.

With the help of Odoo PIM Integration, you can manage your entire categories,products, product models, attributes, attribute options from the Akeneo platform.

Please Note –

• Odoo Akeneo Connector is compatible with Community Edition, Enterprise Edition, and Cloud (PaaS/Flexibility) Edition of Akeneo.
• We only support the Akeneo select type (Simple and Multi-select), Metric, and Boolean type of attributes from Akeneo to Odoo in export.

• Export categories from Akeneo
• Create attributes from Akeneo
• Create attribute options from Akeneo to Odoo
• Send multiple product images
• Works with product variations
• Map Akeneo categories to Odoo categories
• Odoo attribute mapping
• Add new mapping field
• Set default value for attribute mapping
• Multiple export job profiles available – all, categories, attributes, attribute options, product models, products
• Filter exported products based on category, family, time conditions, status, completeness, language, currency, etc
• Admin can create Manual Mapping Of Odoo Fields With Akeneo Fields To prevent Duplicacy(In case of already data present at od
• Export specific products using an identifier (SKU)
• Update exported products for any new changes
• You can export Association(Alternative and Related) product
• More standard attributes can be mapped
• You can use two(Internal reference and Barcode) types of an identifier to export.
• Export categories to the eCommerce categories from Akeneo to Odoo 
• Multiple import job profiles available – all, categories, attributes, attribute options, product models, products
• You can export the product with quick export
• While exporting product you can select the Odoo version
• You can export all category or you can filter then export the category attached to the configured channel.
• Export Variation based on select types, yes or no, and metric type.
  
• View mapped entries log in Akeneo
• Compatible with Odoo latest version 18.x
• Also compatible with the latest version of Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x, 6.0.x and 7.0.x

Before installing Odoo Akeneo Connector module, please see the requirements below:

Odoo Akeneo Connector module works with Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x, 6.0.x and 7.0.x you can download Akeneo from here

Following Odoo apps must be installed: sales, eCommerce, inventory, and website.

Read This Blog

Before beginning the composer installation

1: Get the ACCESS KEYS [Create a support ticket]
2: In Akeneo composer.json, add our repository as well as the installation script.

For Akeneo 6.x  and 7.x

"scripts": {
        "post-update-cmd": [
           "vendor/webkul/odooconnector/src/Webkul/OdooConnectorBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-install-cmd": [
           "vendor/webkul/odooconnector/src/Webkul/OdooConnectorBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-create-project-cmd": [
          "vendor/webkul/odooconnector/src/Webkul/OdooConnectorBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

For Akeneo <=5.x 

{
  "scripts": {
        "post-update-cmd": [
           
"vendor/webkul/odooconnector/composer_install.sh"
        ],
        "post-install-cmd": [
           
"vendor/webkul/odooconnector/composer_install.sh"
        ],
        "post-create-project-cmd": [
         
"vendor/webkul/odooconnector/composer_install.sh"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

3: Use composer to install the extension.

composer require webkul/odooconnector

4: Complete the authentication form.

5: Send a Message of Success

6: Delete your browser’s cache.

• After unzipping the appropriate extension zip, merge the “src” folder into the akeneo project.
• From the PIM directory, run the following command over the NO-DOCKER Instance.

./src/Webkul/OdooConnectorBundle/install/config.sh COMPOSER=false NO_DOCKER=true

•  Run the command below over the PIM directory’s DOCKER instance.

./src/Webkul/OdooConnectorBundle/install/config.sh COMPOSER=false NO_DOCKER=false

For installing Odoo Akeneo Connector module in Akeneo, please follow the below steps:

1 – Unzip the respective extension zip. Then merge “src” folder into akeneo project root directory.

2 – After that goto config/Bundles.php then add line:

Webkul\OdooConnectorBundle\OdooConnectorBundle::class => [ 'all'=> true],

in return array.

3 – Then copy the “config” folder into akeneo project root directory for routing.

To run the Quick export in Akeneo 5.0.x, you need to run the below command.

Install composer dependency

php -d memory_limit=4G /usr/local/bin/composer --prefer-dist --no-scripts require navneetbhardwaj/akeneo-quickexport-configurator;

After that, register bundle in config/bundles.php

Webkul\QuickExportConfiguratorBundle\QuickExportConfiguratorBundle::class => ['all' => true],

Define routing to create a file in the config/routes/wk_quick_export.yml

wk_quick_expoort:
        resource: "@QuickExportConfiguratorBundle/Resources/config/routing.yml"
        prefix:   /

4 – Run this command after ssh to your akeneo server by the terminal

rm -rf ./var/cache/** && php bin/console odoo:setup:install

5. If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.

For Akeneo 5

sudo service php-fpm7.4 restart

For Akeneo 4

sudo service php-fpm7.3 restart

Docker Installation Command :

For Akeneo 5

alias docker_php='docker-compose run -u www-data --rm php php';
alias docker_yarn='docker-compose run -u node --rm node yarn';
docker_php bin/console cache:clear --env=prod;
docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
docker_php bin/console d:s:u --force;
docker_yarn run webpack;
docker_yarn run update-extensions;
docker_yarn run less;

For Akeneo 4

alias docker_php='docker-compose run -u www-data --rm php php';
alias docker_yarn='docker-compose run -u node --rm node yarn';
docker_php bin/console cache:clear --env=prod;
docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
docker_php bin/console d:s:u --force;
docker_yarn run webpack;
docker_yarn run less;

For installing Odoo Akeneo Connector module in Akeneo, please follow the below steps:

1 – Unzip the respective extension zip. Then merge “src” folder into akeneo project root directory.

2 – After that goto app/AppKernel.php then add the line.

new Webkul\OdooConnectorBundle\OdooConnectorBundle(),

in function registerProjectBundles()

3 – Then goto app/config/routing.yml then add these lines at top of the file.

odoo_connector:
     resource: "@OdooConnectorBundle/Resources/config/routing.yml"       
     prefix: / 

4 – You have to navigate first to Akeneo installation directory (Ex: cd /opt/bitnami/apps/akeneo/htdocs). After SSH, you have to run the command to your Akeneo server by the terminal.

rm -rf ./var/cache/** && php bin/console odoo:setup:install

5. If you are using php-fpm. Then you need to restart the php-fpm services.

sudo service php7.2-fpm restart

After that login to your Akeneo panel then go to Odoo Connector>Setup Credentials>Add Credentials.

Then the following page will appear, here you need to enter your Odoo server information:

• URL
• Database Name
• Login Username
• Login Password

Note : We have added validation so that if you enter a duplicate database name when creating credentials, an error will occur.

After saving your Odoo credentials, please go to the Default Configuration tab.

Here you need to define exported products locale, currency, and product identifier.

• Odoo Allowed Company ID: In this, you have to enter the country ID for which you want to export the product, or leave it blank if you want to export all the companies.
• Default Locale – Select a locale according to your Odoo store. Such as English (United States), Spanish (Brazil).
• Currency – Select the default currency of your Odoo store. Such as – US Dollar, Euro, British Pound.
• Default Attribute-Group – Select attribute to import product information from Odoo to Akeneo.
• Default Product Identifier – Select how exported products will be identified in the Odoo store. There are two options available here:

1. Internal Reference (default_code)
2. Barcode (barcode)

• Odoo Version – You can select the Odoo version like 13,14,15,16,17
• Category Export as eCommerce categories – Enable this to export categories to the eCommerce category.

Note: How to get company ID

To get a company ID, navigate to Settings>>Companies>>Manage Company.

After that, click on the company for which you require an ID, and the ID will show up on the URL.

When products are exported to Odoo, you can decide which all product information should be included in the product database.

But first, you need to do the mapping of Odoo product fields with Akeneo attributes.

Default Value – In case you want to set any fixed value for a product field, you can enter it in Default Value. So that all the exported products will have this same product field value.

By default, the following product fields can be mapped between Akeneo and Odoo:

• Internal Reference
• Barcode
• Name
• Description for Internal
• Description for Quotations (description_sale)
• Image
• Description for Vendors (description_purchase)
• Weight
• Description for Pickings (description_picking)
• Description of Delivery Orders
• Volume
• Description for Receptions
• Sale Price (list_price)
• Cost (standard_price)
• Routes
• Product Type
• Can be Sales
• Can be Purchased

Map More Standard Fields

In case you want to send more product information, then you can add more product fields here then map them with Akeneo attributes.

First, you need to enter an Odoo field code then click Add Field button, after that the new mapping field will appear above.

Map Association

In this you can map association products like Alternative produts and Related products then export the association products from Akeneo to Odoo.

To avoid duplicacy of the data at the Odoo end on the first export mapping of category, attributes, attribute option, product, product model, and eCommerce category get created.

In Odoo Connector Configuration, navigate to Attribute Mapping>Manual Mapping.

Mapped Attributes and Categories

Here, you can create mapping manually for category and attributes .

Then you can also filter, search, or delete the mapped categories and attributes.

Create Category Mapping

To create a new mapping for a category, click Create Mapping. The following pop-up window will appear, select Mapping Type as Category.

Then, select Akeneo Category and Odoo Category accordingly. Only one category can be mapped at a time.

Create Attribute Mapping

To create a new mapping for an attribute, click Create Mapping then select Mapping Type as Attribute.

After that, select Akeneo Attribute and Odoo Attribute. Only one attribute can be mapped at a time.

Export Jobs

In this module you will find the following types of export jobs for exporting catalog information to Odoo:

All Export – 

1. Odoo Export All – Using this job you can export all your product data from Akeneo to Odoo.

Attribute Export – 

1. Odoo Export Attribute – Once you will select this job you can export all the Akeneo attributes to Odoo
2. Odoo Export Attribute Option – Once you will select this job you can export all the Akeneo attribute options to Odoo

Category Export – 

1. Odoo Export Category – Using this job you can export all the categories to Odoo.

Product Export – 

1. Odoo Export Product – If you want to export only products to Odoo you have to select the Odoo export product job.
2. Odoo Export Product Model – Once you will select this job you can export all the Akeneo product models to Odoo

Association Export –

1. Odoo Product and Product Model Association Export – If you want to export association product and product model to Odoo then you have to select a job.

1 – Create a product in Akeneo

Create a simple product (having no variations like- size, color) in Akeneo such as a t-shirt, go to Products>Create after that select the Product option. 

After enter any unique SKU then select a family from the list.

After that, you need to fill in the product information as required according to Odoo store.

Please note – only the mapped attributes information will be sent to the Odoo store.

Upload multiple images, mention weight, customer lead time, routes, POS information, and much more.

Please make sure all the attributes are correctly mapped between Akeneo and Odoo.

After that select a category from the left panel then click Save.

2. Odoo Product Export

Once you have created the products in Akeneo, we’ll now export them to Odoo store. Then go to Exports>Create Export Profile.

Then enter a unique code, and label.

After that select Odoo Connector>Export Product then click Save.

Please Note – Before exporting the product you need to export attribute, attribute option, family, and category from Akeneo to Odoo.

Select a channel and locales for exporting products. Then you can even send content for multiple language translations.

Filter Products

You can decide which all products you want to export to Odoo. There are various filters available such as – family, status, completeness, time condition, category.

If you want to export only some specific products, you can enter their SKU in the Identifier section separated by a comma.

Once you have saved the information for the export profile, click Export Now button.

In the execution process, you can check the progress of the export job and view any errors.

As you can see the product created in Akeneo named ‘Red T-shirt’ has been exported to Odoo. Then you can also view and edit any information as you require and then publish the product.

After that check out the Odoo e-commerce storefront view. A customer can see the product name, images, price, buy now details etc.

For exporting products that have variations, you need run Odoo Product Model Export job.

1. Creating Product with Variations

If you want to create a product in Akeneo having multiple variations such as- size, color. Then, go to Products>Create>Choose Product Model. Now, enter any unique code, select a family, then select on what basis variations will be created.

In the following example, I have created a jacket product with two variations according to size – small and medium.

Fill in all the product information required according to Odoo e-commerce store such as name, price, cost price, weight, product type, routes, POS details, customer lead time, etc.

Adding Variations

Once you have entered all the product information that is common to all the variation products, now you need to create a variation product.

After that, click down-arrow icon near size, a small pop-up window will appear.

Add variant product information, select a size then enter SKU. Follow the above step again for creating more variation products.

Now you need to enter variant product information such as weight, barcode, etc.

Please note – the information which is common to all the variations must be entered in the ‘Common’ product only. There is no need to add same information again in variation products.

After saving all the information, then you need to select a category for the product. Moreover, you can select multiple categories also.

2. Exporting Product Variations

Now after you have created all the product models with their variations, it’s time to move on to export process. Go to Exports>Create Export Profile.

After that enter any unique code, and label. Then select Webkul Odoo Connector>Export Product Model after that click Save.

After that select channel and locales for exporting products.

Filter Products

In case you want to send only specific products to Odoo store, you can use various filters based on category, status, completeness, time condition, etc.

Then you can also enter SKUs in Identifier for sending some specific product(s).

After saving your export profile, then click Export Now button to begin execution process.

After that the execution tracker will show you the process of the export job, in case there is an error it’ll appear here.

Once the export product model job finishes, then you need to run export product job so that variations are correctly linked to the main product.

After running both the export jobs, the exported product can be seen in Odoo store including its variants.

If you want to make any changes to the product or its variations, then you can simply click Edit after that do it.

Check out the store front end and see how the product with variations appears.

Note: Only the selected channel category will be exported if you enable the Export Only Channel Mapped Category Tree option in the Odoo Export category.

If the option is disabled, all categories in the selected channel will be exported.