PrestaShop Akeneo Connector module allows you to connect your e-commerce store with Akeneo PIM platform.
Moreover, by using this integration, you can manage your products, categories, attributes, features information from Akeneo.
However, PrestaShop Akeneo Connector will enable you to export, update, then manage your entire product catalog from Akeneo Open Source PIM platform.
Please Note – PrestaShop Akeneo Connector is compatible with Community Edition, Enterprise Edition, and Cloud (PaaS/Flexibility) Edition of Akeneo.
Check out the following video tutorials below:
How to get API keys?
How to do module configuration?
- Create product categories from Akeneo to PrestaShop
- Export/Import product features to PrestaShop
- Export/Import attributes with attribute options to PrestaShop
- Set default currency, locale, and product identifier in module configuration.
- You can Import attribute, attribute option, category, family, family variants, product, and product model.
- Supports the mapping of multiple locales for language translations.
- Map Akeneo attributes with PrestaShop product fields.
- Set any fixed attribute value for all the exported products.
- Add additional PrestaShop product field code for mapping.
- Works with a standard product, the product with combinations, the pack of products, virtual product
- You can export products by Quick export also.
- Export Category with all category trees or you can export with root category.
- Upload multiple images of a product
- Filter products for export based on -category, family, completeness, time conditions.
- Export any specific product(s) using its SKU value in the identifier.
- Select locale and currency for product export jobs.
- You can Export Association Product.
- You can export and create product combinations with metric-type Attributes from Akeneo to PrestaShop.
- Specific export jobs are created for categories, features, attributes, attribute options, products.
- Also compatible with the Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, ,3.0.x, 3.1.x, and 3.2.x.
All above are the important features of PrestaShop Akeneo Connector.
To know how to install PrestaShop Akeneo Connector module in Akeneo, please follow the below steps:
1. First of all unzip the respective extension zip then merge “src” folder into Akeneo project root directory.
2. Goto app/AppKernel.php and add line
in function registerProjectBundles()
3. Goto app/config/routing.yml and add these lines at top of file
4. You have to navigate first to Akeneo installation directory (Ex: cd /opt/bitnami/apps/akeneo/htdocs). After SSH, you have to run the command to your Akeneo server by the terminal.
rm -rf ./var/cache/** && php bin/console pim:install:asset --env=prod && php bin/console assets:install web --symlink && yarn run webpack && php bin/console d:s:u --force
5. You have to restart your web server like Apache, Nginx. Run the command for Apache web server.
sudo service apache2 restart
6. If you are using php-fpm. Then you need to restart the php-fpm services.
sudo service php–fpm7.2 restart
Common Issues After Installation
It might happen that even after proper installation, upon opening your Akeneo admin dashboard, you see a loading screen. In that case, do check for the following solution:
- Webpack Installation: If you get the below error
It means that webpack is not installed in your system. Run the following command12npm install --save-prod webpacknpm install
- 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.
Undefined Offset Error Using Prestashop API
Howeve, if you are using PrestaShop Akeneo connector, it might happen that you will get Offset warning while running the job.
To resolve this problem, you have to navigate classes > webservice > WebserviceOutputJSON to your PrestaShop store directory.
In line no. 41, you have to do some changes.
protected $currentAssociatedEntity= array();
protected $currentAssociatedEntity= ;
Create API Key
For configuring this module, you need to obtain Webservice Account Key from your PrestaShop store.
However, a webservice key allows the third-party tools to access and modify the data.
Adding a new key
Please login to PrestaShop back office and follow Configure>Advanced Parameters>Webservice.
After that, in the Configuration option, select Yes for ‘Enable PrestaShop’s webservice‘.
Then, click ‘Add new webservice key‘ button.
The ‘Add new webservice key’ button takes you to the webservice key creation form:
Key – However, you can either create your own or choose to use a generated one, for instance by clicking the “Generate!” button. Generated keys are most of the time safer because they are harder to guess.
Key description – A reminder of who that key is for, and what it gives access to.
Status – You can disable a key anytime. This enables you to only temporarily grant access to your data from a certain key.
Permissions – You need to choose only View (GET), Modify (PUT), Add (POST) permissions for following resources and click Save.
Moreover, webservice key will be generated, please copy it somewhere, it will be used in next step.
PrestaShop Connector Configuration
After installing the module, you will find the PrestaShop Connector menu option, go to Server Credentials tab then enter the following:
- Server URL (Your store URL address)
- Webservice Account Key
Now, you need to select default locale, currency, and product identifier of your PrestaShop. In the Default Product Identifier, you need to choose how Akeneo product’s SKU will be mapped with PrestaShop products.
Therefore, you can either assign it to Reference or UPC Barcode.
In case you have multiple locales setup on your PrestaShop website and want to manage translations as well, then you need to map the Akeneo Locale with the PrestaShop Locale ID.
Product Field Mapping
In this section, you need to do the mapping of Akeneo product attributes with PrestaShop product fields.
However, while exporting products you send a lot of information about your products such as- SEO, quantity, shipping, pricing, availability, etc. But first, you need to create the attributes in Akeneo according to PrestaShop product field requirements.
The following PrestaShop product fields are available by default for mapping:
- Product Name
- UPC Barcode
- Summary and Description
- SEO – Meta Title and Meta Description
- Quantities – Quantity and Minimum Quantity For Sale
- Pricing – Retail Price (tax excl.), Cost Price (tax excl.), Impact on Price
Product price (tax excl.)
- Shipping Fees – Additional Shipping Costs
- Package Dimension – Height, Depth, Width, Weight, Impact on Weight
- Label When in Stock
- Label When Out of Stock (and backorder allowed),
- Availability date
- Available for Order
- Product Images
Map More Fields
Although there’s a long list of attributes that are sent to the PrestaShop. However, if you still want to export more product information,therefore you need to mention the PrestaShop product field code for mapping.
Map Existing Attributes, Categories, Features of PrestaShop with Akeneo
For avoiding duplication of attributes, categories, and features creation in PrestaShop, therefore you must do the mapping of these existing data with Akeneo first go to Product Field Mapping>Map Attribute/Category.
Click Create Mapping button for creating a new mapping for a category, attribute, or feature.
Select Mapping Type as – Category, Attribute, or Feature. Then, select Akeneo value and PrestaShop value accordingly then click Save.
In association mapping, the product may be associated with none or several other products or product groups.
If you want to do an association mapping you can map the product association fields in PrestaShop to Akeneo. Therefore you can do it for the related products
In the next tab Default Mapping Settings, you need to provide the maximum number of images that can be imported for a particular product.
Make sure to map this setting otherwise no images will be imported.
To create a product in Akeneo, go to navigate to Products then click Create button. Now, you need to choose product type – as Product or Product Model.
Product – Select this type for creating simple and virtual products.
Product Family – A family is a set of attributes that will be the same for all products belonging to a family.
Therefore product family represents product type, imposes product information structure then defines the list of attributes for a product that it belongs to.
Create Product in Akeneo
A standard product is a basic product having no option or combinations. To create a product, go to Products>Create>Product then enter an SKU then select a Family.
Moreover ,please make sure, while selecting the family you must select the correct family consisting of all the required product fields for PrestaShop.
Add Product Details
After that, you need to provide product information according to the PrestaShop requirements. Then enter basic product details such as product name, description, SKU, price, etc.
While adding 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 Area
- Reference data select
- Reference data multi-select
Mention shipping and packaging information.
Provide SEO information with your product like mention Meta title and Meta description.
Add New Attribute Option
If an attribute option is missing for a select attribute type (simple or multi-select),
Moreover, you can directly add it to the Product Edit Form then Enter a Code and Label values, then click Save.
Upload multiple images of a product before that make sure you have mentioned the image attributes code in module configuration.
You can select here the locale for sending the product information in multi-language.
Once you have entered all the product information, then you need to select a category for this new product.
Therefore, you can also select more than one category for a product.
In this module you will find the following types of export jobs for exporting catalog information to PrestaShop:
All Export –
- Prestashop Export All
Attribute Export –
- Prestashop Export Attribute
- Prestashop Export Attribute Option
Category Export –
- Prestashop Export Category
Product Export –
- Prestashop Export Product
- Prestashop Export Product Model
In this job, first of all the attributes, attribute options, categories, products, product models are exported to PrestaShop.
Hence, you can use various filters for exporting only specific products to PrestaShop. If you have newly setup your PrestaShop from scratch, please use this export job.
To create a new export job profile, go to Exports>Create Export Profile and enter a code, label, and select job type.
In Webkul PrestaShop Connector menu, you will find all the 6 types of jobs for exporting likewise:
- Export All
- Attribute option
- Product Model
Please note product features are exported using attributes and attribute options job profiles.
You can export categories, go to Exports>Create Export Profile then enter a code, label, and select job type as Webkul PrestaShop Connector>Export.
Fill details and then click Save button.
All Category Tree Export:- In this all the category tree will be exported when you will enable the all category tree export.
Export With Root Category:-In this child category will be exported with root category when you will enable the Export with root category.
Then, click Export button.
The execution process will run, you can see the progress and error messages here.
Export Attributes & Features
For exporting attributes, go to Exports>Create Export Profile and enter a code, label, and select job type as Webkul PrestaShop Connector>Export Attribute.
Click Save then again click Save, after that Export Now button will be visible then wait for the execution process to get completed.
All the Akeneo attributes such as text, text area, price, date, number, & non-select type attributes will be seen under Features.
Export Attribute Options
For exporting attribute options, go to Exports>Create Export Profile then enter a code, label, then select job type as Webkul PrestaShop Connector>Export Attribute Option.
Click Save then again click Save, after that Export Now button will be visible. Then wait for the execution process to get completed.
Attribute options exported in PrestaShop.
Now for exporting your products, you need to go to Exports>Create Export Profile and enter a code, label, then select job type as Webkul PrestaShop Connector>Export Product.
Click Save then go to the Content section and select your channel & locales.
You can use various filters for deciding which products to export. Therefore you can even export some specific products using their SKU values use commas for more than one SKUs.
Click Save to apply your changes then click Export Now button then wait for the product execution job to get completed.
You can make whatever changes you want to do according to your requirements simply editing a product.
Check all the information is correctly mapped or not then all the non-selectable Akeneo attributes will become features in PrestaShop.
In quantities, you can see the quantity level, min. quantity for sale, labels, and availability date.
Shipping and packaging information are also fetched from Akeneo.
In pricing tab, you can see the retail price and cost price information.
In the product details tab, all the features are visible to the customers.
Prestashop Akeneo Connector has an amazing feature, where you can quickly create or export product(s) without going through all the job creation process.
In conclusion, the Quick Export feature allows you to quickly export a product to Prestashop. To do that, go to the Products page and select product from the list then click Quick Export.
Now select Prestashop Export (All Attributes) option. After that small slide notification will stating 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, you can see the notification message on top.
In the new version 1.1.1, the Import Job feature has been added to Prestashop Akeneo Connector. Now you can directly import products, categories, attributes and family variants from PrestaShop.
While importing new products, you need to re-visit Product Field Mapping.
After that you have to map Akeneo attributes with those of PrestaShop fields in which the product will be imported.
In the next tab Default Mapping Settings, you need to provide the maximum number of images. Therefore, that can be imported for a particular product.
Make sure to map this setting otherwise no images will be imported.
On the Product Field mapping has been done, go to Imports>Create Import Profile.
Import All –
Prestashop Import All -You can import everything from Prestashop like products, categories, attributes, and family.
Prestashop Import Family and Family variants – This will import family of Prestashop into Akeneo and all the family variant into that family.
Prestashop Import Product and Product Model – This will import all the simple and configurable products of Prestashop.
Prestashop Import Category – This will import all the Prestashop categories to Akeneo.
Prestashop Import Attribute and Attribute Options – This will import all the attributes and atrribute options from Prestashop to Akeneo.
Now, go to Content and select the appropriate channel, locale and currency for importing PrestaShop products to Akeneo.
After that, click Import Now button to execute the import process.
Thank you for reading this documentation. In case you find anything missing or not explained correctly, or you have any customization need.
Please feel free to send a mail to firstname.lastname@example.org
Current Product Version - 1.2.0
Supported Framework Version - PrestaShop 1.6.x.x, 1.7.x.x || Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x and 3.2.x