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.
This mapping is optional. However, if no filters are defined, the app will synchronize all simple products, product models and variants from your PIM linked to the category tree assigned to the channel you mapped.
Supported filtering levels
| Filtering level | Supported? |
|---|---|
| Simple product | Yes |
| Product model | Yes |
| Product variant | Yes |
Create synchronization filters
Follow these steps to create your custom filters:
- In your Akeneo App for Shopify, navigate to the Configuration page.
- In the Synchronization filters section, you'll see three sections:
•"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 section, you can define your own filters using the same REST API structure, but you don’t need to include the URL or thesearch=parameter:"attribute_code":[{"operator":"operator","value":value}]
Example with the PIM status:{"enabled":[{"operator":"=","value":true}]} - Check the product selection counter to make sure your filter is applied as expected.
- 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}]
}
}Please note that the parent and updated_at filters are not allowed in the app.
Common filters
| Filter type | Filter level | Filter synthax |
|---|---|---|
| Filter by Category | Simple product, Product model, Product variant | "categories":[{"operator":"IN","value":["winter_collection"]}] |
| Filter by Status | Simple product, Product variant | "enabled":[{"operator":"=","value":true}] |
| Filter by UUID | Simple product, Product variant | "uuid":[{"operator":"IN","value":["8945388d-cf5b-49af-8799-05d1ed6e296f", "941fe892-99dd-440f-b2a9-8eccb94248f0"]}] |
| Filter by Product model code | Product model | "identifier":[{"operator":"IN","value":["amor","apollon"]}] |
| Filter by Completeness | Simple product, Product variant | "completeness":[{"operator":"=","value":100,"scope":"ecommerce"}] |
| Filter by Attribute | Simple product, Product model, Product variant | ATTRIBUTE_CODE:[{"operator":OPERATOR,"value":VALUE,"locale":LOCALE_CODE,"scope":CHANNEL_CODE}] |