Description
The Akeneo Shopware Connector by HDNET
Functions
The Connector is a command line tool for exporting your catalog and product data from Akeneo to Shopware. The connector can export the following data:
- Categories
- Families
- Attributes
- Products
- Product models
- Variants
In the one-off configuration, you specify, among other things, which Akeneo Channel your Shopware products are managed with. In addition, you make a one-time mapping in the configuration that you can use to determine which Akeneo attributes should be matched to which Shopware article master data.
Once you have configured the settings, you can execute the following export commands in the command line tool:
./connector.phar categories./connector.phar families./connector.phar products
Additionally, you can configure these commands as cronjobs on your server so that the export from Akeneo to Shopware is fully automated.
Scope
Since it is not possible for us to represent all specific use cases, this version is to be understood as the basis for the development of a connector between Akeneo and Shopware.
If problems or questions arise during the development, we would be very happy if you contact us directly.
We are happy to assist you with the one-time configuration of the connector.
Visit our website or contact us directly!
Recommended
- Shopware: Version 5.3.* and higher
- Akeneo: Version 2.2 and higher (CE or EE)
- API user for both Shopware and Akeneo
- Basic knowledge of Symfony's ExpressionLanguage (optional)
- Basic knowledge of command line usage
- Possibility to configure cronjobs (optional)
Release notes
General information
The current version of this connector is 1.3.0 (Release date: 25.10.2018). This version provides the most important functions for the enrichment of your Shopware shop.
Currently, it supports one channel and one locale.
The software is consistently being developed according to customer requirements so that further features can be published in the future.
It is compatible with both Community and Enterprise Edition.
Changelog for HDNET Akeneo Shopware Connector
1.3.0
- Log warnings and errors to a log file (AK-89).
- Allow to provide product label using a different attribute than Akeneo's label attribute (AK-82).
- Allow to provide supplier information using an attribute (AK-47).
- Allow to provide tax information using an attribute (AK-29).
- Improve catching duplicate attribute names within a single product (AK-88).
- Split out Shopware PHP API client library (AK-99).
- Add license information (AK-81).
1.2.0
- Automatically import all category properties added by the HDNET Akeneo Shopware Enhancer (https://www.hdnet.de/akeneo-shopware-enhancer) (AK-86).
- Fix importing release dates (AK-87).
- Catch duplicate attribute names within a single product (AK-88).
- Fix attribute mapping examples for packaging properties.
1.1.0
- Improve importing metric, boolean, and simple-select attributes.
- Fix importing variant attributes not on the variation axes.
- Improve image import.
- Fix adding only categories of the configured channel.
- Fix updating categories after attaching shopping worlds (AK-85).
- Improve code robustness.
- Improve documentation.
- Improve test coverage (AK-19)
1.0.1
- Fix updating categories after marking them inactive in Shopware (AK-61).
1.0.0
- Initial release
Installation
Installation of Akeneo Shopware Connector
Preparing Akeneo
If using product models and variants, create a "Text" attribute on the common level that refers to the code of the variant that should be used as the main article in Shopware. The default attribute name is `shopware_main`. If the attribute value is empty, the connector will use the first variant of the product model returned from the Akeneo API as the main product in Shopware.
Preparing Shopware
Either:
- Install and activate the HDNET Akeneo Plugin for Shopware (feel free to contact us).
- If manually installing the plugin, unpack it into custom/plugins and run
bin/console sw:plugin:refresh. - Use Configuration -> Plugin Manager in the Shopware UI to install and activate the plugin, or
- Run
bin/console sw:plugin:install HdnetAkeneoConnector && bin/console sw:plugin:activate HdnetAkeneoConnector.
or:
Create required free text fields with the name `akeneo_code` on:
- categories (table
s_categories_attributes) - item property (table
s_filter_attributes) - property groups (table
s_filter_options_attributes) - property options (table
s_filter_values_attributes)
Optionally you may also add custom free text fields for additional article attributes on:
- item (table
s_articles_attributes)
Configuration
Run the connector once to create the configuration files:
./connector.phar
During the first run, it will create the configuration files `parameters.yaml` and `.env`, so you should run it in an new, empty directory for each of your projects, to avoid accidentally using existing configuration files.
Then edit the entries in parameters.yaml and .env to match your environment.
Test environment
All initial configuration is done!
To test your configuration and product setup, you can now run the following commands in the command line tool:
- Categories:
./connector.phar categories - Families/Property Sets:
./connector.phar families - Attributes and Products:
./connector.phar products
Documentation
Import commands
There are three different commands to use via command line tool to import your product data from Akeneo to Shopware:
- Categories:
./connector.phar categories - Families/Property Sets:
./connector.phar families - Attributes and Products:
./connector.phar products
If you need a list or further information about the commands, simply run:
./connector.phar help