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
- 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.
- Additionally, this module supports Shopware 6 Tier Pricing Akeneo Extension. If you install this module, you can also export tier pricing.
- Before running the Shopware 6 Bulk synchronization job, you have to export categories, attributes, and attribute options via the default module.
- 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.
- Composer Installation
- Manual installation.
Read This Blog Before starting the installation via composer.
Composer Installation
- 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
- Unzip the respective extension zip and then merge “src” folder into the akeneo project.
- 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
- 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
- For the plugin installation, you have to go to the Shopware6 backend and then navigate to Extension>My Extensions.
2. To install the plugin user can click on the upload Plugin button. Now The user can Upload the Plugin Zip.
3. Once you upload the plugin zip, therefore you can see the plugin in the list.
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.
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
Set up credentials in Akeneo
After installing the module in Akeneo, you need to set up the Shopware 6 keys in Akeneo.
Now Login to Akeneo then navigate to Shopware 6 Connector > SetUp Credentials
Now need to fill in some details once we create Credentials.
- URL
- Access Key ID
- Secret Access Key
- shopware Version
Once you fill up all the details. Click on to save button.
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.
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 –
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.
Add Products Details
Now provide the information about the product and enter the details like color, size, name, and brand and upload the product.
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.
Select Categories
After entering all the product information. Now you can also select categories for the created product.
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.
Once you create this profile then you can choose the filter according to your requirement.
Now in the Tag Bulk export Job, we will export all the Product model Tags and Product Tags.
Shopware 6 Tag Bulk section –
For the Shopware Tag section, you can Navigate to Settings> Tag
Here you can find all the exported Tags.
Once you click on the Tag section, You will find all the exported Tags.
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.
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.
Essentially we have two add-ons of processes to filter the data via this module.
- Single Operation
- Indexing Behaviour
Single Operation
Single Transaction – Data will be written in a single transaction.
Separate Transaction – Data will be written in separate transactions.
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.
You can control the behaviour using the following headers:
- Data will be indexed Synchronously.
- Data will be indexed asynchronously.
- Data indexing is completely disabled.
Mainly it works in first in and first out Based (FIFO).
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.
In the option, you can find Content options where you filter the data with channel, Locales, Currency, Family, And Status wise.
Now you click on the Save Option and find the export option to run the job.
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
Product Model Bulk Export –
To Export the Bulk Product Model First we need to export the Bulk Product model Job.
Once you click on the save button then you can choose the Filter same as Bulk Product Export.
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.
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.
Once you save it then you can choose the filter and run the export profile.
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.
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.
Once you save the option, then you choose the filter option and then save it.
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.
Shopware 6 Product View
Now finally you can see all the export Bulk products in your Shopware Product Catalog.
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
Be the first to comment.