Synchronization filters

This section explains how product selection works in the Akeneo app for Shopify.

What are synchronization filters?

Synchronization filters are filters that can be applied to simple products, product models, and variants during the synchronization process. They represent the product selection - or products and products with variants that will be synced to Shopify.

Supported filtering levels

Create synchronization filters

Synchronization filters are built with selection criteria, in the same way as a product selection in the PIM: each criterion is made of a property (a system property or an Attribute), an operator and a value. A product, product model or product variant must match all the criteria of its tab to be synchronized.

Follow these steps to create your filters:

1. In your Akeneo App for Shopify, navigate to the Configuration page.
2. Go to the Synchronization filters section.
3. Select the tab of the level you want to filter: Products, Product models or Product variants. Each tab shows the number of criteria it contains.
4. Click Add selection criteria, then search and select a property. Properties are grouped into System properties and Attributes.
5. Select an operator and enter or select the value. For scopable or localizable Attributes, also select the Channel and the Locale.
6. Repeat for each criterion you need. You can use the same property in several criteria, and remove a criterion with the Remove criterion button.
7. In the Product selection block, click the refresh button (Refresh counters with current filters) to update the Products, Product models and Product variants counters, and make sure your filters are applied as expected. The counters are not updated automatically while you edit the criteria.
8. Save your configuration.

When a tab has no criteria, every item of this level is synchronized.

Available system properties

Available Attribute types

Attributes can be used at every filtering level (simple product, product model and product variant).

Filter presets

Filter presets let you save several sets of synchronization filters for the same store, for example, a "Black Friday" preset next to your usual selection. You can then pick a preset for a manual synchronization, or for each scheduled synchronization.

The filters you define without selecting a preset are the Store default filters. They are used by manual and scheduled synchronizations, unless another preset is picked.

Create a filter preset

1. In the Configuration page, go to the Synchronization filters section.
2. Define the criteria you want to save.
3. Click Save as new preset, enter a name and click Create preset. Preset names must be unique for the store (regardless of case).

Update a filter preset

1. In the Configuration page, go to the Synchronization filters section.
2. Select the preset in the Filter preset field. The criteria of this preset are displayed, and the Product selection counters follow the selected preset.
3. Add, edit or remove criteria in the Products, Product models and Product variants tabs.
4. Click the refresh button (Refresh counters with current filters) to check that the preset selects the expected items.
5. Click Save to save your configuration.

The changes apply to the next synchronizations that use this preset, including the scheduled ones. If you switch to another preset with unsaved changes, the app asks you to confirm before discarding them.

Rename or delete a filter preset

Select the preset in the Filter preset field, then click Rename or Delete. The store default filters cannot be renamed or deleted.

Use a filter preset for a manual synchronization

When you launch a manual synchronization, select a preset in the Filter preset field. The preset applies to this run only. The Filters for this run recap shows the criteria that will be applied for each level.

Use a filter preset for a scheduled synchronization

In the scheduled synchronization configuration, select a preset in the Filter preset field. The preset is used on every scheduled run, and any change you make to the preset is applied from the next run.

Edit synchronization filters in JSON

The JSON tab of the Synchronization filters section shows the same filters as the form: switching between the form and the JSON loses nothing. If your stored filters do not have the shape the form expects, only the JSON tab is shown.

1. In your Akeneo App for Shopify, navigate to the Configuration page.
2. In the Synchronization filters section, open the JSON tab and edit the JSON in the Product synchronization filters editor. It contains three keys:
   • "product_filters":{},: corresponding to simple product filters.
   • "product_model_filters": {},: corresponding to product model filters.
   • "product_variant_filters": {}: corresponding to product variant filters.
   
   For each key, you can define your own filters using the same REST API structure, but you don’t need to include the URL or the search= parameter:
   "attribute_code":[{"operator":"operator","value":value}]
   
   You can use the Filter examples panel next to the editor as a starting point.
   
   Example with the PIM status:
   {"enabled":[{"operator":"=","value":true}]}
3. In the Product selection block, click the refresh button (Refresh counters with current filters) to update the counters and make sure your filters are applied as expected. The counters are not updated automatically while you edit the JSON.
4. Save your configuration.

Filter example

Here’s an example of a filter that can be applied to your simple products, product models, and product variants.
For the full list of available filters and operators, please refer to the REST API documentation.

{
  "product_filters": {
  	"categories":[{"operator":"IN CHILDREN","value":["clothing_catalog"]}],
  	"enabled":[{"operator":"=","value":true}],
  	"family":[{"operator":"IN CHILDREN","value":["pants","tshirt","shoes"]}],
  	"send_to_shopify":[{"operator":"=","value":true}]
  },
  "product_model_filters": {
  	"categories":[{"operator":"IN CHILDREN","value":["clothing_catalog"]}],
  	"family":[{"operator":"IN CHILDREN","value":["pants","tshirt","shoes"]}],
  	"send_to_shopify":[{"operator":"=","value":true}]
  },
  "product_variant_filters": {
  	"enabled":[{"operator":"=","value":true}],
  	"send_to_shopify":[{"operator":"=","value":true}]
  }
}

Common filters