Skip to content
Last update: January 30, 2024

Filtering

The section below explains you how to manage the filtering process in the most common scenarios.

Filtering by category

Query Description Note
filter: "category.path:{catalog id/category path}"
filter: "category.path:catalogId/cat1d1/cat2id"		 Filters products that belong to
the exactly specified category path.		 The search is performed against the __path
index field of the product document.
filter: "category.subtree:{catalog id/category path}"
filter: "category.subtree:catalogId/cat1d1/cat2id"		 Filters products that belong to
the specified Category or any of its
descendant categories.		 The search is performed against the __outline
index field of the product document.

Filtering by price

Query Description Note
filter: "price.{currency}.{pricelist?}:{range expression}"
filter: "price.usd:(TO 100]"
filter: "price.usd.pricelist_1:(20 TO 100]" filter: "is:priced" (keeps only products that have at least one price set)		 Filters products based on the specified price value or range. The search will be performed against
the price_{currency} and price_{currency}_{pricelist}
index fields of the product document.
Only the indexed prices may be used
for filtration. Scoped prices based on user groups
or dynamic expressions temporary do not support filtration.

Filtering by SKU

Query Description
filter: "sku:DLL-65789352 Filters products based on the specified SKU.

Filtering Products or Variations

Query Description
filter: "is:product status:visible"
filter: "is:variation status:hidden"		 Includes only either the products or variations in the result. If not set, it will return both types.

Filtering by Custom Properties

Info

All product custom properties are stored in the index as fields with the same names as the base properties have ({property.name}:{property.value}).

Query Description
filter: "properties.{property name}: {value}
filter: "properties.color:red		 For keeping the products or variation with the custom attribute
matching the specified value or range.
filter= "\"processor core (ghz)\":\"1.8 GHz Intel GTX Quad-Core\"" For property name that contains spaces.
filter: "length:(10 TO 20)"
filter: "publishDate:(TO \"2020-01-28\")"		 For numeric and date time properties.

Filtering by Product Availability

Query Description
filter: "available_in:{warehouse}"
filter: "available_in:my-warehouse"		 Keeps only the products or variations with the availability matching the specified value or range.

Example

Displays products and variations in a list from a specific category.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
query {
  products(
    storeId: "B2B-store"
    cultureName: "en-US"
    first: 20
    after: "0"
    filter: "status:hidden,visible category.path:7829d35f417e4dd98851f51322f32c23/4fbaca886f014767a52f3f38b9df648f"
  ) {
    items {
      name
    }
    totalCount
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "data": {
    "products": {
      "items": [
        {
          "name": "1-1/2\" Steel Carriage Bolt, Grade 5, Chrome Plated Finish, 1/4\"-20 Dia/Thread Size, 5 PK"
        },
        {
          "name": "1\" Steel Carriage Bolt, Grade A, Hot Dipped Galvanized Finish, 1/4\"-20 Dia/Thread Size, 1300 PK"
        },
        {
          "name": "1-1/4\" Steel Carriage Bolt, Grade A, Hot Dipped Galvanized Finish, 1/4\"-20 Dia/Thread Size, 1100 PK"
        },
        {
          "name": "1-1/4\" Steel Carriage Bolt, Grade A, Hot Dipped Galvanized Finish, 5/16\"-18 Dia/Thread Size, 700 PK"
        },
        // ... more product items
      ],
      "totalCount": 23
    }
  }
}

Sorting

The default sorting of search results is based on their relevancy to the provided text (referred to as "score"), with the results sorted in descending order. However, you can specify an alternative sorting by using the sort query parameter, which follows the {field}:{asc|desc} structure. Multiple sort expressions can be combined using a semicolon ;.

For example, to sort the results by priority in descending order, followed by price_usd in ascending order, and finally by score, you can use the following sort parameter:

sort: "priority:desc;price_usd;score"