Shopware Akeneo Connector

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, 5.0.x, 6.0.x and 7.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.
• For the Akeneo installation, your Akeneo server should meet these system requirements.

• Plugin(WebkulImprovementsApi) is compatible with Shopware V5.7.x
• Users can set preview image of the product and product model
• Also, the user can export metric complete unit or symbol in the shopware variant configuration
• Export Categories from Akeneo to Shopware.
• Send SEO information with products.
• Export Products from Akeneo to Shopware.
• Filter data to be Exported based on Category, family, Language, and Currency for Product Export.
• Map product attributes between Shopware and Akeneo.

• Export the translation of family(Sets), attribute(All Groups), attribute option(Options)
• Mapping to export the true/false or yes/no as properties options

• The Export specific product(s) using the SKU identifier.
• Provide supplier information using an attribute in the article.
• Select Multiple attributes and export in a single field of Shopware
• Export cross-selling products (Similar items, Accessory items).
• API logs to track the error.

• Export the translation of free text fields
• Export boolean attributes as properties

• Add images in the variants
• UI Mapping to prevent the duplicacy of the category, attribute, properties, and product.
• The export label of variants in the Shopware
• Support multi-language translations.
• Shopware Akeneo Connector is compatible with the latest Akeneo version 7.0.x
• Export Product Model from Akeneo to ShopWare.
• Export Product Images.
• Multi Credentials Configuration using UI.
• Customizable Attribute Mapping with the default value.
• Customer Group Pricing.
• Multishop Locales mapping with the Shopware shops.
• Quick Export
• The source code is fully open for customization.
  

Check out the following video tutorials below:

• How to create credentials:-https://www.youtube.com/watch?v=QLwloXPOHNI
• How to Setup Credentials in Shopware Akeneo Connector:- https://www.youtube.com/watch?v=AB5fk5WgU_M
• How to Create and Export Product from Akeneo to Shopware:- https://www.youtube.com/watch?v=FHPFi_rFFYI

The admin can easily generate API keys from the Admin backend. For this, the admin will navigate to configuration-> User administration as per the below image.

Therefore, navigate to Add user->fill the detail as per the below image.

After entering all the details, the admin will click the “Enable” button. This will generate REST API keys for the selected user as per the below image.

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

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

Step 2 – After that go to app/AppKernel.php. Then add a line in function registerProjectBundles()

new Webkul\ShopWareBundle\ShopWareBundle(),

Step 3 –Goto app/config/routing.yml. Then add these lines at top of the file

shop_ware:
    resource: "@ShopWareBundle/Resources/config/routing.yml"
    prefix:  /

Step 4 –Run this command after ssh to your Akeneo server by the terminal.

php bin/console shopware:setup:install

After you’ve installed the modules, then Go to Shopware  >> Documentation.

After that, you need to set up the Shopware API keys in Akeneo. Therefore, to navigate to Credentials>>Create.

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

• Activated
• Default for QuickExport

Enter your website’s URL, then the Shopware API Integration Tokens as they were created.

• Url
• Username
• API key
  

Price Mapping:

Once you’ve saved the credential in Akeneo, all of your customer groups will be automatically fetched from Shopware, and you’ll be able to configure their pricing and currency in this section.

Locale Mapping:

In the Locale Mapping section, you can add locales for your Shopware store as well as Quick Export Currency Mapping:

Note-Quick export is use 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 attributes. In this, you can select all types of attributes like text, text area, metric, etc

If your products have lots of information, you can enter the Shopware attribute code ID and 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.

Free Text Fields Mapping:

After that, you can also add free-text fields enter the Shopware attribute code ID then clicking Add Field. In this, you can select multiple attributes.

Shopware backend:

Attribute to be used as Preview Image – As a Preview Image, the specified Image attribute is exported.

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

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 that 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 a 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 category and type. 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 :

Logs Settings:

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.

Other Settings:

Select Attribute Option Code/Lable –This setting only applies when exporting many attributes in a single attribute. It will impact the value of the property that the admin wants to export as a code or label.

Select yes/no for boolean attributes – Only the boolean type attribute of Properties Values is impacted by changes (Product or Product Model)

If either of the price or the pseudo price is empty, then both export the same price – If either the price or the pseudo price is empty, they will both export the same price.

You can export either the price or the pseudo price if both are empty.

Export attribute label with values: This setting only applies when exporting multiple attributes in a single attribute.

Export metric unit symbol : This setting only applies when exporting a product model with a variant metric unit.

If this setting is enabled, it will allow you to export a product model variant with a metric unit symbol as well as standard attributes for exporting multiple attributes in a single field.

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.

After that run, the job and the attribute will be exported to Shopware.

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.

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.

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.

Then creating the profile run the job and then the category will be exported to Shopware.

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.

Select Attribute

For adding product information, select the attribute options you require. Therefore, you can also create new options for the attribute.

The following Attributes from Akeneo are supported for export:

• Text
• Text Area
• Number
• Date
• Yes/No
• Select
• Price
• Metric
• Image

You can also add a product description, visibility, and name.

Additional Information:

You can also add additional information such as product SKU, weight, and price.

Upload Image

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.

Multi-Lingual Information

Add information for other languages and store views.

Select Category

After entering all the product information. Then you can also select Categories for the created product.

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.

Note – First, try running the resource media job, and then export the product and product model. Check the product at the shopware end to see if the media file that was added is visible.

After creating the profile run the job and then the media will be exported to Shopware.

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.

Family

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

Time Condition

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.

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, then click the Edit button the categories of the channel tree are displayed.

Identifier

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.

Properties

You have to select a credential in which the product will be exported.

Selecting Credentials:

You can select credentials here.

After that click the  Save button.

Export Now

After creating the export profile, click on the Export Now button as per the below image.

Execution Process

After the execution of the export process, you can check the process summary and errors if present.

Shopware Store

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.

Store View

Exported  Akeneo products will appear on the storefront as per the image.

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:

After that click on the selected variants as per the below image.

Fill in the variant and code:

Then select the variant which is available and give them some specific code.

After that select, the variant then clicks 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 the product edit form of Shopware as per the below image

Store view:

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.

Store view:

Shopware Akeneo Connector has an amazing feature, where you can quickly create or export product(s) without going through all the job creation processes.

The Quick Export feature allows you to quickly export a product to Shopware. To do that, go to the Products page then select a product from the list then click Quick Export.

To do quick export, simply select product(s), go to the Quick Export option, then choose Shopware Export (All Attributes) and as well as other export options.

The execution procedure will begin after you click the Export option, then you will be notified.

After that, 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 don’t forget to share your feedback and suggestions under the comment box given below.

Moreover, If you have any queries or suggestions, then feel free to add a ticket to our HelpDesk system. Please explore our shopware development services and Quality shopware extensions

Please explore our Akeneo Development Services and Quality Akeneo Extensions.