Magento 2 Akeneo Connector

The Magento 2 Akeneo Connector allows you to integrate your Magento (Adobe Commerce)store with the Akeneo PIM platform. Store owners can manage any number of products easily.

Using this connector, the store owner can export catalog information from Akeneo to the Magento 2 (Adobe Commerce Cloud)store through API calls.

Simply, select the product attributes you want to export with the products at the time of the export job.

The store admin can make modifications as required once the products have been exported from Akeneo.

Moreover, if you don’t want to export all the products, you can use various filters using category, SKU, time condition, completeness, and attribute family.

With the Akeneo connector store owners can import categories, families, attributes, options, product models, family variants, and products.

Basic Requirements:

• You must be using Magento 2.1.x to 2.3.4 or newer
• Make sure the reindex cron job is running on Magento. Click here to know about how to configure and run cron.
• This 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. Click here to Download Akeneo.
• Node and Yarn packages need to be installed.
• 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.

Please Note:- If you want to export your old data from the Akeneo to the Magento store please reach out to us at [email protected].

• The Admin can export a video URL from Akeneo to Magento 2.
• Magento2 Akeneo Connector compatible with Product Attachment for Magento 2
• 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.
• Support boolean single-level multi-attribute, 2-level multi-attribute, and metric-type attributes will be exporting variants.
• Filter exported products based on category, family, status, completeness, etc.
• The export-specific product(s) using SKU identifier.
• Create attributes, attribute sets, and attribute options using Akeneo.
• Export multiple images of a product (Full size high-resolution supported).
• Send SEO information with products.
• Magento 2 Akeneo Connector module is compatible with Akeneo Versions 2,3,4,5,6 & 7.
• The source code is fully open for customization.
• Magento 2 Akeneo Connector is compatible with the latest Magento version 2.4.x

For creating API in Magento, login to your admin panel then go to ‘System > Integrations > Add New Integration’.

In the ‘Name’ field, add any unique name for identification and enter the admin panel password in ‘Your Password’.

NOTE:- Please leave the rest of the field blank then continue to the next step.

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

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

For Product Attachment :

For Product attachment, you have to select the following :

• Admin Product Attachment Api
• Product Attachment

After that, once the API is created, you will see the integration in the list, then click Activate.

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

The API credentials will be generated as follows. After that, you need to copy Access Token and then paste them into the Akeneo configuration.

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

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

composer require webkul/magento2bundle

composer require webkul/magento2bundle:3.1.0

composer require webkul/magento2bundle:2.1.0

•  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/Magento2Bundle/install/config.sh COMPOSER=false NO_DOCKER=true

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

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

Please follow these steps for installing Magento 2 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 the line:

Webkul\Magento2Bundle\Magento2Bundle::class => ['all' => true]

in the return array.

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

4- After that 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;

5 – After that run this command after ssh to your Akeneo server by the terminal

rm -rf var/cache/ && php bin/console magento2:setup:install

6. 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

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;

Please follow these steps for installing Magento 2 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 – Goto app/AppKernel.php then add a line

new Webkul\Magento2Bundle\Magento2Bundle(),

3 – After that goto app/config/routing.yml then 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 magento2:setup:install

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

sudo service php-fpm7.2 restart

Magento Enterprise Edition Instructions:

In case you are using Magento 2 Enterprise edition with hypernode, then 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/

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

sudo service php-fpm7.2 restart

To configure for Magento >= v2.4.4, you have to run the following command from the Magento root directory:

bin/magento config:set oauth/consumer/enable_integration_as_bearer 1

However, 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
• After that clear your browser cache.

./src/Webkul/Magento2Bundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true

• After that run the command below over the PIM directory’s DOCKER instance.

./src/Webkul/Magento2Bundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false

After successfully installing Magento 2 Akeneo Connector in Akeneo, then you need to set up the Magento API credentials in Akeneo.

Please log in to Akeneo then 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

Export Attribute Set Based On – The Akeneo family will export this select attribute set to Magento. This is a required mapping.

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

Then you can also select the currency for every store view as well. In the store view mapping, you can select the store as the default store.

So the product will export to your default channel and respected local, currencies which will be selected for the store view.

In the Setup Attribute Mapping tab, you need to match the product fields between Magento and Akeneo.

Then you need to select the correct Akeneo attribute that matches 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 products you can choose Variant field mapping and map the attribute.

So you will find the different attributes for both the common and variant products in Magento2.

Example: If you want to set the different price lists for the common and variant products you can map the attributes in the common product field with price1 and in the variant product field with price2.

Then you will find the two different prices for common and variant products 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 as Magento in Akeneo.

Users can use any sample attribute code to create a new attribute field and map them with the product field.

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 the sorting order they are selected here.

Attributes to be used as Image alts: If images are not exported in Akeneo, you must map the attribute whose value you wish to be shown.

The admin needs to add the picture name so it will fetch as an ALT name on Magento 2.

Once you map the ALT name with attributes it will show the same on Magento 2 in the same order.

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.

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

Add Product Details

Then you need to provide information about the product. First, select the Channel and Locale, after that enter the price, name, and description.

Select Attribute

For adding product information, select the attribute options you require. You can also create new options for the attribute. The 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

After that click the upload picture section or use the drag and drop feature to add product images.

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 of Products

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

However to export your product as a Group or Bundle product. For it, you have to install the Magento 2 Group Bundle Product Akeneo Add-on in Akeneo.

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 it to Magento2 using CSV Export Job.

Example: A personal computer system.

Grouped Products: A group product is a collection of simple products that are presented as a group.

You can also create group products in Akeneo and can export them to Magento2 using Simple Product Export / Quick Export Job.

Example: A T-shirt set of different sizes.

After that to export your product data you need to create a job profile and execute it. First, go to Exports > Create Export Profile

Then enter a unique code, label, and select a job profile.

Job Profiles

However 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, and family prior to this export.

The attribute used as the main picture in the family is used as the thumbnail, a small image for products.

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

Category Export to Magento 2 –

The default Magento 2 tree will be exported with all of the categories. The child categories that are active in multiple channels can be selected.

If you want to use more than one category tree, then export categories then select the respective category tree as the default category tree on Magento 2.

Family Export to Magento 2 –

It exports the family (attribute set) and attribute groups and adds already exported attributes to the family (attribute set).

All attribute group export can be enabled/disabled using the Attribute Group export settings in the Other settings tab.

Magento 2 Configurable and Variant Product Export Job –

It exports only Configurable and Variant products to Magento 2. Users can map categories accordingly.

Note: Users should have exported other data like category, attribute, and family prior to this export.

Magento 2 Simple Product Export Job –

It exports only Simple products to Magento 2. Users can map categories accordingly.

Attribute Export to Magento 2 –

It exports attribute and attributes options. It only exports attribute that is mapped in the Setup Attribute Mapping tab.

The selected attribute in custom mapping will only be exported in this export.

This export attribute does not add them to the 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.

Then you should have exported other data like category, attribute, and family prior to this export.

Product Association Export-

It exports the associated product from Akeneo to Magento 2 with cross-sell, up-sell, and related products.

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 an option code.

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

Where did you get the website ID?

When the user adds the credentials of the Magento 2 store where they can find the various website ids as per their store.

Note – If the user will not map the website with the products then all the products will export to all websites. If mapped then it will add only in the selected one.

However, here you will find options in setup properties to apply filters on the product and attributes for export.

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

Please note – It will not override the product in Magento rather it updates the existing data.

If Product SKU Changed At Akeneo Side :

To avoid product duplication, delete Magento2 products if the Akeneo Product SKU changes.

To export the categories associated with the channel in the product, enable this option.

Layered in navigation (Is Filterable And Filterable in search):

This feature helps you to export the product attributes which are filterable & filterable in search in the layered navigation at the Magento store.

Delete existing attachment – 

If it is enabled then the same attachments of a product will export to the Magento 2 end and also it will delete other added attachments from Magento 2 end.

If it is disabled then both attachments will be present on the Magento end exported one and which is created on Magento 2.

Remove Akeneo Deleted Association From Magento-

If it is enabled then it will delete the association products from Magento if that is deleted from Akeneo.

Export the categories associated with the channel

If this is enabled then it will only export the associated categories with the channel.

After that, you need to decide which products to export on Magento.

Family

After that select one or more product families to export to Magento. If you want to export products belonging to specific families.

Then click on the drop-down list and click on the families to add in the field like clothing, shoes, and t-shirts.

Status

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

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

Completeness

This enables you to filter on the 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

After that, you can now export your product in a specific 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 values.
• No date condition (default option) – Products are not filtered using time conditions.
• 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

Then 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.

Selection of Identifier

Then you can make a selection of identifiers to export by adding them to the SKU field. You can copy and paste a list of identifiers, and separate them by using commas, space, or line breaks. After that click on the Save, the button then follows the next step to execute this profile.

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

After that, 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 and upload the app folder to your Magento2 installation directory. Then you will find the app folder in our latest version of the connector.

Then you will find the app folder in the 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;

Now 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 faster product export.

Then click on the Save button, and you can see the export job profile created by you.

Here user can enable/disable the toggle buttons for quick responses.

• Disable Automatic Remote CSV Upload: When it’s disabled then the user cant upload the CSV to export the data.
• Download Generated CSV Files: When it’s enabled then the user will get the option to download the auto-generated CSV file.
• Delete Existing Attachments: When it’s enabled then all the existing attachments will delete from the Akeneo end.

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 Disable Automatic Remote CSV Upload icon.

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

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

Execution Process

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

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

Product Information Update

After that, 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 the 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.

Exported Akeneo Products on Magento Storefront

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