Guides
Start typing to search…

Catalog views - Rules edition

A guide to configuring and managing Catalog Views using rules

Rules define the criteria that determine which products or variants dynamically appear in a Catalog View. They allow you to automate product selection based on conditions such as brand, category, attributes, or assortment, rather than managing items manually.

Creating a Catalog view by using rules

  1. Navigate to the Catalog -> Catalog views tab.
  2. Click on Create Catalog view.
  3. Fill in the Basic information :
    • Name* (mandatory): A clear and unique name to identify the catalog.
    • External ID (mandatory): A unique identifier without spaces or accents for API integration.
    • Status (mandatory): Define a status for the catalog (Active, Inactive)
    • Description(mandatory): Add a description for the catalog
  4. Select Rules edition as the configuration type.
  5. Define one or more rules to restrict catalog visibility.
    • The available rules :
      • Product name : The official name of the product as displayed to users
      • Product description : The description of the product
      • Product external id : The unique identifier of the product
      • Product Brand : The brand or manufacturer associated with the product
      • Classification category id : The id of the classification category identifier associated to the product
      • Product attributes : The values of the product attributes
      • Variant name : The name of a specific variant of the product
      • Variant description : The description of the variant
      • Variant external id : The unique identifier of the variant
      • Variant EAN : The European Article Number of the variant
      • Variant MPN : The Manufacturer Part Number of the variant
      • Assortiment id : The external identifier of the assortment to which the variants belongs to
      📘

      Conditions such as NOT , AND and OR are used to combine and structure the rules

  6. Select the Customer accounts that will have access to this restricted Catalog View.
    • A search bar helps you find relevant accounts using:
      • Account name
      • Account external Id
  7. Click on “Create” to generate the new Catalog View.
    ℹ️

    Once created, you can continue to configure its content and rules


❗️

Important

For Catalog Views configured using rules, newly created variants are not included automatically, even if they match the defined rule criteria.

To include newly created variants:

  • Ensure the variants meet the rule conditions.

  • Run the Catalog Synchronization Job to apply the rules and update the Catalog View content.

When a rule is based on an assortment, additional actions are required.

Variants created after the assortment has been added to the rule are not included automatically. To make these variants visible in the Catalog View, you must:

  • Add the new variants to the assortment
  • Run the Catalog Synchronization Job

Rule Behavior

Rules behave differently depending on whether they target products or variants:

Product-level rules When a rule targets product information (such as product name, external ID, attributes, or classification category), all variants of the matching products are added to the Catalog View.

Variant-level rules When a rule targets variant information (such as variant name, external ID, EAN, or MPN), only the matching variants are added, not the entire variants of the product.


Catalog Synchronization Job

After creating a Catalog View that contains rules, a synchronization job must be executed. This job automatically analyzes all the defined rules and retrieves the corresponding products or variants from the catalog.

📘

At the moment, synchronization must be triggered manually. Automatic synchronization is not supported.

Once the job is complete, the Catalog View is populated with the items that match the configured conditions, ensuring that the catalog remains up to date with the latest data and rules.

This job is accompanied by status indicators to help track its progress:

  • In progress – the job is currently running and has not yet completed.
  • Finished – the job has completed successfully, and all matching products or variants have been added to the Catalog View.

The synchronisation job must be launched whenever the Catalog View rules are updated or deleted so the changes are applied and visible.

To start a synchronization job:

  • Go to the Catalog View list.
  • Click the Sync button.
📘

The Catalog Synchronization Job applies to all Catalog Viewsnot just a single Catalog View.


Updating a Catalog view Rules edition content

To update the content of a Catalog View configured with Rules edition, the rules themselves must be modified.

Depending on your needs, you can:

  • Update an existing rule
  • Remove one or more rules
  • Add new ones

After updating the rules, a Catalog Synchronization Job must be executed for the changes to take effect.

❗️

Important

  • When a product is removed, all associated variants are automatically removed.
  • If the last remaining variant of a product is removed, the product is no longer displayed.

❗️

Important

Catalog Views can also be created/updated via Import API through the Data Hub. At the moment, this method supports Catalog Views based exclusively on assortment rules.

Other rule types, as well as manual product or variant additions and removals, are not currently supported when creating or updating Catalog Views through import.

🔗Useful Links:


Updated 6 days ago