Redeem Now
Read More
Read now
Menu Close
    Start a Project Request quote Reading list Switch to dark mode
    hyperlocal-marketplace-guide
    Blog Version - Akeneo Version: 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x | Shopware Version: v6.3.4.1
    • Version Akeneo Version: 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x | Shopware Version: v6.3.4.1
    • Version Akeneo Version: 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x | Shopware Version: 6.1.x
    • Version 6

    Shopware 6 Akeneo Connector

    Considering the convenience of managing the product information using Akeneo, Webkul has introduced Shopware 6 Akeneo Connector.

    Shopware is a leading Germany based e-commerce platform. Till the date, the platform has received more than 80 thousand users and it is a wondrous e-commerce solution in the DASH region and surrounding territories.

    Shopware is an open-source eCommerce framework. Meanwhile, the features which are taking this Plateform to the prime levels are content management capabilityDrag-Drop design layoutMulti-warehouse systemscalability and performance, and many more.

    Basic Requirement:

    • You must be using Shopware 6.x
    • 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 and 4.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.

    Features

    • Export Categories from Akeneo to Shopware6
    • Export Attributes and attribute options from Akeneo to Shopware6
    • Import Manufacturer, Tax, Sales Channel, Scale Unit, Delivery Time value from Shopware6 to Akeneo
    • Export Products from Akeneo to Shopware6
    • Import Categories, Attribute, Attribute Options, Product, Product Model from Shopware6 to Akeneo
    • Export Product Model from Akeneo to Shopware6
    • Filter data to be Exported based on Category, family, Completeness, Identifier(SKU), Language, and Currency for Product Export.
    • Export 2 level variants product
    • Support for API version v1, v2, and v3
    • Export Dynamic Groups from Akeneo to Shopware6
    • Compatible with Akeneo Category Image and Description
    • Use UI to change the media folder
    • With the help of UI user can select the product listings of variants
    • Shopware 6 Akeneo Connector is compatible with the latest Akeneo version 4.0.x.
    • Export Product Images
    • Export custom attributes value from Akeneo to Shopware6
    • Multi Credentials Configuration using UI.
    • You can export products with quick export.
    • Export Tags from Akeneo to Shopware6
    • Customizable Attribute Mapping with the default value.

    Installing Module for Version 4.0.x:

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

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

    Step 2 – Goto config/Bundles.php then add the line:

    in return array.

    3 – Copy the “config” folder into Akeneo project root directory for routing.

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


    Step 5. If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.

    Installing Module for Version 2.x to 3.x:


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

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

    Step 2 – Goto app/AppKernel.php. Then add a line in function registerProjectBundles()

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

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

    Step 5 – If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.

    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.

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

    Plugin to Export Images

    After installation, you need to add a plugin in your shopware6 instance to export the images from Akeneo to Shopware6

    1 – For that, you have to go to the Shopware6 backend then navigate to Settings>>System>>Plugins.

    2 – For installing the plugin, the user can click on the Upload Plugin button. The user can upload the plugin zip.

    3 – After uploading the plugin zip, after that the user can see the plugin in the list.

    4) Now the user can click on the install icon to install the Shopware 6 Akeneo Connector plugin.

    5) After the installation of the plugin, the user can click to activate the plugin.

    Shopware 6 API Integration:

    The admin can easily generate API keys from the Admin backend. For this, the admin will navigate to Setting>>System>>Integration as per the below image.

    After that click on Add Integration to create new API keys.

    Then after clicking on Add Integration you have fill the API key name.

    Copy the API Key then click to Save Integration.

    Setup Credentials In Akeneo

    After installing the module in Akeneo, you need to set up the Shopware6 API keys in Akeneo. Therefore, log into Akeneo then navigate to Shopware6 Connector>Setup Credentials.

    After that click on create credentials there you need to enter your website URL, then enter the Shopware6 API Integration Tokens as created.

    • Url
    • Access key ID
    • Secret Access Key
    • API Version

    NoteUse v1 and v2 when the Shopware version is less than 6. Use v2 and v3 when the Shopware version is greater than or equal to 6.3.

    Click to Save button.

    Locale Mapping:

    In the Locale Mapping section, you can add locales for your Shopware6 store.

    Attribute Mapping:

    After setting up the Shopware6 API keys in Akeneo, Therefor you need to map the product fields between Shopware6 and Akeneo as per the below image.

    Fields in Akeneo – In this admin can map the value of product and product model.

    Variants fields in Akeneo – In this admin can map the value of product variants.

    Map More Standard Attribute:

    If your products have lots of information, you can enter Shopware6 attribute code ID then click Add Field. The Shopware6 Akeneo Connector module supports various attributes of Shopware6 products.

    Note- Please make sure to use the same attribute code of Shopware6 in Akeneo.

    As well as can also add Shopware Custom attribute code enter the Shopware attribute code ID then click Add Field.

    Other Mapping:

    Attributes to be used as Cover Images – The selected Akeneo image attributes will be used as the cover image of the product.

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

    Family and Attribute to be used as Tags – All Akeneo attribute and family will be exported to Shopware6 from Akeneo.

    Attributes to be used as Images(For variants) – The selected Akeneo image attributes will be used as the variant image of the product.

    Attribute To be used as Properties Values(For Export) – The select type attribute of Akeneo properties value(color, material, brand, etc) will be exported to Shopware6 from Akeneo.

    Display in listing attributes – All select & multi-select type attribute are will be exported to Shopware6 from Akeneo.


    Shopware Backend –

    Import Settings:

    Set Family For Import Products – In this admin can select a family in which all the product from Shopware will be imported in Akeneo.

    Other Setting:

    Mapping for boolean Tags

    In this, you have to select

    • Yes/NO
    • True/False

    Export Metric Unit:

    In this, you can select yes or no to export matric tags unit with metric value or not.

    Media Folder ID:

    In this you need to enter the folder id in which media will be exported in Shopware 6. For that you have to copy the folder Id from Shopware Store in which the media will be exported.

    Shopware Backend –

    Exported Metric Unit.

    Media Folder ID:

    Media from Akeneo will be exported to folder of Shopware store.

    Credentials:

    You need to activate the credentials to export the products from Akeneo to Shopware6. 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

    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.

    After that, enter the details like tax, manufacturer, and upload the product image.


    Select Attribute

    In order to add 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:

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

    Multi-Lingual Information

    Once you will be done with attributes then 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.

    Shopware6 Export Job:

    There are 7 type of export job in Shopware 6 Akeneo Connector –

    • Export All to Shopware
    • Attribute Export to Shopware
    • Attribute Options Export to Shopware
    • Category Export to Shopware
    • Dynamics Group to Shopware
    • Product Export to Shopware
    • Product Model Export to Shopware

    Note For Dynamics Group Export –

    To export Associate products you need to follow this First you need to export the main product and their associate product separately to Shopware from Akeneo once all the products will be exported to Shopware.

    In the second step, you need to run the job Dynamics Group to Shopware so that the products are formed in a group.

    After that in third step export the main product then the product will be exported as associated product from Akeneo to Shopware

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


    Tapping on create an export profile button will redirect you to the Export Profile page. Therefore, you will enter a unique code, the label then select a job profile.

    In the Job field, you need to select the Shopware6 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.
    • Currency – Select the default currency which you want to export.
    • 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.


    After that click the  Save button.

    Note -: Before exporting product fro Akeneo to Shopware you need to export attribute, attribute option, and category.

    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.

    Shopware6 Backend:

    After the completion of the export process, you can check the products in the Shopware6 catalog. The admin can view the products so if there will be any changes in the product edit form of Shopware6 as per the below image.

    Store View:

    Once the product exported from Akeneo 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 then give them some specific code.

    Select the variant then click to the Save.


    Then export the product to Shopware.


    Shopware6 Import Job

    There are 4 type of import job in Shopware 6 Akeneo Connector

    • Attributes And Attribute Options Import
    • Category Import
    • Options Import(tax, manufacture, delivery time, sales, and scale)
    • Product Import

    Now to import to data from Shopware6 to Akeneo. Create the import profile for that you have to navigate to Import>>Create Import Profile.

    After that to create an import profile fill code, label, then select the job.

    Then after creating import profile click to the Import button.

    Note – To export some of the product details like tax, manufacture, delivery time, sales, and scale. You need to first import those attributes so that the attribute id of shopware6 will also be imported to Akeneo. After that, there will be no error while exporting the product.

    After that you can check the import execution details.

    Product Import

    To import product from Shopware to Akeneo you need to create an import profile fill code, label, then select the job.

    Then after creating import profile click to the Import button.

    After that you can check the import execution details.

    Quick Export Job

    Shopware6 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 Shopware6. To do that, go to the Products page then a select product from the list then click Quick Export

    After that select the  Quick Export option. Then that small slide notification will be 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. 

    Support

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

    Current Product Version - 1.4.

    Supported Framework Version - Akeneo Version: 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x | Shopware Version: v6.3.4.1

    . . .

    Leave a Comment

    Your email address will not be published. Required fields are marked*


    2 comments

  • LukaszB
    I think here is an mistake -> “Now to import the attribute from Shopware6 to Akeneo. Create the export profile for that you have to navigate to Import>>Create Import Profile.”
    should be Create the import profile instead of “Create the export profile” right?
    • Adarsh Shukla (Moderator)
      Hello Sir,
      Thanks for letting us know about it. We have updated it. Please let me know if you have further any query. You can mail us at support@webkul.com
  • 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