Akeneo attribute code for SKU
You need to tell Adobe Commerce/Magento the product reference attribute code used in Akeneo. This attribute will be used for the e-commerce product SKU.
Connector parameter |
Adobe Commerce information |
Akeneo attribute code for SKU |
Mapping used in Serenity, Growth and V7.0 Akeneo edition. The SKU behavior now looks closer to a normal attribute. If empty, run a fault and stop the product flow. |
Since the version 103.4.0 of the Akeneo Connector, the product SKU attribute code is free. Previously it had to be called "SKU".
With Akeno Serenity, Growth and 7, the product is now identified by an unique identifier called UUID, generated in Akeneo. This UUID is the unique link between the product in the PIM and Adobe Commerce.
"Attribute type" mapping
By default, the Akeneo Connector for Adobe Commerce supports all native PIM attribute types. In addition, you can still map a PIM attribute type and a Adobe Commerce attribute type in the event of a custom attribute type in your PIM.
Do not map native Akeneo attribute types with native Adobe Commerce types, as this mapping will automatically be handled by the Connector. This mapping is only necessary for custom Akeneo attribute types.
In the connector configuration page, in Attributes, you can choose how to convert some specific PIM attribute types to Adobe Commerce attribute types:
| Connector parameter | PIM Information | Adobe Commerce information |
|---|---|---|
| Additional types | PIM attribute type ID | Adobe Commerce attribute type |
For example, you can manage the Flagbit or Webkul table attribute bundles and retrieve the table attribute JSON structure as a Adobe Commerce text area attribute type.
For Webkul table attribute:
| Connector parameter | PIM Information | Adobe Commerce information |
|---|---|---|
| Additional types | pim_catalog_table | Text area |
For Flagbit table attribute:
| Connector parameter | PIM Information | Adobe Commerce information |
|---|---|---|
| Additional types | flagbit_catalog_table | Text area |
"Website" attribute mapping
Since the version 100.2.1 of the Akeneo Connector for Adobe Commerce, you can choose how to associate your products to your websites using a select or multiselect attribute in the connector configuration page, in Products:
| Connector parameter | Adobe Commerce information |
|---|---|
| Website Attribute | PIM "website association" attribute ID (ex: website_association) |
The attribute code given must be a valid Akeneo select or multi select attribute.
The code of its options in Akeneo must match your Adobe Commerce websites codes.
These websites should be mapped to your Akeneo channel(s) on the connector configuration.
You can find your Adobe Commerce websites codes in Store > Configuration.
Before the 101.0.0 version of the Akeneo Connector for Adobe Commerce, do not forget to add all the attributes responsible for the website association to the list of configurable attributes You can find that list under Configuration -> Akeneo Connector -> Products -> Configurable.
Your products will be assigned to the websites selected in the given attribute. If the value for this attribute is empty for a product, the product won't be assigned to any website.
If this configuration is empty, your products will be assigned automatically following your Website Mapping found in Akeneo API Configuration.
The multi select attribute used as the Website Attribute will be empty for products.
Product Type Mapping
Since the 102.1.0 version of the Akeneo Connector for Adobe Commerce, you can map an Akeneo select attribute with Adobe Commerce product types in the connector configuration page, in Products:
| Connector parameter | Adobe Commerce information |
|---|---|
| Akeneo Attribute Code for Product Type Mapping | PIM "Product type" attribute code (ex: product_type) |
The attribute code has to be a valid select attribute in Akeneo.
For now, this attribute can only be used to create virtual products or simple products.
You must configure you attribute option codes matching Adobe Commerce product types as follows:
Simple product: simple
Virtual product: virtual
If a code is not matching a Adobe Commerce product or is empty, the product will be created as a simple product.
You don't need to set Configurable (configurable) or Grouped (grouped) type with this attribute as it is already managed by other features in the connector.
Product Status Mode
Since the 102.2.0 version of the Akeneo Connector for Adobe Commerce, you can choose between multiple product status modes in the connector configuration page, in the Products section:
| Connector parameter | Adobe Commerce information |
|---|---|
| Product Status Mode | Default status, Status based on completeness level or Attribute Mapping |
Default status
Since the 100.4.2 version of the Akeneo Connector for Adobe Commerce (CE & EE), you can choose to enable or disable new products in the connector configuration page, in the Products section.
During product updates, already imported products will keep their old status, unless the product is disabled in Akeneo PIM.
| Connector parameter | Adobe Commerce information |
|---|---|
| Default product status | Yes or No |
If a product is "enabled" in Akeneo PIM, it will be created with the status defined in the configuration.
During updates, his current status won't be modified.
If a product is "disabled" in Akeneo PIM, it will be disabled in Adobe Commerce, regardless of the configuration.
Akeneo PIM "enabled" status is a system attribute value that should not define the activation of a product in Adobe Commerce.
Status based on completeness level
Since the 102.2.0 version of the Akeneo Connector for Adobe Commerce, you can choose the "Status based on completeness level" product status mode in the connector configuration page, in the Products section:
| Connector parameter | Adobe Commerce information |
|---|---|
| Enable Simple Products per website if completeness in channel is equal or greater than | Completeness percent (from 0 to 100) |
When using the "Status based on completeness level" product status mode, you can enable simple products if their completeness level is equal or greater than the number configured.
The completeness will be fetched at each import, and the simple product status will vary on each updates depending on their current completeness level.
Examples:
- Setting the completeness level to 100 will only enable simple products that are 100% complete
- Setting the completeness level to 50 will only enable simple products that have a completenes value of 50% or superior
The product status will be applied per website in Adobe Commerce, so depending on the completeness level of your products, they might be enabled for a website but not for the others
The product completeness for a Channel <> Website mapping will be calculated from every Store View locales available in your Adobe Commerce website
As product models don't have completeness, they can't be enabled or disabled from a completeness level
| Connector parameter | Adobe Commerce information |
|---|---|
| Default Configurable Products Status | Enabled or Disabled |
The behavior of the "Default Configurable Products Status" is the same as the "Default status" mode
Attribute mapping (for status)
Since the 102.5.0 version of the Akeneo Connector for Adobe Commerce, you can choose the "Attribute mapping" product status mode in the connector configuration page, in the Products section:
| Connector parameter | Adobe Commerce information |
|---|---|
| Akeneo Attribute code for Simple product statuses | Akeneo Yes/No attribute code |
| Connector parameter | Adobe Commerce information |
|---|---|
| Akeneo Attribute code for Configurable product statuses | Akeneo Yes/No attribute code |
The Akeneo attribute has to be a global or a scopable Yes/No Attribute. Localizable values won’t be used as a products cannot be disabled at Store View level.
This feature allows you to enable or disable products at the website level in Adobe Commerce.
When choosing this mode, you can map a Yes/No attribute from Akeneo to the "status" attribute in Adobe Commerce, in order to manage product statuses.
This mode allows you to choose up to two different attributes, one for simple products and one for configurable products (product models in Akeneo).
While using the "Attribute mapping" mode, the product statuses will vary after each update, depending on the value of the Yes/No attribute in Akeneo. Yes will enable the product, No will disable the product.
If the attribute code filled does not exist in Akeneo, if the attribute code is not a valid Yes/No attribute, if the attribute value is not found on a product or if the attribute is localizable, the connector will disable correponding products.
Visibility mapping
Since the 103.4.0 version of the Akeneo Connector for Adobe Commerce, you can map an Akeneo select attribute with Adobe Commerce product visibility in the connector configuration page, in Products:
Connector parameter |
Adobe Commerce information |
Enable Visibility Mapping From Akeneo Attribute |
Yes or No |
If this parameter is set to “No”, the default behavior for visibility will be applied: every product will have visibility set to “Catalog, Search”, except child products from product models that will have visibility set to “Not Visible Individually”.
Connector parameter |
Adobe Commerce information |
Default product visibility |
Select between: Not visible individually, Catalog, Search, Catalog & Search |
This parameter allows you to set a default visibility to products if no value is found in Akeneo for the visibility mapping.
Connector parameter |
Adobe Commerce information |
Akeneo Attribute Code For Simple Product Visibility |
Akeneo Attribute Code for the select attribute mapped to simple products visibility |
Connector parameter |
Adobe Commerce information |
Akeneo Attribute Code For Configurable Product Visibility |
Akeneo Attribute Code for the select attribute mapped to configurable products visibility |
Make sure to only map a simple select attribute to the Magento visibility. The select attribute can be non-scopable and non localizable, localizable, scopable or both. The select attribute must have the following options to work properly:
Option Code |
Option Label |
1 |
Not visible individually |
2 |
Catalog |
3 |
Search |
4 |
Catalog Search |
Set the attribute code for "visibility" in lowercase in the configuration for it to work.
Visibility is a default attribute of Adobe Commerce, do not use “visibility” as your attribute label or code in Akeneo to avoid any issues.
"Attribute" mapping
In the connector configuration page, in Products, you can choose how to map a PIM attribute with a Adobe Commerce attribute:
| Connector parameter | PIM Information | Adobe Commerce information |
|---|---|---|
| Attribute mapping | PIM attribute ID | Adobe Commerce attribute ID |
You don't need to map attributes with the same code in Akeneo and Adobe Commerce, the connector will automatically transfer the data without mapping.
This mapping only copies the value from an attribute to another. Make sure to map two attributes of the same type.
Example: My Akeneo description attribute doesn't have the same code than the Adobe Commerce description attribute
If your description attribute in Akeneo is called "description_web", you can map the native Adobe Commerce "description" attribute with your "description_web" attribute from Akeneo as follows:
| Connector parameter | PIM Information | Adobe Commerce information |
|---|---|---|
| Attribute mapping | PIM "description" attribute ID (ex: description_web) | description |
Example: SEO - How to set a product name as a URL?
Set the "Attribute mapping" parameter as follows:
| Connector parameter | PIM Information | Adobe Commerce information |
|---|---|---|
| Attribute mapping | PIM "product name" attribute ID (ex: name) | url_key |
Since the 102.6.0 version of the Akeneo Connector for Adobe Commerce, whenever the url_key of a product changes, the connector will automatically generate a 301 redirect from the old URL to the new URL
Metric Attributes
Since the version 100.3.0 of the Akeneo Connector for Adobe Commerce in the connector configuration page, in Products, you can configure the behavior of your Metric attributes :
| Connector parameter | Akeneo Metric Attribute | Used As Variant | Concat Metric Unit |
|---|---|---|---|
| Metric Attributes | PIM attribute ID | Set to "Yes" if the metric attribute is used as a variant | Set to "Yes" if you want to concat the metric unit to the value imported in Adobe Commerce |
By default, if a Metric attribute is not declared in this configuration, it will be created as a Text attribute in Adobe Commerce. It will contain the numeric metric value. It won't be usable as a variant.
Setting an Akeneo Metric attribute as variant will make this attribute a Select attribute in Adobe Commerce. Options will be dynamically added during product import and will either contain the metric unit or not depending on the value of the "Concat Metric Unit" field.
Setting the Concat Metric Unit option to "Yes" will work for both metric attributes created as Text attribute and Select attribute.
If you already imported a Metric attribute as a Text attribute in Adobe Commerce, you will not be able to configure it as a variant attribute and change its type to Select attribute. To do so, you will have to delete the previously imported attribute and import it again.
Default tax class for a Website
In the connector configuration page, in Products, you can choose the default tax class for a specific Adobe Commerce Website:
| Connector parameter | Adobe Commerce information |
|---|---|
| Default Tax Class | None |
| Taxable Goods | |
| Refund Adjustments | |
| Gift Options | |
| Order Gift Wrapping | |
| Item Gift Wrapping | |
| Printed Gift Card | |
| Reward Points |
Custom tax classes created in Adobe Commerce will automatically appear in this field so you can assign them to your products.
Configurable product attributes and default values
In the connector configuration page, in Products, you can define additional rules for PIM attributes you want to import in the Adobe Commerce configurable products.
| Connector parameter | Attribute | Type | Value |
|---|---|---|---|
| Configurable | Attribute code | Type from the list (see "Types" below) | Value (can be empty) |
Since the version 100.2.6 of the Akeneo Connector for Adobe Commerce, the Type column has been added to this configuration in order to provide better understanding and management of configurable product attributes.
Types:
- (Deprecated since version 101.0.0) Product Model value: Declare each PIM common attributes you want to be imported in the Adobe Commerce configurable products. Leave the value field empty.
- First Variation value: Declare each PIM variation specific attributes you want to be imported in the Adobe Commerce configurable products. The value of the first variation associated to the product model will be inserted in the corresponding Adobe Commerce configurable product attribute. Leave the value field empty.
- Mapping: Declare each PIM common attributes you want to be mapped with another Adobe Commerce attribute. Fill the value field with the corresponding Adobe Commerce attribute. Example: Attribute = name_product_model and Value = name
- SQL Statement: Use a SQL statement in the value field for custom value assignation from Akeneo Connector temporary tables. Example: Attribute = url_key and Value = LOWER(url_key)
- Default value: Fill the value field to assign a constant default value for a given attribute. Example: Attribute = is_new and Value = 0
(Deprecated since version 101.0.0) Example: Product Model value - Declare PIM common attributes to be imported to configurable products
| Connector parameter | Attribute | Type | Value |
|---|---|---|---|
| Configurable | PIM "product name" attribute ID (ex: name) | Product Model value | Empty |
If the "name" attribute is filled in your product model, it will be set to the configurable product.
Before the 101.0.0 version of the Akeneo Connector for Adobe Commerce, if a product model common attribute was not defined in the attribute column, it would not be imported for the configurable product.
Example: First Variation value - Import weight from first variation
| Connector parameter | Attribute | Type | Value |
|---|---|---|---|
| Configurable | PIM "weight" attribute ID (ex: weight) | First Variation value | Empty |
It will import the weight of the first variation associated to your product model in the configurable product in Adobe Commerce
Example: Mapping - Map a product model common attribute to a Adobe Commerce name attribute
| Connector parameter | Attribute | Type | Value |
|---|---|---|---|
| Configurable | PIM "product name" attribute ID (ex: product_model_name) | Mapping | Adobe Commerce "product name" attribute ID (ex: name) |
If a variation specific attribute is already mapped with the Adobe Commerce "name" attribute in the "Attribute mapping" section, both mappings will be applied respectively.
If you map a variation specific attribute and a product model common attribute to the same attribute in Adobe Commerce, please make sure that those two attributes are configured the same way in Akeneo for: Value per channel and Value per locale.
Example: Set default value to a Adobe Commerce configurable product attribute - Disable all configurable products
Use the value column to force the value for all configurable products for a specific attribute.
| Connector parameter | Attribute | Type | Value |
|---|---|---|---|
| Configurable | is_new | Default value | 0 |
Example: SQL statement to manipulate configurable product attribute value
You can set an SQL statement in the value column to manipulate a Adobe Commerce configurable product attribute value from the connector import tables. The alias for product model table is "v." and the one for temporary table is "e."
| Connector parameter | Attribute | Type | Value |
|---|---|---|---|
| Configurable | PIM "weight" attribute ID (ex: weight) | SQL Statement | SQL statement (ex: e.weight/1000) |
Configure Related, Upsell and Cross-sell products
Since the 101.2.0 version of the Akeneo Connector for Adobe Commerce, you can configure the code of the associations to map with Related, Upsell and Cross-sell products in Products:
| Connector parameter | PIM information |
|---|---|
| Akeneo association code for Related products | Association code from Akeneo |
The default value for this configuration is: SUBSTITUTION
| Connector parameter | PIM information |
|---|---|
| Akeneo association code for Upsell products | Association code from Akeneo |
The default value for this configuration is: UPSELL
| Connector parameter | PIM information |
|---|---|
| Akeneo association code for Cross-sell products | Association code from Akeneo |
The default value for this configuration is: X_SELL
This configuration cannot handle quantity associations, please only use 2-way associations or default associations
To know how to manage association with quantity, please read this documentation.
Product Model Batch Size and Product Model Update Length
These configurations has been removed since the 101.0.0 version of the Akeneo Connector for Adobe Commerce due to the Family by Family import for product models that gathers the data automatically
From the version 100.3.3 to before the 101.0.0 of the Akeneo Connector for Adobe Commerce, you can adjust Product Model Batch Size and Product Model Update Length to prevent database limitations from happening.
In the case of catalogs with a huge number of attributes and product models, some users might have experienced MYSQL errors related to the size of the updates during the Product Model import job. Those configurations allow you to manage the size of Product Model import batches and the size of the MYSQL updates statements.
Product Model Batch Size
Product Model Batch Size will define the number of Product Models inserted / updated during each database update.
Setting this configuration to 1 will import product models one by one and reduce the amount of data sent to MYSQL during each batch.
Setting this configuration to 0 will import product models one by one, reduce the amount of data sent to MYSQL during each batch and slice each database update with the length defined in the Product Model Update Length configuration.
The default value for this configuration is: 500
Product Model Update Length
If the above Product Model Batch Size value is set to 0, the database command to insert product models will be sliced into separate statements no bigger than the given value.
Slicing database updates will also reduce the size of each updates and prevent potential MYSQL limitations regarding row sizes.
The value for this configuration must be superior to 1000.
The default value for this configuration is: 5000
Import file attributes
Since the version 100.4.2 of the Akeneo Connector for Adobe Commerce, you can enable the download of your file attributes from Akeneo PIM to Adobe Commerce.
| Connector parameter | Adobe Commerce information |
|---|---|
| Import File Attributes | Yes or No |
After enabling the file attributes import, you have to choose which attributes you want to download in the "Akeneo File Attributes" configuration :
| Connector parameter | Akeneo Attribute |
|---|---|
| Akeneo File Attributes | Attribute code of the File attribute(s) to download |
All the files will be downloaded in the "pub/media/akeneo_connector/media_files" folder. The Adobe Commerce media_files path will be linked as a text attribute to the corresponding products.
The path of each file will be imported to the corresponding product text attribute in your products.
If "Import File Attributes" is disabled, the connector won't override previously imported values from your file attributes declared in "Akeneo File Attributes"
Does Akeneo data override content staging
Since the version 100.5.2 of the Akeneo Connector for Adobe Commerce (the 100.4.4 version for the Community Edition), you can configure the connector's behavior depending on Adobe Commerce content staging feature , in the connector configuration page, in Products:
| Connector parameter | Adobe Commerce information |
|---|---|
| Does Akeneo data override content staging | Yes or No |
Note that this parameter will only be relevant on Adobe Commerce Enterprise Edition, as the content staging feature is specific to this version.
Adobe Commerce content staging is used to create scheduled versions of products.
If set to Yes, Akeneo PIM data will override all product versions no matter what changes were scheduled. Products will still have scheduled versions in Adobe Commerce, but if an attribute in Akeneo PIM has been modified in the scheduled versions, the value will be overridden by the data imported from Akeneo PIM.
If set to No, Akeneo PIM data will only update the "base" version of the products and not the scheduled versions.
Regenerate URL rewrites
In the connector configuration page, in Products, you can regenerate URL rewrites for Adobe Commerce products:
| Connector parameter | Adobe Commerce information |
|---|---|
| Regenerate URL rewrites | Yes or No |
Since the 102.6.0 version of the Akeneo Connector for Adobe Commerce, if this configuration is set to Yes and whenever the url_key of a product changes, the connector will automatically generate a 301 redirect from the old URL to the new URL