Filter scope
The filter configuration described below is valid for all your Websites and Store Views.
Unfortunately, with the current version of the Akeneo Connector for Adobe Commerce, there are currently no possibilities to configure multiple filters at the same time according to your Websites or Store Views.
No matter your filters, for a product to be imported, it must be linked to a category on the channel.
Filter product and product models
Since the 101.0.0 version of the Akeneo Connector for Adobe Commerce, filters configured in the connector will be applied to both product models and products.
However, some filters are unavailable directly for product models, and will not be applied to them such as:
- Enabled
- Group
- Parent
- Completeness
You can still define one of the filter above in your configuration, it will just be applied only to products, and not to product models
Filter products: 2 modes
In 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 information |
---|---|
Mode | "Standard" or "Advanced" |
"Standard" mode
With this Standard mode, you can filter on:
- Channel
- Completeness (Simple product only)
- Product status (enabled or disabled / Simple product only)
You will also be able to:
- Import only updated products
- Select PIM families you don't want to retrieve products from.
If you want to have more filter possibilities, you will need to switch to Advanced mode.
HOW TO FILTER PRODUCTS ON A SPECIFIC PIM CHANNEL?
In the connector configuration page, in Filter products, you can filter your PIM products on a specific PIM channel:
Connector parameter | PIM information |
---|---|
Channel | PIM Channel ID |
HOW TO FILTER PRODUCTS ON PIM COMPLETENESS?
In the connector configuration page, in Filter products, you can 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 |
The Product completeness filter will only be applied to products, and not to product models
HOW TO FILTER PRODUCT MODELS ON PIM COMPLETENESS?
Since the 101.0.0 version of the Akeneo Connector for Adobe Commerce, in the connector configuration page, in Filter products, you can 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 |
The Product Model completeness filter will only be applied to product models, and not to products
HOW TO FILTER ON PIM PRODUCT STATUS?
In the connector configuration page, in Filter products, you can filter on your PIM products status:
Connector parameter | PIM information |
---|---|
Status | No condition or Enable or Disable |
The status filter will only be applied to products, and not to product models
HOW TO IMPORT ONLY UPDATED PRODUCTS?
In the connector configuration page, in Filter products, 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 | 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 | PIM information |
---|---|
Updated before | Desired date |
Greater than
Connector parameter | PIM information |
---|---|
Updated after | Desired date |
Between
Connector parameter | PIM information |
---|---|
Updated before | Desired date |
Connector parameter | PIM information |
---|---|
Updated after | Desired date |
Since last **X** days
Connector parameter | PIM information |
---|---|
Updated | Number of days |
Since the 101.6.0 version of the Akeneo Connector for Adobe Commerce, you can filter product per hour:
Since last **X** hours
Connector parameter | PIM information |
---|---|
Updated | Number of hours |
Since the 102.1.0 version of the Akeneo Connector for Adobe Commerce, you can filter products automatically from the last successful product import date:
Since last successful import
Connector parameter | PIM information |
---|---|
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.
HOW TO SELECT PIM FAMILIES YOU DON'T WANT TO RETRIEVE PRODUCTS FROM?
In the connector configuration page, in Filter products, you can 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.
In the connector configuration page, in Filter products, you can define your own product filter with the following parameter:
Connector parameter | PIM information |
---|---|
Advanced Product Filter | PIM API JSON filter |
Since the 101.0.0 version of the Akeneo Connector for Adobe Commerce, in the connector configuration page, in Filter products, you can 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
This field must be written in JSON format.
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"
}