Reading list Switch to dark mode

    Shopware 6 Akeneo Bulk Synchronization

    Updated 15 December 2023

    Introduction

    The purpose of this blog is to discuss Shopware 6 Akeneo Bulk Synchronization in detail.

    This module allows admins to export bulk data from Akeneo to Shopware 6.

    Therefore, the Shopware 6 bulk synchronization module helps the admin to manage thousands of product data easily and export products within a few hours.

    Note

    1. This module is an add-on for the Shopware 6 Akeneo Connector. In order to use this module you must install the Shopware 6 Akeneo connector.
    2. Additionally, this module supports Shopware 6 Tier Pricing Akeneo Extension. If you install this module, you can also export tier pricing.
    3. Before running the Shopware 6 Bulk synchronization job, you have to export categories, attributes, and attribute options via the default module.
    4. Plugin updation: If you are using Showare version 6.5.x.x the plugin version 2.0.0

    Basic Requirements

    • You must be using Shopware 6.3.x and 6.4.x
    • This module works with Akeneo 4. x.x,5. x.x,6.x.x and 7.x.x Download Akeneo from here.
    • This module is compatible with the Akeneo PIM Community edition, Enterprise edition, and Growth edition.
    • For the Akeneo installation, your Akeneo server should meet these system requirements.

    Features

    • Export bulk products from Akeneo to Shopware 6.
    • Export Bulk Product Model from Akeneo to Shopware 6.
    • Credentials must be selected on the basis of the Shopware version.
    • With the help of UI, users can select the product listings of variants.
    • Export Bulk Tags from Akeneo to Shopware 6.
    • Single operation filter and indexing behaviour.
    • Inventory update for new and existing products.

    Installation Process

    Two different types of module installation processes are available in the module.

    1. Composer Installation
    2. Manual installation.

    Read This Blog Before starting the installation via composer.

    Searching for an experienced
    Akeneo Company ?
    Find out More

    Composer Installation

    1. Get the ACCESS KEYS [ Raise a Ticket

    For Akeneo 6.0.x and 7.0.x

    2. Add our repository and installation script in your Akeneo composer.json

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

    3. Install the extension Using Composer.

    composer require webkul/shopware6bulkapibundle

    For Akeneo 5.0.x

    2. Add our repository as well as the installation script in your Akeneo composer.json

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

    3. Install the extension using Composer.

    composer require webkul/shopware6bulkapibundle:1.1.0

    4. Fill up the Authentication.

    5. Send a Message of Success.

    6. Clear Browser Cache.

    Please follow these steps for installing the Shcopware 6 Bulk API Akeneo connector module in your AKeneo PIM platform.

    Manual Installation for Akeneo Version 6.x and 7.x

    1. Unzip the respective extension zip and then merge “src” folder into the akeneo project.
    2. Run the below command over the NO-DOCKER Instance from the PIM directory.
    ./src/Webkul/Shopware6BulkApiBundle/install/config.sh COMPOSER=false NO_DOCKER=true

    3. Run the below command over the docker Instance from the PIM directory

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

    Manual Installation for Akeneo Version 4.x and 5. x

    1. Extract the appropriate extension zip file and paste the “src” folder into the root of your Akeneo directory.

    2. Now go to Config/Bundles.PHP and add the line:

    Webkul\Shopware6BulkApiBundle\Shopware6BulkApiBundle::class => ['all' => true],

    3. Run this Command after SSH to your Akeeno Server by the terminal.

    php bin/console shopware6bulk:setup:install

    Uninstallation for Akeneo 6.0.x and 7.0.x

    Run the below command over the NO-DOCKER Instance from the PIM directory.

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

    Run the below command over the docker instance from the PIM directory.

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

    Functional Process & Workflow

    Before working on the functional process, please have a look at Shopware 6 Akeneo connector.

    After installation, you need to add a plugin to your shopware 6 instances to export the images from Akeneo to Shopware 6.

    Plugin Installation

    1. For the plugin installation, you have to go to the Shopware6 backend and then navigate to Extension>My Extensions.
    shopware27

    2. To install the plugin user can click on the upload Plugin button. Now The user can Upload the Plugin Zip.

    shop2

    3. Once you upload the plugin zip, therefore you can see the plugin in the list.

    shopware28

    4. Now the user can click on the installation icon to install the Shopware 6 Akeneo connector.

    5. After the installation of the plugin, the user can click on the activated plugin.

    Extension-3

    Track Shopware 6 Bulk Synchronization module

    You can track this module once you work on the Job Profile Section. To view this module export job you have to navigate Export > Create Export Profile > Job

    A127

    Set up credentials in Akeneo

    After installing the module in Akeneo, you need to set up the Shopware 6 keys in Akeneo.

    Shopware-6-Akeneo-Connector-dfssdf-10

    Now Login to Akeneo then navigate to Shopware 6 Connector > SetUp Credentials

    C127

    Now need to fill in some details once we create Credentials.

    1. URL
    2. Access Key ID
    3. Secret Access Key
    4. shopware Version
    akeneo27

    Once you fill up all the details. Click on to save button.

    D127

    Now In the locale mapping section, we can add locales from your Shopware 6.

    Attribute mapping

    After you’ve configured the Shopware6 API keys in Akeneo, you’ll need to map the product fields between Shopware6 and Akeneo. For mapping, Section go through with Shopware 6 Akeneo Connector.

    E127

    Create products in Akeneo

    To create products in Akeneo, first, navigate to products and then click the create button.

    then you will find the option to choose the product type –

    F127

    Product– To create the Simple Product we need to select the product option then choose SKU and family for the product and then Save it.

    g128

    Add Products Details

    Now provide the information about the product and enter the details like color, size, name, and brand and upload the product.

    H127

    Supported Attribute Type

    To create the new product we need to select the attribute option.

    The following attributes from Akeneo are supported to export –

    • Text
    • Text – Area
    • Number
    • Date
    • Yes / NO
    • Select
    • Price
    • Image
    • Measurement

    Multi-locale Information

    Once you are done with attributes, then it will redirect you to a new option (add information) for other languages and store views.

    I127

    Select Categories

    After entering all the product information. Now you can also select categories for the created product.

    J127

    Creating Variants Product in Akeneo

    For the Create Varients types of product, you can check the Shopware 6 Akeneo connector

    Shopware 6 Bulk Synchronization functional flow –

    Important Note – Before exporting the Shopware 6 Bulk Synchronization job, we have to export attributes, attribute options, and Categories.

    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.

    This module is basically supported 5 export Jobs –

    • Bulk Products Export to Shopware 6.
    • Bulk Product Model Export to Shopware 6
    • Product Model stock only bulk export to Shopware 6
    • Product Stock only Bulk Export to Shopware 6
    • Tags Bulk Export to Shopware 6.

    First, export all the tags from Akeneo.

    Export Bulk Tags

    Before exporting all the bulk jobs, you have to export bulk tags.

    To export the tags in bulk, you need to create an export profile for the bulk tags.

    Tag-bulk-Export

    Once you create this profile then you can choose the filter according to your requirement.

    Tag-Properties-Credential-Select-
    Tag-Content-Filetr

    Now in the Tag Bulk export Job, we will export all the Product model Tags and Product Tags.

    akeneo28

    Shopware 6 Tag Bulk section –

    For the Shopware Tag section, you can Navigate to Settings> Tag

    Here you can find all the exported Tags.

    Shopware-tag-2

    Once you click on the Tag section, You will find all the exported Tags.

    akeneo29

    Export bulk products

    For exporting the bulk product in Akneo, we have to go to the export Section and create an export profile for the bulk product.

    Product-Bulk-export

    Once you create the bulk product Export Profile then you choose the filter option according to your requirement and filter the data.

    Here you find a properties option. In this option, you can select the credentials.

    Product-Bulk-Properties

    Essentially we have two add-ons of processes to filter the data via this module.

    1. Single Operation
    2. Indexing Behaviour

    Single Operation

    Single Transaction – Data will be written in a single transaction.

    Separate Transaction – Data will be written in separate transactions.

    akeneo30

    Indexing Behaviour –

    When using the Sync API, by default each record is written individually. In addition, various indexing processes are also triggered in the background, depending on which data was written.

    However, this leads to a high load on the server and can be a problem with large imports. Therefore, it is possible that all data is written in a single transaction and the indexing is moved to an asynchronous process in the background.

    akeneo-31

    You can control the behaviour using the following headers:

    1. Data will be indexed Synchronously.
    2. Data will be indexed asynchronously.
    3. Data indexing is completely disabled.

    Mainly it works in first in and first out Based (FIFO).

    k127

    Inventory update for New Product – If Inventory update for the new product enables then rest of the inventory all the field will be updated.

    Inventory update for the existing product –If inventory update for the existing product is enabled then only inventory will be updated.

    One time you can use only one filter.

    l127

    In the option, you can find Content options where you filter the data with channel, Locales, Currency, Family, And Status wise.

    m127

    Now you click on the Save Option and find the export option to run the job.

    akeneo32

    Once you click on the export Button then you run the Product Bulk export Job.

    With the Bulk Product Job, you can also Export the Product, Product Translation, Product Tier Pricing, Product Association, and Product Association translation

    Process-tracker-Show-job-3

    Product Model Bulk Export –

    To Export the Bulk Product Model First we need to export the Bulk Product model Job.

    n127

    Once you click on the save button then you can choose the Filter same as Bulk Product Export.

    o127

    Once you save these details then you export the product model job.

    During this Bulk Product model Job, you can also Export the Product model, Variants Product, Product and Product Model Translation, Product model Tier Pricing, Product model Association, and product model Association Translations.

    Process-tracker-Show-job-8

    Bulk Product Model Stock

    To export the Product Model Stock option you have to create the export profile for the product Model Srock only Job And Save it.

    Product-Model-Stock-Export

    Once you save it then you can choose the filter and run the export profile.

    Prodcut-model-stock-only-properties

    Once you save it then you have the option to export the Product Model Stock only Option.

    In this section, we just have one job parameter which is Product model Export.

    Process-tracker-Show-job-9

    Product Stock Only Bulk

    We constantly update our inventory using just a single parameter. This makes it easy for us to save time and update our inventory in bulk.

    To export the Product Stock, first, we have to run the export job for the Product stock option.

    Product-Stock-job

    Once you save the option, then you choose the filter option and then save it.

    Product-Stock-job-properties

    Once you save the filter you can now run the export job.

    Via this Section, Now we just have one job parameter which is Product Export.

    Process-tracker-Show-job-10

    Shopware 6 Product View

    Now finally you can see all the export Bulk products in your Shopware Product Catalog.

    shopware29

    Support

    In Conclusion for Any Issue Related to this module, please create a support ticket. You can check other Akeneo Modules. Also, for any pre-sales queries or customization discussions, please drop an email to [email protected].

    Also, Please explore our Akeneo Development Services and Quality Akeneo Extensions.

    At Last, Please explore our Shopware development services and Quality Shopware extensions.

    Current Product Version - Akeneo 4 And 5 ||1.1.0, Akeneo 6 || 2.0.0 and Akeneo 7 || 3.0.1

    Supported Framework Version - 4.0.x ,5.0.x ,6.0.x And 7.0.x

    Blog Version - 4.0.x ,5.0.x ,6.0.x And 7.0.x
    • Version 5.x.x
    • Version 4.x.x and 5.x.x
    • Version 4.0.x ,5.0.x and 6.0.x
    • Version 4.0.x ,5.0.x ,6.0.x And 7.0.x
    . . .

    Leave a Comment

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


    Be the first to comment.

    Back to Top

    Message Sent!

    If you have more details or questions, you can reply to the received confirmation email.

    Back to Home

    Table of Content