Considering the convenience of managing the product information using Akeneo, Webkul has introduced Shopware Akeneo Connector.
However, with this Connector, you can connect your Shopware store with the Akeneo PIM software. Thus, you can manage thousands of products easily. Consequently, you can push data from Akeneo into the Shopware Easily.
Undoubtedly, the module works with simple and configurable types of products. Also, the connector exports the categories, products, product models, product images, properties, attribute groups and attribute options.
You must be using Shopware 5.x.
You must enable the REST API under Shopware > Configuration > User Administration.
Also, the 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 and 5.0.x.
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.
3 – Run this command after ssh to your akeneo server by the terminal
php bin/console shopware:setup:install
Common Issues After Installation
It might happen that even after proper installation, upon opening your Akeneo admin dashboard, you see a loading screen. While in that case, do check for the following solution:
Webpack Installation: If you get the below error.
It means that a web pack is not installed in your system. Run the following command.
npm install --save-prod webpack
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 installing the module in Akeneo, you need to set up the Shopware API keys in Akeneo. Therefore, log into Akeneo then navigate to Shopware Connector>Setup Credentials you need to enter your website URL, then enter the Shopware API Integration Tokens as created.
In this, you can add different CustomerGroup accordingly you can set there price and currency.
In the Locale Mapping section, you can add locales for your Shopware store.
Quick Export Currency Mapping:
Note-Quick export is used for the purchase price attribute. It will be exported as the purchase price value
After setting up the Shopware API keys in Akeneo, Therefor you need to map the product fields between Shopware and Akeneo as per the below image.
In some of the attributes like description, description long, keywords and title you can select multiple attribute. In this you can select all type of attributes like text, text area, metric etc
Map More Standard Attribute:
If your products have lots of information, you can enter the Shopware attribute code ID then click Add Field. The Shopware Akeneo Connector module supports various attributes of Shopware products. Please make sure to use the same attribute code of Shopware in Akeneo.
You can also add free text feilds enter the Shopware attribute code ID then click Add Field. In this you can select multiple attribute.
Attributes to be used as Images – The selected Akeneo image attributes will be visible as Shopware product gallery images.
Attribute to be used as Properties Values(For Export) – The selected Akeneo properties value(color, material, brand, etc) will be exported to Shopware from Akeneo.
In Cross-Selling mapping, the product may be associated with none or several other products or product groups. In this, you can add a product which is similar in price, brand and other features.
If you want to do a cross-selling mapping there are two types of cross-selling in this Similar item and Accessory item.
In which you can map this Association Product like-
Cross-sell products – Cross-selling of the product involves the product of the same kind.
Upsell Products – Upsell products typically involve trading up to a better version of what’s being purchased.
Substitution – Substitution products are similar in the category and types. It provides you with a vast number of options in addition to the main product.
Frontend view :
In this, you can map the Link attribute in which the link of the different stores or pages related to the product will be visible on the product page which is exported from Akeneo to Shopware.
File attribute in this you can map the file type attribute like jpeg, jpg, png, and PDF which will be exported from Akeneo to Shopware and then you can download the file from the Shopware store.
Link on frontend :
In other settings, you can Enable API Request Logs and Enable API Response Log in you can check all the export/import processing. If there is any error or issue in the export/import process that will be visible.
Select Attribute Option Code/Lable – In this, you have to select the attribute option which admin wants to export as code or label.
If either of the price or the pseudo price is empty, then both export the same price enable this you can export either price or pseudo price.
Export attribute label with values: This setting only applicable when exporting multiple attribute in single attribute
You need to activate the credentials to export the products from Akeneo to Shopware. The active credential will be visible at the time of creating an export profile.
You can also enable the option to Quick Export the products from the Akeneo product grid.
Default for QuickExport
Attribute Group Export Job
Create an attribute export profile to export the attribute to Shopware. First, go to Exports> Create Export Profile, then enter a unique code, label and select a job profile(Attribute Export). Then click to save.
Then run the job and the attribute will be exported to Shopware.
Attribute Option Export Job
Create an attribute option export profile to export the attribute to Shopware. First, go to Exports> Create Export Profile, then enter a unique code, label and select a job profile(Option Export). Then click to save.
Then run the job and the attribute option will be exported to Shopware.
Family Export Job
Create a family export profile to export the attribute to Shopware. First, go to Exports> Create Export Profile, then enter a unique code, label and select a job profile(Family Export). Then click to save.
Then run the job and the family will be exported to Shopware.
Attribute group, Attribute option and Family at Shopware click to Item>>Properties.
Category Export Job
Create a category export profile to export the category to Shopware. First, go to Exports> Create Export Profile, then enter a unique code, label and select a job profile(Shopware Category Export). Then click to save.
After creating the profile run the job and then the category will be exported to Shopware.
Create Simple Product In Akeneo:
You can also create a product in Akeneo. Therefore, navigate to Products. Then click the Create button.
Now, you need to choose your action – as Product or Product Model as per the below image. You can select-
Product – if you want to create simple products.
Enter the SKU, choose a family, then click the Save button as per the below image.
Product Family – This 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 to.
Add Product Details
Now you need to provide information about the product.
Enter the details like name, color, and upload the product image.
For adding product information, select the attribute options you require. Therefore, you can also create new options for the attribute.
Following Attributes from Akeneo are supported for export:
You can also add a product description, visibility, and name.
You can also add additional information such as product SKU, weight, and price.
Click the upload picture section or use the drag and drop feature to add a product image.
Please note all the image attributes present in an Akeneo product are added as Product Media gallery images in Shopware.
Add information for other languages and store views.
After entering all the product information. Then you can also select Categories for the created product.
Resource Download Media Export Job
Create a Resource download media export profile to export the media to Shopware. First, go to Exports> Create Export Profile, then enter a unique code, label and select a job profile(Resource Download Media Export). Then click to save.
After creating the profile run the job and then the media will be exported to Shopware.
Shopware Export Job:
To export the products, first of all, you need to create the Export Profile. Therefore, navigate to Exports -> Create Export Profile as per the below image.
This will redirect you to the Export Profile page. Therefore, you will enter a unique code, label and select a job profile.
In the Job field, you need to select the Shopware Product Export Job.
Then click Save.
Filter The Data
You can export the filtered data. Therefore, navigate to the Content section as per the below image.
You can filter the data as per-
Channel – This selects the relevant channel of products to export.
Locales – Depending as per your choice multiple locals can be selected.
Attributes – select the product attributes which you want to export. You can either select all attributes else click the edit button to select the attributes.
You will be navigated to the “Attribute” page when clicking the edit button as per the below image.
Here, click on the left side to select a specific attribute group. Then select the displayed attributes as per the choice.
Filter The Products.
Akeneo enables you to decide which products to export on Shopware.
Select one or more product families to export to Shopware. If you want to export products belonging to specific families, click on the drop-down list then click on the families to add in the field like clothing, shoes, t-shirts
You can now export your product on a specific time condition.
No date condition (default option) – Products are not filtered using time conditions.
Updated products over the last n days (e.g. 6) – This 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.
Products updated since last export –The products that were updated during the last update will be filtered.
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, then click the Edit button the categories of the channel tree are displayed.
You can select product identifiers to export the product. Therefore, you can select multiple product identifiers that should be separated by comma, space or line breaks.
You have to select a credential in which the product will be exported.
You can select credentials here.
After that click the Save button.
After creating the export profile, click on the Export Now button as per the below image.
After the execution of the export process, you can check the process summary and errors if present.
After the completion of the export process, you can check the products in the Shopware catalog. The admin can view the products so if there will be any changes in the product edit form of Shopware as per the below image.
Exported Akeneo products will appear on the storefront as per the image.
Creating Variant Product in akeneo:
You can also create a variant product in Akeneo, for this click to the product option then click to create
Then select the product model.
Product Model – If you want to create a variant product with variations.
Select Product Family:
This is a set of attributes that will be the same for all products belonging to a family in which variants are added.
Enter the code, choose a family, then click the Save button as per the below image.
Add Product Details
Now you need to provide information about the product. Similarly to the simple product.
Then add variant:
Click on the selected variants as per the below image.
Fill the variant and code:
Select the variant which is available and give them some specific code.
Select the variant and then click to the Save.
Then export the product to Shopware.
After the completion of the export process, you can check the products in the Shopware catalog. Hence admin can view the products and make any changes in product edit form of Shopware as per the below image
Add Images in the Variants
In this, you can add images in the variants with all the variants you can add that variant images as shown in the below images.
Quick Export Job
Shopware 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 Shopware. To do that, go to the Products page then a select product from the list then click Quick Export.
Now select the Shopware Export option. After that small slide notification will stating the 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, then you can see the notification message on top.
This was all about the Shopware Akeneo Connector. I hope you must have the got the idea of our module. Thanks for taking the time in reading this blog. And also, please doesn’t forget to share your feedback and suggestions under the comment box given below.