Menu Close
    Searching for an experienced Akeneo Development Company ?

    OpenCart Akeneo Connector


    OpenCart Akeneo Connector allows you to connect your OpenCart website with the Akeneo PIM platform. Using this integration, you can export products, categories, attributes (including values), attribute groups, and product images from Akeneo to the OpenCart store.

    Please Note

    • This module is compatible with the Akeneo community and Enterprise(Flexibility) edition.
    • If you want to use this extension on Akeneo EE Serenity mode, please contact us.
    • For the Akeneo installation, your Akeneo server should meet these system requirements.


    • Mapping Akeneo attributes with OpenCart product fields
    • Create an additional mapping for more product fields using OpenCart field code.
    • Send detailed information about catalog information from Akeneo to Opencart
    • Export multiple images of a product.
    • Filter Data to be exported based on category, family, completeness, time condition.
    • Using SKU you can export only specific product(s) to the OpenCart store.
    • Select language and currency for product export jobs.
    • Individual jobs for the category, attribute group, attribute, attribute option, and product export.
    • View mapped entries of previous export jobs.
    • Update exported product information from Akeneo.
    • Send multi-language content to OpenCart.
    • 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 and 4.0.x

    Video Tutorials

    OpenCart Connector Configuration


    Module Installation Version 4.0.x

    Please follow these steps for installing OpenCart Akeneo Connector module in your Akeneo PIM platform.

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


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

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


    in return array.

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


    – Then run this command after ssh to your akeneo server by the terminal

    php bin/console cache:clear--env=prod;

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

    Module Installation Version 2.X To 3.X

    After extracting the downloaded zip file you will find two folders, one for Akeneo and another for OpenCart. Please follow the process for installing the modules on both platforms.

    Opencart Akeneo Connector

    Akeneo Module Installation

    1. Open Akeneo folder  then merge the “src” folder into akeneo project root directory.

    Upload src folder

    2. After that goto app/AppKernel.php then add the line
    Code in AppKernel.php files

    new Webkul\OpencartConnectorBundle\OpencartConnectorBundle(),

    in function registerProjectBundles()

    3. After that 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.

    Code add in Routing.yml file

        resource: "@OpencartConnectorBundle/Resources/config/routing.yml"
        prefix:   /

    OpenCart Module Installation

    1. Upload the ‘catalog‘ folder to the root directory of Opencart’s root directory.

    2. Find ‘wk_akeneo.ocmod.xml’ file inside Opencart>ocmod folder then upload it from OpenCart admin panel (Extension>Extension Installer).

    ocmod upload

    3. Refresh the cache from the admin side (Extension>Modification) by clicking the refresh button at the top.refresh cache modification
    4.  Add an API from System>Users>API (add API). After that enter any API Name then click Generate button, the API Key will be created.

    add opencart api
    5. If there are any changes in the ‘admin’ or ‘catalog’ folder names then replace them at the file catalog/controller/api/akeneo/catalog.php at 618 line in (str_replace(‘catalog’,’admin’,DIR_APPLICATION)).

    6. Run this command after ssh to your akeneo server by the terminal

    php bin/console cache:clear--env=prod;
    php bin/console opencart:setup:install && php bin/console opencart:batch:quick_export

    7. After that you have to restart your web server like Apache, Nginx. Run the command for Apache web server.

    sudo service apache2 restart

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

    sudo service php-fpm7.2 restart

    Uninstalling Module Version 4.0.X

    Please follow these steps for uninstalling the  OpenCart Akenoe Connector.

    1 – Goto config/Bundles.php then  remove this line.

    2 –After that goto config/routes and remove wk_shopify.yml file.

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

    Uninstalling Module Version 2.X To 3.X

    Please follow these steps for uninstalling the OpenCart Akeneo Connector.

    1 – Goto app/AppKernel.php and comment or remove this line.

    2 – After that goto app/config/routing.yml and comment or remove these lines.

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

    Common Issues After Installation

    It might happen that even after proper installation, upon opening your Akeneo admin dashboard, you see a loading screen. In that case, do check for the following solution:

    • Webpack Installation: If you get the below error


    • It means that webpack is not installed in your system. Run the following command
      npm install --save-prod webpack
      npm install
    • Module routing.yml is not configured properly. Re-check the routing.yml file as mentioned in the 3rd step of Module Installation
    • Clear your browser cache.

    Akeneo Connector Configuration

    Once you installed the modules on both the platforms, after that please log in to your Akeneo panel after that go to OpenCart Connector>Server Credentials.

    Then here you need to enter your OpenCart store URL then paste the API Key generated.

    opencart store credentials

    Default Configuration

    After that go to the Default Configuration tab then select your default language and default currency of your OpenCart store.

    Also, you need to mention where Akeneo product SKU will be mapped in OpenCart, you have the following options:

    • SKU
    • UPC
    • EAN
    • JAN
    • ISBN
    • MPN


    Locale Mapping

    In the Locale Mapping section, you need to map the Akeneo locale with OpenCart Locale ID. So that you’ll be able to send content in multiple languages.


    Product Field Mapping

    You can mention detailed information about your products by creating attributes in Akeneo and mapping them OpenCart product fields. By default, the following product fields can be mapped:

    • Product Name
    • Description
    • Meta Information – Tag Title, Tag Description, Tag Keywords
    • Product Tags
    • Model, SKU, UPC, EAN, JAN, ISBN, MPN
    • Price
    • Quantity
    • Minimum Quantity
    • SEO URL
    • Weight
    • Product Images
    • Store IDs


    Map Existing Attributes, Attribute Groups, and Categories

    For avoiding duplication of attributes, attribute groups, and categories creation in OpenCart, you must map them with Akeneo before running an export job.


    To do new mapping, click Map Attribute/Category button then click Create Mapping. After that select Mapping Type as – Category, Attribute or Attribute Group.

    Then, select Akeneo value and OpenCart value, click Save.


    Once everything is mapped between Akeneo and OpenCart, you can check the mapping entries below.

    Please note that, if you have deleted the exported attribute, attribute group, category, or product in OpenCart and want to export that to them again. Then, you must delete the mapped entries from here.


    Map More Fields

    In case you want to send more product information from Akeneo, you can add the OpenCart product field code then map it with the Akeneo attribute code.


    Option Mapping

    Option Mapping is used to map the attributes of variants product. Map the Quantity, Weight, Price, Points attribute with the Variant Axes. If you do not map the attributes with the variant axes then the value will zero.

    Create Product in Akeneo

    After that to create a product in Akeneo, go to navigate to Products then click the Create button.

    After that, you need to choose the product type – as Product or Product Model.

    Product – Select this type for creating simple and virtual products.

    Product Model – Select this type for creating a configurable product with variations.Select the product Now enter the required SKU, choose a family,then click the Save button.

    Product Family – A family is a set of attributes that will be the same for all products belonging to a family. The product family represents product type, imposes product information structure, and defines the list of attributes for a product that it belongs.

    After that go to Products>Create then select the Product option. Then, enter any SKU then select a family.sku family

    Select Attributes

    For adding product information, select the attribute options you require. You can also create new options for the attribute. Following Attributes from Akeneo are supported for export:

    • Text
    • Text Area
    • Number
    • Date
    • Boolean
    • Select
    • Price
    • Metric
    • Image
    • Reference data select
    • Reference data multi-select
    • File

    Add Product Details

    Now, you can provide all the information about this new product such as – name, price, description, model, etc.

    add product information

    You can mention as much information as you want, but please make sure that you have correctly mapped the Akeneo attributes with OpenCart product fields.

    other information

    Add New Attribute Option

    If an attribute option is missing for a select attribute type (simple or multi-select), you can directly add it to the Product Edit Form. Enter a Code and Label values, then click Save.

    Add attribute option

    Upload Images

    You can upload multiple images of a product.

    upload multiple images

    Please make sure you have mentioned the image attribute codes in module configuration.

    akeneo image attribute codes

    Multilingual Information

    You can mention translated content for multiple locales.

    locale informationSelect Category

    Select a category for this product from the left menu panel. You can also select more than one category.

    select categories

    Export Job

    Using OpenCart Akeneo Connector, you can create five types of export jobs for sending product catalog information to the OpenCart website.

    5types of jobs

    Export All – If have newly set up your OpenCart store, you can use this job for exporting all the attributes, attributes groups, categories, products from Akeneo to OpenCart.

    Create a Job Profile

    To export everything from Akeneo to OpenCart, go to Exports>Create Export Profile. Then enter any code and label. Then select Job as Webkul Opencart Connector>Export All.

    export all

    Select Locale

    Once you create an export profile, you need to select an Ecommerce channel and choose for which locales your content will be sent. Please make sure you have mentioned all the translated content in your products.export all - content

    Filter Export Data

    To avoid exporting all the products from Akeneo to OpenCart, you can decide which all products should be created in OpenCart. There are various filters through which you send only selected products to your eCommerce store.

    • Family – Send products belonging to a family.
    • Status – Send only enabled or disable products.
    • Completeness – Send products whose information is complete.
    • Time Condition – Send products based on date edited, created, etc.
    • Category – Send products belonging to a category.
    • Identifier – Mention SKU separated by commas for sending only specific products.

    export all - filter data

    Export Now

    After saving all the details, click Save. Export Now button will be visible to you. Here you can see the progress of your export job, you can check the number of data read and written to OpenCart, plus view any error logs as well.

    export all process

    View Exported Products in OpenCart

    You can see the exported product in the Opencart catalog folder. If you want to edit or change the information you can also do it as well.

    exported product in opencart

    Exported product general information, you can also see the translated information for the product with meta information.

    exported product data

    View multiple images of an exported product.

    exported product images

    Check out the detailed product information in the Data tab.

    exported product info

    Export Attribute

    For exporting all the attributes from Akeneo to your OpenCart store, you can use the Export Attribute profile. Go to Exports>Create Export Profile. Now enter any code, the label then selects Webkul Opencart Connector>Export Attribute.export all attributes

    Once you have created and saved the job, you can click the Export Now button.

    export all attributes - process tracker

    After the completion of the export process, you can see the new attributes in the OpenCart admin panel.

    attributes exported to opencart

    Export Attribute Group

    For exporting all the attribute groups from Akeneo to OpenCart store, please go to Exports>Create Export Profile and enter the following information. You need to select Webkul Opencart Connector>Export Attribute Group.

    export attribute groups

    Once you have saved the profile, please click the Export Now button. You can check the progress of the export execution process.

    attribute groups export process

    As you can see the Akeneo attribute groups have been created in OpenCart. Please note all the attribute groups will be exported to OpenCart.

    exported attribute groups

    Export Categories

    If you want to export all the categories from Akeneo to Opencart, then you can use the Export Category job. Go to Exports>Create Export Profile and enter code, label, select Webkul Opencart Connector>Export Category job.export category job

    Once you have saved this profile, please click the Export Now button. You can see the progress of your export process.

    export category process

    After the completion of the export process, all the categories of Akeneo will be created in OpenCart. But, please note that to make the parent category visible on the frontend in the top menu bar, you need to edit a category and enable Top option.

    exported categories

    Export Products

    Now, if you want to export only products to OpenCart from Akeneo, you can use the Export Product job. Please go to Exports>Create Export Profile and choose Webkul Opencart Connector>Export Product. Enter any code and label for this job profile.export product job

    Using Filter The Data section, you can filter products which you want to export to OpenCart store. So that all the products are not exported to Opencart.

    export product job - filter data


    Thank you for reading this documentation. In case you find anything missing or not explained correctly, or you have any customization needs, reach out to us at [email protected]. You can also raise a ticket at our HelpDesk System.

    Please explore our Akeneo Development Services and Quality Akeneo Extensions.

    Current Product Version - 1.1

    Supported Framework Version - OpenCart 2.3.x.x, 3.x.x.x || Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x and 4.0.x

    Blog Version - OpenCart 2.3.x.x, 3.x.x.x || Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x and 4.0.x
    • Version OpenCart 2.3.x.x, 3.x.x.x || Akeneo 2.0.x, 2.1.x, 2.2.x, and 2.3.x
    • Version OpenCart 2.3.x.x, 3.x.x.x || Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, and 3.1.x
    • Version OpenCart 2.3.x.x, 3.x.x.x || Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x and 4.0.x
    • Version OpenCart 2.3.x.x, 3.x.x.x || Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x and 3.2.x
    • Version OpenCart 2.3.x.x, 3.x.x.x || Akeneo 2.0.5 or newer
    . . .
    Discuss on Helpdesk

    Leave a Comment

    Your email address will not be published. Required fields are marked*

    Be the first to comment.

    Back to Top

    Table of Content

    Hide Index