Skip to main content

Product Filters Documentation

Written by Shashank Agrawal

The Product Filters section provides detailed control over which products are included or excluded when rendering or querying product data. Below are the available filters and their purposes:

1. Filter Out-of-Stock Products

  • Description: Excludes products that are currently out of stock.

  • Use Case: Ensures that only purchasable products are displayed to customers.

2. Include All Variants of Selected Products

  • Description: When a product is selected, all of its variants (e.g., size, color) are included.

  • Use Case: Useful when campaigns or rules should apply to every variant of a product.

3. Exclude Unavailable Variants

  • Description: Removes unavailable (e.g., hidden, archived, or disabled) variants from the selection.

  • Use Case: Ensures only active and sellable variants are part of the campaign.

4. Minimum Stock Filter

  • Description: Includes only products that meet or exceed the defined minimum stock level.

  • Use Case: Prevents campaigns from targeting items with very low stock.

5. Maximum Stock Filter

  • Description: Includes only products with stock below the defined maximum threshold.

  • Use Case: Helpful for promoting items that are overstocked.

6. Exclude Tags Filter

  • Description: Excludes products with specific tags.

  • Use Case: Allows ignoring products marked with tags like "hidden", "test", or "internal".

7. Include Tags Filter

  • Description: Includes only products that contain specific tags.

  • Use Case: Targets campaigns to items with tags such as "sale", "new arrival", or "featured".

8. Filter Freebie

  • Description: Excludes freebie or zero-cost products from the product set.

  • Use Case: Prevents free items from being incorrectly promoted or shown.

9. Exclude Category Filter

  • Description: Excludes products belonging to specific categories.

  • Use Case: Allows excluding entire categories (e.g., Gift Cards, Services) from campaigns.

10. Exclude Current PDP

  • Description: Excludes the product currently being viewed on the product detail page (PDP).

  • Use Case: Useful in recommendation widgets where showing the same product again would be redundant.

Tip: Combine multiple filters for advanced product targeting, such as promoting in-stock, tagged "sale" items with stock above 10 units, while excluding freebies.

Did this answer your question?