Introduction
Within the connector configuration page, you have the capability to specify which products should be imported into your Adobe Commerce store. It's important to note that the filter configuration applies to all your websites and store views, meaning the Akeneo Connector for Adobe Commerce does not offer the option to configure multiple filters simultaneously based on specific websites or store views.
No matter your filters, for a product to be imported, it must be linked to a category on the channel.
Product filters
Filter on product Channel
Within the connector configuration page, in Akeneo API Configuration, you can specify the PIM channel associated with the website as a first filter. Please read Filtering and mapping channels.
Standard and advanced filter mode
Within the connector configuration page, in Filter products, you can choose between a Standard or an Advanced filter to retrieve your PIM products:
| Connector parameter | Connector default options |
|---|---|
| Mode | "Standard" or "Advanced" |
“STANDARD” MODE
The Standard mode allows you to filter based on:
- the product Completeness (Simple product only)
- the product Status : enabled or disabled (Simple product only)
- the product Updated date : Import only updated products
- the product Family
To have more filter possibilities, you will need to switch to Advancedmode.
Filter on product Completeness
The Product completeness filter is not the same for Products and Product Models.
Products
Filter your PIM products on completeness:
First, select the condition:
| Connector parameter | PIM information |
|---|---|
| Completeness type | No condition |
| Lower than | |
| Lower or equals than | |
| Greater than | |
| Greater or equals than | |
| Equals | |
| Differ | |
| Greater than all locales | |
| Greater or equals than all locales | |
| Lower than all locales | |
| Lower or equals than all locales |
Then, fill the required percentage of completeness:
| Connector parameter | PIM information |
|---|---|
| Completeness value | Percentage of completeness |
| Has to be a value between 0 and 100 |
Product Models
Available since the 101.0.0 version of the Akeneo Connector for Adobe Commerce.
Filter your PIM product models on completeness:
First, select the condition:
| Connector parameter | PIM information |
|---|---|
| Product Model Completeness type | No condition |
| At least one variant complete | |
| At least one variant incomplete | |
| All variant complete | |
| All variant incomplete |
Then, fill the locales on which the completeness filter should be applied:
| Connector parameter | PIM information |
|---|---|
| Product Model Locales | List of locales available on Akeneo PIM |
Filter on product Status
The status filter will only be applied to products, not to product models. This filter is based on the system attribute of Akeneo PIM ENABLE - DISABLE.
You can filter on your PIM products status:
| Connector parameter | PIM information |
|---|---|
| Status | No condition or Enable or Disable |
Filter on product Updated Date
You can import only updated PIM products for the past X hours, for the past X days, between two dates, before a date or after a specific date:
First, select what you need:
| Connector parameter | PIM information |
|---|---|
| Updated mode | No condition |
| Lower than | |
| Greater than | |
| Between | |
| Since last X days | |
| Since last X hours | |
| Since last successful import |
By selecting an "Updated mode", you will have to fill in the corresponding parameter above:
Lower than
| Connector parameter | Connector option |
|---|---|
| Updated before | Select desired date |
Greater than
| Connector parameter | Connector option |
|---|---|
| Updated after | Select desired date |
Between
| Connector parameter | Connector option |
|---|---|
| Updated before | Select desired date |
| Connector parameter | Connector option |
|---|---|
| Updated after | Select desired date |
Since last X days
| Connector parameter | Connector option |
|---|---|
| Updated | Fill in a number corresponding to the number of days |
Since last X hours
Available since the 101.6.0 version of the Akeneo Connector for Adobe Commerce.
| Connector parameter | Connector option |
|---|---|
| Updated | Fill in a number corresponding to the number of hours. Leave blank for no filter. |
Since last successful import
Available since the 102.1.0 version of the Akeneo Connector for Adobe Commerce.
| Connector parameter | Connector option |
|---|---|
| Updated mode | Since last successful import |
The connector will use the last successful start date of each family for this feature.
This date is stored in the "last_success_executed_date" column as JSON in the "akeneo_connector_job" table.
In case of a job error, this value will not be updated for the family failing, so the next job execution for this family will re-import the previous products that might have not been imported because of the error.
If the job is successful, the "last_success_executed_date" will be updated with the last executed date for every family imported during the run.
Filter on product Family
since 103.5.0
Select families you want to import:
| Connector parameter | Adobe Commerce information |
|---|---|
| Families to import | Select families you want to import |
This evolution is in order to standardize the behavior of filtering within the connector.
Before 103.5.0
Select PIM families you don't want to retrieve products from:
| Connector parameter | PIM information |
|---|---|
| Families | Select PIM families you don't want to retrieve products from. |
“ADVANCED” MODE
Please note any setting previously defined with the standard filtering mode will be overwritten if you switch to the advanced configuration.
For Products and Product Models, you can define your own filter using JSON format :
Products
Define your own product filter with the following parameter:
| Connector parameter | PIM information |
|---|---|
| Advanced Product Filter | PIM API JSON filter |
Product Models
Available since the 101.0.0 version of the Akeneo Connector for Adobe Commerce.
Define your own product model filter with the following parameter:
| Connector parameter | PIM information |
|---|---|
| Advanced Product Model Filter | PIM API JSON filter |
If you want to filter on a product model specific attribute in the Advanced Product Model Filter, make sure to also apply it on the Advanced Product Filter, as the variation products will inherit the value of these attributes from the product models
To know all the filtering possibilities and the JSON syntax, please refer to our API documentation on filtering possibilities.
For example, the filter below makes it possible for you to import only products with the Enable status, with a SKU starting with A and to only retrieve ecommerce scopable attribute content on the fr_FR/de_DE locales:
{
"search": {
"enabled": [{
"operator": "=",
"value": true
}],
"sku": [{
"operator": "STARTS WITH",
"value": "A"
}]
},
"scope": "ecommerce",
"locales": "fr_FR,de_DE"
}Filter on product Updated Date
Starting from the 103.5.0 version of the Akeneo Connector for Adobe Commerce, it is also possible to use the “Updated mode” filter in addition to the custom JSON.
If a condition is defined on the "Updated date" filter and in your JSON, the "Updated date" filter will overwrite the related JSON condition.
Have Akeneo data override content staging
Available since the version 100.4.4 of the Akeneo Connector for Adobe Commerce Community Edition.
Available since the version 100.5.2 of the Akeneo Connector for Adobe Commerce Enterprise Edition.
Adobe Commerce content staging is used to create scheduled versions of products.
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 |
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.
Note that this parameter will only be relevant on Adobe Commerce Enterprise Edition, as the content staging feature is specific to this version.