Guide for Akeneo Magento 2 App

The Akeneo Magento 2 App simplifies the synchronization of catalog data between Akeneo PIM and the Magento 2 store.

This integration enhances the product listing data on the Magento 2 store thereby providing accurate and consistent product information.

You can also check the Akeneo Shopify App that allows syncing of data between the Akeneo PIM and the Shopify store.

The Akeneo Icecat App helps to import Icecat catalog content from Icecat to the Akeneo app in turn assisting in setting the perfect content for products.

• Export Categories from Akeneo to Magento 2.
• Export Attributes and Attribute options from Akeneo to Magento 2.
• Export Family from Akeneo to Magento 2 as Attributes set.
• Export Products from Akeneo to Magento 2.
• Export Variations and Attribute values for products from Akeneo to Magento 2.
• Export Product Images.
• Filter data to be Exported based on Category, family, Completeness, Time conditions,
• Identifier(SKU), Language, and Currency for Product Export.
• Added Variant-wise image option, and schedule price option.
• Connect Multiple Magento Instances By providing Credential in Jobs.
• Send Product images in the order they are selected.
• Extra settings: url_key prefix and Fallback name.
• Export extra inventory fields like “Qty_increments” by mapping.
• Export metric attributes with units, setting added in the other settings tab. Value example: values “5 meter” or “5”.
• Export association products (related, cross-sell, upsell).
• Setting to export only newly created data(attributes/category/option/family).
• Images ALT Text export mapping.
• Assets Export.
• Import Categories from Magento 2 to Akeneo.
• Import Attributes, Attribute Option, and Attribute Group from Magento 2 to Akeneo.
• Import Family from Magento 2 to Akeneo.
• Import Product and Product Model from Magento 2 to Akeneo.
• Import Product Association and Product Model Association.
• Using this app you can export products on Multiple Websites

After you have searched for the Akeneo Magento 2 App in your Akeneo App Store, tap the connect button.

Then after tapping the Connect button, on the page that appears tap the Allow and Next button to proceed further.

Now, agree to the app’s privacy policy and terms and conditions and tap the Allow and Next button.

Thereafter, provide the access permissions to the category trees including – Catgeory, Locale, Attribute Group, and others, and then tap the Next button after that.

Note: The app permissions will only appear in the case of the Akeneo EE edition users.

Now, confirm the access and tap the Confirm button.

Then after the permissions section, the Akeneo Magento 2 App will be connected and on the module page, you can see the notification for a 7-day trial period.

Now, the user can see the Akeno Magento 2 App is connected under the Connected Apps section and to open it tap the Open App button.

Akeneo App Flow Management:

To manage the Akeneo Magento 2 App, tap the Manage App button.

Then, for the flow type you need to select the Other type.

Note: You must select the Data Source flow type in the Growth, Flexibility, and Serenity editions.

After opening the Akeneo Magento 2 App, your trial plan will be activated.

Once trail plan expires, you will be redirect to the plan purchase page as shown below.

After that, the user is redirected to PayPal to make the payment for the plan.

Now, after the successful payment, the user is redirected to the plan page with the activated plan for use.

Moreover, now you can configure the Magento 2 credentials within the Akeneo Magento 2 App.

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

After tapping the Allow button you will get the require API credentials as shown below in the snapshot.

After that, you need to copy the Access Token and then paste it into the Akeneo configuration.

Configuration for Magento >= v2.4.4

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

In the Akeneo backend, navigate to the connected apps section and open the Akeneo Magento 2 App by tapping the Open App button.

This brings up the below section of the Akeneo Magento 2 App. Here, navigate through Magento2->Credentials.

Now, tap the Create Credentials button on the top right-hand corner.

Note: You can add only the allowed number of Magento 2 accounts in the app depending upon your purchased plan.

Now enter the Magento 2 store URL and the access token and then tap the Save button to save the Magento 2 account.

Store View Mapping: Manage Multiple View

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

After that, if you are managing your Magento 2 store in multiple views, you need to map them to the correct Locale in Akeneo.

Select the Magento 2 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 Attribute Mapping section, the admin has to match the product fields between Magento 2 and Akeneo.

Then you need to select the correct Akeneo attribute that matches the Magento 2 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 2:

• 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 Magento 2.

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

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

Map More Standard Attributes

If your products have lots of information, you can enter Magento 2 attribute code ID and click Add Field.

Akeneo Magento 2 App module supports various attributes of Magento products. Please make sure to use the same attribute code as Magento 2 in Akeneo.

Other Mappings

Attributes to be used as Custom Attributes(For Export) – When you are going to export the product in Magento 2. The selected attributes will be visible as custom attributes in Magento 2.

Attributes to be used as Custom Metric Attributes –The selected attributes will be visible as custom metric attributes in Magento 2.

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

Attributes to be used as Images – The selected Akeneo image attributes will be visible as Magento 2 product gallery images.

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.

Attributes to be used as Asset – In this you need to map the attributes that we will use as assets while exporting the product.

Note: Assest supports only in Akeneo EE edition and it support image types.

Video Attribute Mapping – you can map video URLs and preview images along with all product information that can also export video URLs and preview images from Akeneo to Magento 2.

Image Role Mapping(For Simple and Product Model) – After that, you have to map the images that you want to export as the base, small, and thumbnail images of the product.

Image Role Mapping(For Variant Product) – After that, you have to map the images that you want to export as the base, small, and thumbnail images of the product.

In association mapping, the product may be associated with none or several other products or product groups.

After that, if you want to do an association mapping you can map the product association fields in Magento 2 to Akeneo.

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

Attribute Group Export

Here you can select how product attributes should be exported from Akeneo to Magento 2. There are two options:-

• Export all attributes in a Single predefined Attribute Group (fast) – In this all the attributes are exported in a single group
• Export all Attribute groups (slower) – In this all the attributes are exported along with their attribute groups.

URL key prefix for product models – In cases, where a URL key of a product or category is conflicting with each other (Due to no url_key mapping of categories). You can add a prefix for the url_key of products.

Export unit with value of metric attributes – You can export the product with metric attributes excluding weight. You can also export the product unit with it.

Export metric type attributes as select type – If you are exporting metric type product module then you need to enable this option.

Fallback name field when a mapped field is not present (Optional) – If the product mapped field is not present then the fallback name will be used as the name.

Select the attribute option code/label for the admin column – In this selection, you want to export the attribute code or label.

Other Magento 2 Modules Support –

Support Webkul Attachment export(Only for module link) – Only two types of attributes can be attached to the product – image and file. Also, the product and product model value will be exported in attachments.

Attributes to be used as Attachments – Choose the attributes to be used as attachments as required.

Note: Before product export from Akeneo to Magento 2, the category attributes, attribute options, and families should be exported.

Then to export your product data, you need to create a job profile. First, go to Exports->Create Export Profile.

After that, enter a unique code, and label then choose the respective export job for the profile to create.

Here, you can choose one export job from the available list.

Here, you can create the export job for –

Magento 2 Export Job –

Based on job criteria, it exports everything (categories, attributes, attribute options, attribute group families, and products).

To be included in an export job, a product must have a category.

Product Only Export to Magento 2 –

It exports products to Magento 2. It also allows you to add categories, attributes, families, and variations to your product.

Before this export, you should have exported other data, such as category, attribute, and family.

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

Users can map attributes such as url_key in the Attribute Mapping tab. When a product’s url_key contradicts with that of a category, mapping url_key comes in useful.

In other product export jobs, only the product and the media are exported, whereas Product Only Export to Magento 2, the media, attachment and the added association in the product are exported.

Category Export to Magento 2 –

All categories from the default Magento 2 tree will be exported. You can select the child categories that are active on multiple channels.

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), as well as the attribute groups, and adds already exported attributes to the family.

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 –

This job allows you to export 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 –

You can only export Simple products to Magento 2 with this job. Categories need to be mapped 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.

Product Association Export-

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

Export Products on Multiple Websites

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.

Credentials for Multi-Store

If you have multiple stores in Magento 2, you can enter the store credentials here by going to the Credential section for the created export job.

Note: Depending upon your plan, only the allow number of Magento 2 stores can be add, the same will be visible for selection(the Magento 2 store you have add).

After saving the export profile, go to the Content section and filter the data options for the products to export by choosing the scope, locales, and other options.

Here, for the products to export you can also choose the below options –

• Not export Categories value in product Export – If enable, product categories will not be export.
• Delete category from Magento if they were delete on Akeneo – If enable, this option will delete the category from Magento 2 if they delete from Akeneo.

Apart from that, you can filter the products via – Family, status, completeness, time condition, and identifier.

Filter The Products

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 from specific families.

Then, using the drop-down list, select the families to include in the field, such as footwear, clothing, and t-shirts.

Status

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

• All – Export all products whatever their status is
• Enabled (default option) – To only export enabled products
• Disabled – 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 – 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.
• Updated products since this date – To filter the products that were updated during a specific date, select a date.

Selection of Identifier

Then, using the SKU field, you can choose which identifiers to export. A list of identifiers can be copied and pasted, and separated using commas, spaces, or line breaks.

Setup Properties in Job

However, under the setup properties, there are options for applying filters to 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 does not replace the product in Magento; rather, it will export newly updated or newly created product  data.

If Product SKU Changed At Akeneo Side :

If the Akeneo Product SKU changes, delete Magento2 products to avoid duplicating them.

Export the categories associated with the channel in the product:

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.

To execute this profile, click the Save button and proceed with the next steps.

Execution Process

Once you have filtered the products and saved your export job profile, click the Export Now button.

After the completion of the execution process, you can see the number of products exported from Akeneo to Magento 2, and also see the status as completed.

After that, you can see the products are create using the Akeneo Magento 2 App mentioning all the product details.

Then you can edit and update any product information as you like.

The products are visible in the Magento 2 storefront as well.

Note: Before product import from Magento 2 to Akeneo, the category attributes, attribute options, attribute groups, and families should be imported.

To import your product data, you need to create a job profile. First, go to Import->Create Import Profile.

Magento 2 Import -This will import all of the data from Magento. Including all product, categories, attributes, and attribute sets.

Category Import – Using this job, you can import all Magento categories into Akeneo.

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

Attribute Import – This job helps in importing all attributes from Magento 2 to Akeneo.

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

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

Magento 2 Product Model Import -This will import all the product model from Magento.

Magento 2 Association Import -This will import association products from Magento.

After that enter a unique code, and label then select the respective import job.

Here, you will have multiple import jobs that can be created.

Credentials for Multi-Store

If you have multiple stores in Magento 2, you can enter the store credentials here by going to the Credential section for the created export job.

Note: Depending upon your plan, only the allow number of Magento 2 stores can be add, the same will be visible for selection(the Magento 2 store that you have add).

After saving the import profile, go to the Content section and filter the data by selecting Locale and Scope for the imported products.

Apart from that, you can enable the option to import the new products only.

Execution Process

Once you have filtered the products and saved your import job profile, click the Import Now button.

The execution process will start, then you can check each of the steps involved in the import of products from the Magento 2 store into Akeneo.

Then after the completion of the execution process, you can see the number of products imported from Magento 2 to Akeneo, and also see the status as completed.

After that, the products are visible to the admin in Akeneo.

So, that was much about the User Guide of the Akeneo Magento 2 App. For any queries or doubts reach out to us at [email protected]. You can also raise a ticket at our HelpDesk System.