Menu Close
    Hire Us Request Quote Reading List Switch to Dark Mode
    Blog Version - Magento 2.0.x, 2.1.x, 2.2.x,2.3.x Akeneo PIM 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x and 3.2.x
    • Version Magento 2.0.x, 2.1.x, 2.2.x,2.3.x Akeneo PIM 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, and 3.1.x
    • Version Magento 2.0.x, 2.1.x, 2.2.x,2.3.x Akeneo PIM 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x and 3.2.x

    Magento 2 Akeneo PIM Connector

    Introduction

    Magento 2 Akeneo Connector allows you to integrate your Magento store with Akeneo PIM platform. Using this connector, the store owner can export catalog information from Akeneo to Magento. You can push the bulk amount of data containing categories, attributes, attributes sets, attribute options, and products.

    Please Note – Magento 2 Akeneo Connector is compatible with Community Edition, Enterprise Edition, and Cloud (PaaS/Flexibility) Edition of Akeneo.

    Basic Requirements:

    • You must be using Magento 2.1.x or newer
    • Make sure reindex cron job is running on Magento. For info click here
    • This module works with Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x and 3.2.x. Download Akeneo from here
    • Node and Yarn packages needs to be installed.
    • Also works with Akeneo Cloud Flexibility Mode which is a PAAS Edition of Akeneo

    Video Tutorials

    Check out the following video tutorials below:

    Features

    • Works with simple, configurable, and virtual products.
    • Export product and product model through product only export(CSV)
    • Create multiple jobs and schedule them for execution.
    • All jobs can be exported through normal export/CSV export
    • Map product attributes between Magento and Akeneo.
    • Export all the categories from Akeneo to Magento.
    • Filter exported products based on category, family, status, completeness, etc.
    • Export specific product(s) using SKU identifier.
    • Create attributes, attribute sets, attribute options using Akeneo.
    • Export multiple images of a product (Full size high-resolution supported).
    • Send SEO information with products.
    • Send product information according to locales such as – en, es, de.
    • Support multi-language translations.
    • Akeneo connector module also works with multi-store Magento setup.
    • Source code is fully open for customization.
    • Magento 2 Akeneo Connector is compatible with latest Magento version 2.3.x
    • Now supports importing of products, categories, attributes, attribute group,attribute sets and all job from Magento to Akeneo.

    Magento API Integration

    For creating API in Magento, login to your admin panel and go to ‘System>Integrations>Add New Integration’. In the ‘Name’ field, add any unique name for identification and enter admin panel password in ‘Your Password’. Please leave rest of the field as blank and continue to next step.

    Select APIs for Integration After providing the Integration Info, go to API section and select the following resources and click Save.

    • Catalog, Inventory, Products, Categories
    • Stores, Settings, Currency, Attributes, Other Settings

    Once the API is created, you will see the integration in the list, click Activate.

    The following pop-up window will appear, click Allow button.

    The API credentials will be generated as follows. Then, you need to copy Access Token then paste them in Akeneo configuration.

    Installing Module

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

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

    2 – Goto app/AppKernel.php and add line

    new Webkul\Magento2Bundle\Magento2Bundle(),

    3 – Goto app/config/routing.yml and add these lines at top of file magento2: resource:

    magento2:
      resource: "@Magento2Bundle/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 pim:install:asset --env=prod && php bin/console assets:install web --symlink && yarn run webpack && php bin/console d:s:u --force

    5 – You have to restart your web server like Apache, Nginx. Run the command for Apache web server.

    sudo service apache2 restart
    

    Magento Enterprise Edition Instructions:

    In case you are using Magento 2 Enterprise edition with hypernode, you need to allow one or more of these URLs to be accessible. You can easily modify this in the default configuration. Log in on your Hypernode and edit the file nginx/server.magento2api. Modify the lines of the following block:

    location ~ ^/(pub/)?(rest|soap)(/.+)?/V1/(products|store/storeViews|store/storeConfigs)/?$ {
            return https://support.hypernode.com/knowledgebase/protecting-the-magento-2-api/;
    }

    Remove rest | and save file. Reload nginx service like:

    service nginx reload

    Uninstalling Module

    Please follow these steps for uninstalling the Akeneo Magento2 connector.

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

    new Webkul\Magento2Bundle\Magento2Bundle(),

    2 – Goto app/config/routing.yml and comment or remove these lines.

    magento2:
      resource: "@Magento2Bundle/Resources/config/routing.yml"
      prefix: /

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

    rm -rf ./var/cache/** && php bin/console pim:install:asset --env=prod && php bin/console assets:install web --symlink && yarn run webpack && php bin/console d:s:u --force

    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 web pack 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.

    Setup Credentials in Akeneo

    After successfully installing the module in Akeneo, you need to set up the Magento API credentials in Akeneo. Please log into Akeneo and follow Magento 2 Connector>Setup Credentials. In Hostname, you need to enter your website URL and then enter the Magento API Integration Tokens as created.

    • Hostname
    • Access Token

    Store View Mapping

    If you are managing your Magento store in multiple views, you need to map them to the correct Locale in Akeneo. Select the Magento store view according to the language and country code.

    You can also select the currency for every store view as well. In the store view mapping, you can select the store as default store. So the product will export to your default channel and respected local and currencies which will be selected for the store view.

    Setup Attribute Mapping

    In Setup Attribute Mapping tab, you need to match the product fields between Magento and Akeneo. You need to select the correct Akeneo attribute that matches to the Magento product information.

    We can also add the attribute for variant products. You can map the variant product field in Akeneo so that you can export a variant product. By default, the following product attribute information can be mapped to Akeneo and Magento:

    • SKU
    • Name
    • Weight
    • Price
    • Description
    • Short Description
    • Quantity
    • SEO – Meta Title, Meta Keyword, Meta Description
    • URL Key

    Common Product Field Mapping in Akeneo: Common product field mapping in Akeneo is you can export the attributes to magento2 for both the simple and variant products.

    Variant Product Field Mapping in Akeneo: If you want to export the different attributes for the common and variant product you can choose Variant field mapping and map the attribute. So you will find the different attribute for both the common and variant products in Magento2.

    Example: If you want to set the different price list for the common and variant product you can map the attributes in common product field with price1 and in the variant product field with price2. You will find the two different price for common and variant product in Magento2.

    Status mapping information remains the same on both ends. So if a product is disabled in Akeneo, it will be disabled in Magento as well.

    Map More Standard Attributes

    If your products have lots of information, you can enter Magento attribute code ID and click Add Field. Magento 2 Akeneo Connector module supports various attributes of Magento products. Please make sure to use the same attribute code of Magento in Akeneo.

    Other Mappings

    Attributes to be used as Images – The selected Akeneo image attributes will be visible as Magento product gallery images. Please note – The images will export in sorting order they are selected here.

    Attributes to be used as Export Custom Attributes  When you are going to export the product from Akeneo to Magento2. The selected Akeneo attributes will be visible as custom attributes in Magento. They will appear on the storefront under ‘More Information’ tab.

    Attributes to be used as Import Custom Attributes – When you are going to import the product in Akeneo. The selected attributes will be visible as custom attributes in Akeneo.

    Product Association Mapping

    In association mapping, the product may be associated with none or several other products or product groups. If you want to do an association mapping you can map the product association fields in Magento to Akeneo.

    You can do it for the related products, Cross-Sell Products, and Up-sell Products.

    Other Settings

    In Other Settings tab, you can configure the following settings:

    Attribute Group Export – Here you can select how product attributes should export from Akeneo to Magento. There are two options:-

    • Export all attributes in Single predefined Attribute Group (fast)
    • Export all Attribute groups (slower)

    URL Key Prefix for Product Models (optional) – In cases, where a URL key of product or category are conflicting with each other (Due to no url_key mapping of categories). You can add a prefix for url_key of products.  

    Export Unit with Value of Metric Attributes – You can export the product with metric attribute excluding weight. You can also export the product unit with it.

    There are several ways to add product data in Akeneo, in this user guide we have mentioned using CSV/XLSX file and creating a product in Akeneo.

    Option A – Add Product using CSV/XLSX File

    Using built-in Akeneo CSV Connector and Akeneo XLSX Connector, you can import product data into Akeneo database. When importing product data using CSV or XLSX files, Akeneo PIM extracts the data from the file and converts them to save in the PIM.

    To upload a CSV or XLSX file go to Imports>Create Import Profile and enter Import Profile information – Code and Label. In Job select ‘Product import in CSV’ or ‘Product import in XLSX’ accordingly and Save profile.

    Option B – Creating a Product in Akeneo

    To create a product in Akeneo, go to navigate to Products and click Create button. Now, you need to choose 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. Now enter the required SKU, choose a family, and 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 products type, imposes product information structure and defines the list of attributes for a product that it belongs.

    Add Product Details

    Now you need to provide information about the product. First, select the Channel and Locale and then enter the price, name, and description.

    Select Attribute

    For adding product information, select 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 (used as product media gallery)

    At the moment, the following attribute types are not supported by this connector:

    • Reference data select
    • Reference data multi-select
    • File

    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.

    Upload Image

    Click the upload picture section or use the drag and drop feature to add product image. Please note all the image attributes present in an Akeneo product are added as Product Media gallery images in Magento.

    Multi-Lingual Information

    Add information for other languages and store views.

    Select Category

    After entering all the product information, save your changes and go to Product Navigation and select Categories.

    Create group and Bundle product

    Now to export your product as a Group or Bundle products. For it, you have to install the Magento 2 Group Bundle Product Akeneo Add-on in Akeneo. You can purchase this Add-on here.

    Bundle Products: A Bundle product is a collection of simple and implicit products. Now it is possible to create Bundle products in Akeneo. For it, you have to create Bundle Products in Akeneo and export to Magento2 using CSV Export Job.

    Example: A personal computer system

    Grouped Products: A group product is a collection of simple product that presented as a group. You can also create group products in Akeneo and can export it to Magneto2 using Simple Product Export / Quick Export Job.

    Example: A T-shirt set with different size.

    Magento 2 Export Job

    Now to export your product data you need to create a job profile and execute it. First, go to Exports>Create Export Profile and enter a unique code, label and select a job profile.

    Job Profiles

    Here you will find five different types of export job profiles for every use case:-

    Magento 2 Export Job – Exports everything (categories, attributes, attribute options, attribute group families, and products) based on filters in a job. A product must have a category to be included in the export job.

    Magento 2 All Export Job(CSV)-Exports everything (categories, attributes, attribute options, attribute group families, and products)  in the CSV format.

    Product Only Export to Magento 2 – It exports products to Magento 2. It also adds categories, attributes, family, and variations to a product. You should have exported other data like category, attribute, family prior to this export. Attribute used as the main picture in the family is used as the thumbnail, small image for products.

    A user can map attributes like url_key in Attribute mapping tab. Sometimes url_key of product conflicts with url_key of a category, in that mapping url_key is very useful.

    Category Export to Magento 2 – It exports only categories. you may decide categories to be exported using filters in this job profile. Without filters, it exports all category trees from Akeneo to Magento 2.

    If there is default category tree on Magento then it maps that category root to category root of the selected channel in the job. If you want to use more than one category trees, then export categories then select respective category tree as default category tree on Magento 2.

    Family Export to Magento 2 – It exports family (attribute set) and attribute groups and add already exported attribute to family (attribute set). All attribute group export can be enabled/disabled using Attribute Group export setting in Other settings tab.

    Attribute Export to Magento 2 – It exports attribute and attributes options. It only exports attribute that is mapped in Setup Attribute Mapping tab. This export attribute does not add them to group or attribute set, family export is used for that.

    Magento 2 Product only  Export(CSV)-It exports products to Magento 2. It also adds categories, attributes, family, and variations to a product in the CSV format. You should have exported other data like category, attribute, family prior to this export.

    Product Associate Export- It export the associated product  from akeneo to magento2

    Export Product on Multiple Website

    Here you will find the extra mapping option as Websites. You can map multiple websites with a multi-select option. For it, you have to enter the website id as option code.

    At the time of product creation, you can select the multiple websites for export the product. The product will be export to the selected websites only.

    Setup Properties in Job

    Here you will find two options in setup properties.

    Export only changed or new data: 

    Now you can export only the newly created data. Example: If you have created a product in Akeneo and you want to make the small changes in these (attributes/category/option/family) data.

    You can enable the option Export only changed or new data in properties and can export the changes made by you in Akeneo. It will not override the product in Magento rather it update the existing data.

    Product SKU changed at Akeneo side:

    This feature helps you to remove the duplicate product at Magento store. Example: If you want to make changes in product SKU in Magento2. You have to make the change in the SKU at Akeneo and then enable the icon If Product SKU Changed At Akeneo Side in the export job profile.

    Now you can see the duplicate product will be deleted from Magento2 store.

    Setup Credentials in Job

    In case you are managing multiple Magento instances and want to export product data to some specific Magento store. You can enter each Magento store’s API credentials for every export job.

    Please note – If you have only one Magento instance, then please ignore this section. You just need to provide the credentials in the Akeneo Connector Configuration.

    Store View Mapping – Once you have saved the credentials, click Fetch Store View Mapping and do the mapping of locales and store views including the currency.

    Filter The Data

    Now go to the Content section and select the following options:

    Channel – Each export job can only be linked to one channel, please select the relevant channel of products to export.

    Locales – Select one or more Locales depending on your requirements.

    Attributes – You can select which product attributes you want to export all or a few of them. Click Edit button to select the attributes.

    Edit Attributes

    To make your own attribute selection, click on the left side to select a specific attribute group (or All groups to display all attributes). The selected attributes will be displayed as columns in your export file.

    Filter The Products

    Now you need to decide which products to export on Magento.

    Family

    Select one or more product family to export to Magento. If you want to export products belonging to specific families, click on the drop-down list and click on the families to add in the field like clothing, shoes, t-shirts.

    Status

    You can also filter on the status of your products, three options available:

    • All – to export all products whatever their status is
    • Enabled (default option) – to only export enabled products
    • Disabled – to only export enabled products

    Completeness

    This enables you to filter on completeness of selected locales. Four options on completeness are proposed:

    • No condition on completeness – all products will be exported whatever their completeness is.
    • Complete on at least one selected locale (default option) – products must be complete on at least one locale
    • Complete on all selected locales – products must be complete on all locales (if you have selected more than one locale).
    • Not complete on all selected locales – products must not be complete on all locales (if you have selected more than one locale).

    Time Condition

    You can now export your product on a specific time condition.

    • No date condition (default option) – Products are not filtered using time condition.
    • Updated products over the last n days (e.g. 6) – To filter the products that were updated during the last six days, enter 6 value.
    • Updated products since this date – To filter the products that were updated during a specific date, select a date.
    • Updated products since last export –

    Category

    You can configure the categories of the channel tree you want to export. For example, you want to export the clothing products to update. By default, all categories are exported. To select a category, click n the Edit button the categories of the channel tree are displayed.

    Identifier

    You can make a selection of identifiers to export by adding them in the SKU field. You can copy and paste a list of identifiers, separated them by using comma, space or line breaks. After that click Save button and follow the next step to execute this profile.

    Magento2 CSV Export Job

    Now you can export the product to fastly to Magento2 store with Magento2 CSV export job. Akeneo product will be automatically updated on the Magento store.

    You can export the product also with the simple product export job but it will take more time than CSV export.

    For it, you have to install upload the app folder to your Magento2 installation directory. You will find the app folder in our latest version of connector. You will find the app folder in ImportProductQueue folder.

    After uploading the folder, you have to navigate the Magento2 installation directory with commands. You have to run these commands:

    composer require firegento/fastsimpleimport
    php bin/magento module:enable FireGento_FastSimpleImport
    php bin/magento setup:upgrade
    php bin/magento setup:di:compile;
    php bin/magento setup:static-content:deploy;
    

    After it, you have to flush the cache and reindex all.

    php bin/magento cache:clean;
    php bin/magento indexer:reindex;
    

    After it, you can create the CSV export profile for the faster product export.

    After clicking on the save button, you can see the export job profile created by you.

    After clicking on the save button your export profile will be ready to use.

    Here, you will get the option as well as the simple export product profile. You can also download the product CSV file to enable the icon Disable Automatic Remote CSV Upload.

    Export Now

    After creating the export profile, click on the Export Now button. The execution of the export process will begin, the page will refresh continually to update the information.

    Execution Process

    Wait for execution process to complete and check the errors. After the completion of the export job, the products will appear in Magento catalog.

    Magento Store

    As you can see that the following products have been imported from Akeneo. The admin can view the products and make any changes in product edit form of Magento.

    Product Information Update

    You can also update or make any changes to the imported products like stock status or quantity, price, special price, meta information, description etc.

    Magento Standard Attributes Using Magento standard attribute ID, we have mapped the special pricing information through Akeneo export job.

    Content – In the content section, you can see the description and short description of the product listing.

    SEO Information – Here, all the SEO information is available from Akeneo. You can see the URL key, Meta Title, Meta Keywords, and Meta Description.

    Product Images – Images are imported in the same sequence order as set in the module configuration of Akeneo Connector.

    Storefront

    Just like normal Magento products, Akeneo products will appear on the storefront. Check out the long description and more information tab.

    Quick Export Job

    Magento 2 Akeneo Connector has an amazing feature, where you can quickly create or export product(s) without going through all the job creation process. The Quick Export feature allows you to quickly export a product to Magento. To do that, go to the Products page and select product from the list and click Quick Export.

    Now select Magento Export (All Attributes) option. After that small slide notification will stating Quick Export job has been launched.

    You can check the progress of the job, by going to Activity>Process Tracker. Also, once the quick export job is complete, you can see the notification message on top.

    Magento Import Profile

    Now in the updated Akeneo Connector, you can now import your product catalog data from Magento to Akeneo. There are various job profiles available for importing products, categories, attributes, attribute sets from Magento to Akeneo.

    To do the import go to Imports>Create Import Profile, enter a code and label. Following job profiles are available:

    Magento 2 Import -This will import everything from Magento. All products, categories, attributes, attribute sets.

    Families Import – This will import all attribute sets of Magento into Akeneo families.

    Product Only Import – This will import all the simple and virtual products of Magento.

    Category Import – This will import all the Magento categories to Akeneo.

    Attribute Import – This will import all the attributes from Magento to Akeneo.

    Attribute Group Import – This will import all the attribute groups to Akeneo.

    Once you have selected the import job profile, from the Content section, you can select the channel and locales for import product data. You can also import multi-language data from Magento to Akeneo.

    Setup Credentials – In case you are managing multiple Magento stores, you can provide separate API credentials for each Magento store individually.

    Once everything is set up correctly, you just need to click Import Now button and the import execution process will start. From the following screenshot, you can see the number of categories, attribute groups, attributes, etc are being imported to Akeneo.

    Support

    For any issues related to this module, please create a support ticket at- https://webkul.uvdesk.com/en/customer/create-ticket Also, for any pre-sales queries or customization discussion, please drop an email to support@webkul.com

    Current Product Version - 1.4.8.4

    Supported Framework Version - Magento 2.0.x, 2.1.x, 2.2.x,2.3.x Akeneo PIM 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x and 3.2.x

    . . .

    Comment

    Add Your Comment

    Be the first to comment.

    Back to Top
    css.php
    Hire Us!
    Brief us about your requirements and we'll get back to you.
    Woo! Hooy!
    We have just recieved your project brief and our expert will contact you shortly.
    Send Again
    Close

    Table of Content

    Hide Index