Skip to content

Search Panels

The pre-defined search panels all display search results based on the parameters and incoming arguments that are sent with a panel query.

For mandatory arguments for all panels including request URL format, see Panel Query.

Autocomplete panel

Risk of incorrect usage

Incorrect settings of the argument search_attributes can prevent the Autocomplete panel from utilising event data properly.

Incorrect settings of suggest can result in poor product data backfill for autocomplete.

The result of a query to this panel is a list of complete search phrases, given a beginning of a search phrase. Completions are ordered "best first". The intended use of autocomplete is with a search box where a visitor can select a completion from the autocomplete result. The completion is then used as a standard search query that will return results to a Search hits panel.

Search phrases returned as completions are normalised versions of phrases that have previously been used with searches on the site. If the suggest property is enabled for product attributes, these values will also be returned as normalised versions in the completions.

Before a search phrase is regarded as relevant for autocomplete it must be confirmed by a visitor. A specific search phrase can only be confirmed once per visitor session. The confirmation is performed when the visitor interacts with a result in the Search hits panel through click, adding to cart, or purchase.

Confirmed searched phrases are rated higher than those returned by the suggest attributes. The rank of a search phrase is based on the number of confirmations performed by visitors. Phrases returned by the suggest attributes are ordered based on the combined sales of all matching products. For autocomplete to properly use suggestions the search_attributes in the autocomplete panel must match the search_attributes in the Search hits panel. A recommendation is to always use the same values for search_attributes in all panels involved in search, or to create a specific autocomplete panel per search panel.

A filter may be passed as an argument with the query. The autocomplete function guarantees that once the search function is executed with a completion from the list, the search result must contain at least one product from the filter selection.

The arguments window_first and window_last must be included in a query to this panel

Panel arguments

Name Type Description Example
filter
Guide
filter An expression defining a set of products or variants. This set defines permissible results of the completions. Defaults to UNIVERSE if omitted in query. color:'red' OR color:'blue' AND in_stock:'true'
search_attributes
Guide
string A comma-separated list of search attributes used for suggestion validation. A typed format is also available to enable searching in category attributes. The search_attributes must be consistent with the search_attributes for the Search hits panel which the autocomplete is intended to be used for. Will return an empty result if omitted in the query. name,brand
search_prefix string The beginning of a search phrase. Only search phrases with this prefix are returned. Note that for suggestions from the product data, the attribute value has to start with the search_prefix. If the format of the attribute is a list, each list element is a separate candidate. Will return an empty result if omitted in the query. red d
window_first int The first position in the list to be presented. Completions before this position, according to the sorting, are not present in the result. The position of the first completion in the list is 1.
Required argument.
1
window_last int The last position in the list to be presented. Completions after this position, according to the sorting, are not present in the result. The following bounds apply: 1 ≤ window_firstwindow_last ≤ 20.
Required argument.
10

Example panel content

The following example will use the panel arguments search_attributes: artists, search_prefix:a, window_first:1, and window_last:3 to return product data.

JSON
{
   "resultType": "completions",
   "completions": [{
              "text": "ac/dc",
              "ticket": "Oy9hdXRvY29tcGxldGU7Izt0ZXh0O2FjL2RjOyM7IzsjOyM7",
              "rank": 1,
              "relevance": 228.74103932741144
          },
          {
              "text": "alicia keys",
              "ticket": "Oy9hdXRvLWNvbXBsZXRlOyM7dGV4dDthbGljaWEga2V5czsjOyM7IzsjOw",
              "rank": 2,
              "relevance": 79.0470533213271
          },
          {
              "text": "aerosmith",
              "ticket": "Oy9hdXRvY29tcGxldGU7Izt0ZXh0O2Flcm9zbWl0aDsjOyM7IzsjOw",
              "rank": 3,
              "relevance": 64.98534267486652
          }
      ]
}

Category search panel

The result of a query to this panel is a list of the categories that match the search_phrase in at least one search_attribute. Categories are ordered by best matching and most relevant categories first.

The arguments root_category and max_categories must be included in a query to this panel.

Panel arguments

Name Type Description Example
category_filter filter An expression defining the category set to search in. Defaults to UNIVERSE if omitted in the query. active:'true'
filter
Guide
filter An expression defining a set of products or variants. Only categories with products in the filter will be returned. No categories are filtered, even empty ones, and all products are included in the product count if omitted in query. in_stock:'true'
max_categories int The maximum number of categories that will be returned. The following bounds apply: 1 ≤ max_categories ≤ 10 000.
Required argument.
10
presentation_attributes
Guide
string A comma-separated list of the attributes in the category data to present. Default presentation attributes are used if omitted in the query. image_url,link
root_category category A tree and category key on the format: <tree>:'<category key>'. Only sub-categories of this category (and their sub-categories and so on) will be included in the result.
Required argument.
category:'Ladies'
search_attributes
Guide
string A comma-separated list of which configured category search attributes to search for the search phrase in. A typed format is available, but only category attributes will be considered by this panel. Will return an empty result if search_phrase was provided. All categories in the filter are returned if omitted in the query. display_name,tags
search_phrase string The search phrase to search for in the category data. Search will only be performed in the listed search_attributes. All categories in the filter are returned if omitted in the query. jeans

Example panel content

The following example will use the panel arguments search_attributes:display_name, search_phrase:music, root_category:category:'root', and max_categories:10 to return category data.

JSON
{
      "resultType": "categoryList",
      "categoryList": [{
              "tree": "category",
              "key": "electronics/av-portable-music-player",
              "ticket": "Oy9jYXRlZ29yeS1zZWFyY2g7IztjYXRlZ29yeTtjYXRlZ29yeTtlbGVjdHJvbmljcy9hdi1wb3J0YWJsZS1tdXNpYy1wbGF5ZXI7IzsjOyM7",
              "parentKey": "electronics",
              "displayName": "AV Portable Music Player",
              "productCount": 6,
              "attributes": {
                  "department": "electronics"
              }
          },
          {
              "tree": "category",
              "key": "game/music",
              "ticket": "Oy9jYXRlZ29yeS1zZWFyY2g7IztjYXRlZ29yeTtjYXRlZ29yeTtnYW1lL211c2ljOyM7IzsjOw",
              "parentKey": "game",
              "displayName": "Music",
              "productCount": 6,
              "attributes": {
                  "department": "game"
              }
          },
          {
              "tree": "category",
              "key": "music",
              "ticket": "Oy9jYXRlZ29yeS1zZWFyY2g7IztjYXRlZ29yeTtjYXRlZ29yeTttdXNpYzsjOyM7Izs",
              "parentKey": "root",
              "displayName": "Music",
              "productCount": 2693,
              "attributes": {}
          },
          {
              "tree": "category",
              "key": "music/musicals",
              "ticket": "Oy9jYXRlZ29yeS1zZWFyY2g7IztjYXRlZ29yeTtjYXRlZ29yeTttdXNpYy9tdXNpY2FsczsjOyM7Izs",
              "parentKey": "music",
              "displayName": "Musicals",
              "productCount": 1,
              "attributes": {
                  "department": "music"
              }
          },
          {
              "tree": "category",
              "key": "music/worldmusic",
              "ticket": "Oy9jYXRlZ29yeS1zZWFyY2g7IztjYXRlZ29yeTtjYXRlZ29yeTttdXNpYy93b3JsZG11c2ljOyM7IzsjOw",
              "parentKey": "music",
              "displayName": "Worldmusic",
              "productCount": 1,
              "attributes": {
                  "department": "music"
              }
          }
      ]
}

Category suggestions panel

Risk of incorrect usage

Incorrect settings of the argument search_attributes can prevent the Category suggestions panel from utilising event data properly.

Incorrect settings of suggest can result in poor attribute data backfill for category suggestions.

The result of a query to this panel is a list of category objects, including requested presentation_attributes, given a beginning of a search phrase.

Category suggestions are primarily selected based on previous event data. The suggestions are categories that have high correlation to completions of the given search_prefix. A backfill is taken from categories where attribute data match the search_prefix.

The maximum number of categories in a result is 20.

The arguments root_category and max_categories must be included in a query to this panel.

For specific cases, the autocomplete panel can be used with category attributes in the search_attributes argument. This allows for completion texts based only on category attributes.

Panel arguments

Name Type Description Example
category_filter filter An expression defining the category set to search in. Defaults to UNIVERSE if omitted in the query. active:'true'
filter
Guide
filter An expression defining a set of products or variants. Only categories with products in the filter will be returned. No categories are filtered, even empty ones, and all products are included in the product count if omitted in query. in_stock:'true'
max_categories int The maximum number of categories that will be returned. The following bounds apply: 1 ≤ max_categories ≤ 20.
Required argument.
5
presentation_attributes
Guide
string A comma-separated list of the attributes in the category data to present. Default presentation attributes are used if omitted in the query. image_url,link
root_category category A tree and category key on the format: <tree>:'<category key>'. Only sub-categories of this category (and their sub-categories and so on) will be included in the result.
Required argument.
category:'Ladies'
search_attributes
Guide
string A comma-separated list of which configured category search attributes to search for the search phrase in. A typed format is available, but only category attributes will be considered by this panel. Will return an empty result if search_phrase was provided. All categories in the filter are returned if omitted in the query. display_name,tags
search_prefix string The beginning of a search phrase. Only category suggestions associated with this prefix are returned. Note that for suggestions from the category data, the attribute value should preferably start with the search_prefix. Returns an empty result if omitted in the query. jea

Example panel content

The following example will use the panel arguments search_attributes:display_name, search_prefix:m, root_category:category:'root', and max_categories:3 to return category suggestions.

JSON
{
   "resultType": "categoryList",
      "categoryList": [{
              "tree": "category",
              "key": "book/memoarer",
              "ticket": "Oy9jYXRlZ29yeS1zdWdnZXN0aW9uczsjO2NhdGVnb3J5O2NhdGVnb3J5O2Jvb2svbWVtb2FyZXI7IzsjOyM7",
              "parentKey": "book",
              "displayName": "Memoarer ",
              "productCount": 25,
              "attributes": {
                  "department": "book"
              }
          },
          {
              "tree": "category",
              "key": "book/motion",
              "ticket": "Oy9jYXRlZ29yeS1zdWdnZXN0aW9uczsjO2NhdGVnb3J5O2NhdGVnb3J5O2Jvb2svbW90aW9uOyM7IzsjOw",
              "parentKey": "book",
              "displayName": "Motion",
              "productCount": 3,
              "attributes": {
                  "department": "book"
              }
          },
          {
              "tree": "category",
              "key": "game/music",
              "ticket": "Oy9jYXRlZ29yeS1zdWdnZXN0aW9uczsjO2NhdGVnb3J5O2NhdGVnb3J5O2dhbWUvbXVzaWM7IzsjOyM7",
              "parentKey": "game",
              "displayName": "Music",
              "productCount": 6,
              "attributes": {
                  "department": "game"
              }
          }
      ]
}

Did-you-mean panel

Risk of incorrect usage

Incorrect settings of the argument search_attributes can prevent the Did-you-mean panel from utilising event data properly.

Incorrect settings of suggest can result in poor product catalogue data backfill for did-you-mean.

The result of a query to this panel is a list of suggestions for corrections of given a search phrase. Corrections are ordered "best first". The intended use of did-you-mean is with a search box where a visitor can select a correction from the did-you-mean result. The correction is then used as a standard search query that will return results to a Search hits panel.

Search phrases returned as did-you-mean suggestions are normalised versions of phrases that have previously been used with searches on the site. If the suggest property is enabled for product attributes, these values will also be returned as normalised versions in the suggestions.

Before a search phrase is regarded as relevant for did-you-mean it must be confirmed by a visitor. A specific search phrase can only be confirmed once per visitor session. The confirmation is performed when the visitor interacts with a result in the Search hits panel through click, adding to cart, or purchase.

Confirmed searched phrases are rated higher than those returned by the suggest attributes. The rank of a search phrase is based on the number of confirmations performed by visitors. Phrases returned by the suggest attributes are ordered based on the combined sales of all matching products. For did-you-mean to properly use suggestions the search_attributes in the did-you-mean panel must match the search_attributes in the Search hits panel. A recommendation is to always use the same values for search_attributes in all panels involved in search, or to create a specific did-you-mean panel per search panel.

A filter may be passed as an argument with the query. The did-you-mean function guarantees that once the search function is executed with a correction from the list, the search result must contain at least one product from the filter selection.

The arguments window_first and window_last must be included in a query to this panel.

Panel arguments

Name Type Description Example
filter
Guide
filter An expression defining a set of products or variants. This set defines permissible results of the suggest phrases. Defaults to UNIVERSE if omitted in the query. color:'red' OR color:'blue' AND in_stock:'true'
search_attributes
Guide
string A comma-separated list of search attributes used for suggestion validation. The search_attributes must be consistent with the search_attributes for the Search hits panel which the did-you-mean is intended to be used for. Throws an exception if search_phrase was provided name,brand
search_phrase string The search phrase that should be corrected. will return an empty result of omitted in the query. red dress
window_first int The first position in the list to be presented. Suggestions before this position, according to the sorting, are not present in the result. The position of the first suggestion in the list is 1.
Required argument.
1
window_last int The last position in the list to be presented. Suggestions after this position, according to the sorting, are not present in the result. The following bounds apply: 1 ≤ window_firstwindow_last ≤ 20.
Required argument.
10

Example panel content

The following example will use the panel arguments search_attributes:artists, search_phrase:madona, window_first:1, and window_last:3 to return did-you-mean data.

JSON
{
   "resultType": "corrections",
   "corrections": [
   {
       "text": "madonna",
       "ticket": "Oy9zZWFyY2gtcGFnZS9kaWQteW91LW1lYW47Izt0ZXh0O21hZG9ubmE7IzsjOyM7Izs",
       "rank": 1,
       "relevance": 55.71162277905701
   }
   ]
}

Product suggestions panel

Risk of incorrect usage

Incorrect settings of the argument search_attributes can prevent the Product suggestions panel from utilising event data properly.

Incorrect settings of suggest can result in poor attribute data backfill for product suggestions.

The result of a query to this panel is a list of products given a beginning of a search phrase.

Product suggestions are primarily selected based on previous event data. The suggestions are products that have high correlation to completions of the given search_prefix. A backfill is taken from products where attribute data match the search_prefix. Each product in the result contains the best variant that match the search criteria.

The maximum number of products in a result is 20.

The arguments window_first and window_last must be included in a query to this panel.

For specific cases, the autocomplete panel can be used with product attributes in the search_attributes argument. This allows for completion texts based only on product attributes.

Panel arguments

Name Type Description Example
filter
Guide
filter An expression defining the product and variant set to find search hits in. Defaults to UNIVERSE if omitted in the query. color:'red' OR color:'blue' AND in_stock:'true'
presentation_attributes
Guide
string A comma-separated list of the attributes in the product data to present. Default presentation attributes are used if omitted in the query. name,brand,image_url
search_attributes
Guide
string A comma-separated list of which configured search attributes to search for the search phrase in. A typed format is also available to enable searching in category attributes. Will return empty result if search_phrase was provided. name,brand
search_prefix string The beginning of a search phrase. Only search phrases with this prefix are returned. Note that for suggestions from the product data, the attribute value has to start with the search_prefix. If the format of the attribute is a list, each list element is a separate candidate. Will return an empty result if omitted in the query. red d
window_first int The first position in the list to be presented. Products before this position, according to the sorting, are not present in the result. The position of the first product in the list is 1.
Required argument.
1
window_last int The last position in the list to be presented. Products after this position, according to the sorting, are not present in the result. The following bounds apply: 1 ≤ window_firstwindow_last ≤ 20
Required argument.
10

Example panel content

The following example will use the panel arguments search_attributes:artists,title, search_prefix:mado, window_first:1, and window_last:3 to return product suggestions.

JSON
{
   "resultType": "products",
   "products": [
   {
      "key": "P103471",
      "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMTAzNDcxOyM7T0JKRUNUSVZFJDtOT05FOk5PTkU7NTE7",
      "variants": [{
         "key": "V103471-1",
         "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMTAzNDcxO1YxMDM0NzEtMTtPQkpFQ1RJVkUkO05PTkU6Tk9ORTs1MTs=",
         "attributes": {
            "custom_attribute": "value1",
            "variant_key": "V103471-1"
         }
      }, 
      {
         "key": "V103471-2",
         "ticket": "Oy9kb2NkUkO05PTkU6Tk9ORTs1MTs1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMTAzNDcxO1YxMDM0NzEtMjtPQkpFQ1RJV=",
         "attributes": {
            "custom_attribute": "value2",
            "variant_key": "V103471-2"
         }
      }],
      "attributes": {
         "artists": "Madonna",
         "product_key": "P103471",
         "rank": "1",
         "relevance": "11.923907341875031",
         "custom_attribute": "value",
         "title": "True Blue (Remastered)"
      }
   },
   {
      "key": "P32950",
      "ticket": "Oy9kb2N1bWVudGF0leTtQMzI5NTA7IztPQkpFQ1RJVkUkO05PTkU6Tk9ORTs1MTsaW9uLWV4YW1wbGU7Iztwcm9kdWN0X2t=",
      "variants": [],
      "attributes": {
         "artists": "Madonna",
         "product_key": "P32950",
         "rank": "2",
         "relevance": "1.0005431000396758",
         "custom_attribute": "value",
         "title": "Ray Of Light"
      }
   },
   {
      "key": "P5111",
      "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQNTExMTsjO09CSkVDVElWRSQ7Tk9ORTpOT05FOzUxOw==",
      "variants": [{
         "key": "V5111-1",
         "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tMTtPQkpFQ1RJVkUkO05PTkU6Tk9ORTs1MTsleTtQMTAzNDcxO1YxMDM0NzEt=",
         "attributes": {
            "custom_attribute": "value1",
            "variant_key": "V5111-1"
         }
      }],
      "attributes": {
         "artists": "Madonna",
         "product_key": "P5111",
         "rank": "3",
         "relevance": "0.999999",
         "custom_attribute": "value",
         "title": "Like A Prayer"
      }
   }]
}

Search hit count panel

The result of a query to this panel is the number of products in a search result given the specified search phrase. Variant matches for a certain product will count as a product match. Even if several variants within a product matches, the product is only counted once.

The result can be filtered o only include particular types of products anv variants. A search with the added search_phrase argument will only be performed in the provided search_attributes for the filtered data set.

The result will be approximated if the number of products exceeds 10 000.

Panel arguments

Name Type Description Example
facets facets A pipe-separated list of selected facet values. Ignored if omitted in the query. color:red|blue,size:6
filter
Guide
filter An expression defining the product and variant set to find search hits in. Defaults to UNIVERSE if omitted in the query. color:'red' OR color:'blue' AND in_stock:'true'
search_attributes
Guide
string A comma-separated list of which configured search attributes to search for the search phrase in. A typed format is also available to enable searching in category attributes. Will return empty result if search_phrase was provided. name,brand
search_phrase string The search phrase to search for in the product data. Search will only be performed in the listed search_attributes. Selection and ranking won't be based on search phrase if omitted in the query. red dress
selected_category category A selected category on the form: <tree name>:'<category key>'. Only products from this category and its sub-categories will be included in the result. Products from all categories are considered if omitted in the query. category:'Ladies'

Example panel content

The following example will use the panel arguments filter:category:'music', search_attributes:artists,title, and search_phrase:michael to return search data.

JSON
{
   "resultType": "count",
   "count": 31
}

Search hits panel

Risk of incorrect usage

The Search hits panel should be used when explicit searches are performed by a visitor, i.e. when the visitor has entered text in a search box and requests a result.

The Search hits panel should not be used for any other product listings, such as start page product listing or category product listing. The Product list panel must be used in such cases.

The result of a query to this panel is a list of products and variants given the specified search phrase. A search with the added search_phrase argument will only be performed in the provided search_attributes for the filtered data set. Additional arguments can be supplied to order the result list and more.

The result is a list of product elements, each specifying all presentation attributes and the list rank of that product. Each product contains the variants matched by the filter and relevant to the search phrase and attribute. Variants are ranked in the same way as products.

The maximum number of products returned in a result is 10 000.

The arguments window_first and window_last must be included in a query to this panel.

Panel arguments

Name Type Description Example
facets facets A pipe-separated list of selected facet values. Ignored if omitted in the query. color:red|blue,size:6
filter
Guide
filter An expression defining the product and variant set to find search hits in. Defaults to UNIVERSE if omitted in the query. color:'red' OR color:'blue' AND in_stock:'true'
locale string The locale of the sorting when the sorting is made by value. Value sorting will be made in ASCII order if omitted in the query. sv_SE
presentation_attributes
Guide
string A comma-separated list of the attributes in the product data to present. Default presentation attributes are used if omitted in the query. name,brand,image_url
search_attributes
Guide
string A comma-separated list of which configured search attributes to search for the search phrase in. A typed format is also available to enable searching in category attributes. Will return empty result if search_phrase was provided. name,brand
search_phrase string The search phrase to search for in the product data. Search will only be performed in the listed search_attributes. Selection and ranking won't be based on search phrase if omitted in the query. red dress
selected_category category A selected category on the form: <tree name>:'<category key>'. Only products from this category and its sub-categories will be included in the result. Products from all categories are considered if omitted in the query. category:'Ladies'
sort_by
Guide
search_order Specifies in which order the products and variants should be sorted. Secondary orders can be given using a comma-separated list. Defaults to relevance if omitted in the query. price asc
variants_per_product int The maximum number of variants per product to include in the result. No maximum limit. 10
window_first int The first position in the list to be presented. Products before this position, according to the sorting, are not present in the result. The position of the first product in the list is 1.
Required argument.
1
window_last int The last position in the list to be presented. Products after this position, according to the sorting, are not present in the result. The following bounds apply: 1 ≤ window_firstwindow_last ≤ 10 000
Required argument.
10

Example panel content

The following example will use the panel arguments search_attributes:artists,title, search_phrase:madonna, window_first:1, and window_last:3 to return search data.

JSON
{
   "resultType": "products",
   "products": [
        {
           "key": "P103471",
           "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMTAzNDcxOyM7T0JKRUNUSVZFJDtOT05FOk5PTkU7NTE7",
           "variants": [{
               "key": "V103471-1",
               "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMTAzNDcxO1YxMDM0NzEtMTtPQkpFQ1RJVkUkO05PTkU6Tk9ORTs1MTs=",
               "attributes": {
                   "custom_attribute": "value1",
                   "variant_key": "V103471-1"
               }
           }, 
           {
               "key": "V103471-2",
               "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMTAzNDcxO1YxMDM0NzEtMjtPQkpFQ1RJVkUkO05PTkU6Tk9ORTs1MTs=",
               "attributes": {
                   "custom_attribute": "value2",
                   "variant_key": "V103471-2"
               }
           }],
           "attributes": {
               "artists": "Madonna",
               "product_key": "P103471",
               "rank": "1",
               "relevance": "1.0",
               "custom_attribute": "value",
               "title": "True Blue (Remastered)"
           }
       },
       {
           "key": "P32950",
           "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQMzI5NTA7IztPQkpFQ1RJVkUkO05PTkU6Tk9ORTs1MTs=",
           "variants": [],
           "attributes": {
               "artists": "Madonna",
               "product_key": "P32950",
               "rank": "2",
               "relevance": "0.5",
               "custom_attribute": "value",
               "title": "Ray Of Light"
           }
       },
       {
           "key": "P5111",
           "ticket": "Oy9kb2N1bWVudGF0aW9uLWV4YW1wbGU7Iztwcm9kdWN0X2tleTtQNTExMTsjO09CSkVDVElWRSQ7Tk9ORTpOT05FOzUxOw==",
           "variants": [],
           "attributes": {
               "artists": "Madonna",
               "product_key": "P5111",
               "rank": "3",
               "relevance": "0.3333333333333333",
               "custom_attribute": "value",
               "title": "Like A Prayer"
           }
       }]
}

Search hits with count zone

This panel is a zone containing instances of Search hits and Search hit count panels as sub-panels. Arguments to this panel are a combination of the required arguments for the two sub-panels. The result of a query to this panel is a combination of the panel content that can be retrieved by the two result panels.

The arguments window_first and window_last must be included in a query to this panel.

Panel arguments

Name Type Description Example
facets facets A pipe-separated list of selected facet values. Ignored if omitted in the query. color:red|blue,size:6
filter
Guide
filter An expression defining the product and variant set to find search hits in. Defaults to UNIVERSE if omitted in the query. color:'red' OR color:'blue' AND in_stock:'true'
locale string The locale of the sorting when the sorting is made by value. Value sorting will be made in ASCII order if omitted in the query. sv_SE
presentation_attributes
Guide
string A comma-separated list of the attributes in the product data to present. Default presentation attributes are used if omitted in the query. name,brand,image_url
search_attributes
Guide
string A comma-separated list of which configured search attributes to search for the search phrase in. A typed format is also available to enable searching in category attributes. Will return empty result if search_phrase was provided. name,brand
search_phrase string The search phrase to search for in the product data. Search will only be performed in the listed search_attributes. Selection and ranking won't be based on search phrase if omitted in the query. red dress
selected_category category A selected category on the form: <tree name>:'<category key>'. Only products from this category and its sub-categories will be included in the result. Products from all categories are considered if omitted in the query. category:'Ladies'
sort_by
Guide
search_order Specifies in which order the products and variants should be sorted. Secondary orders can be given using a comma-separated list. Defaults to relevance if omitted in the query. price asc
variants_per_product int The maximum number of variants per product to include in the result. No maximum limit. 10
window_first int The first position in the list to be presented. Products before this position, according to the sorting, are not present in the result. The position of the first product in the list is 1.
Required argument.
1
window_last int The last position in the list to be presented. Products after this position, according to the sorting, are not present in the result. The following bounds apply: 1 ≤ window_firstwindow_last ≤ 10 000
Required argument.
10

Search zone

This panel is a zone containing instances of Search hits, Search hit count, and Did-you-mean panels as sub-panels. Arguments to this panel are a combination of the required arguments for the three sub-panels with minor modifications.

The result of a query to this panel is a combination of the panel content that can be retrieved by the three result panels.The arguments window_first and window_last are normally used for showing a number of suggestions from the did-you-mean panel together with any search hits. This is replaced with the argument number_of_suggestions which defines the number of suggestions that is returned by the did-you-mean panel. In a search zone, the arguments window_first and window_last are used for pagination of the search results returned.

The arguments window_first and window_last must be included in a query to this panel.

Panel arguments

Name Type Description Example
facets facets A pipe-separated list of selected facet values. Ignored if omitted in the query. color:red|blue,size:6
filter
Guide
filter An expression defining the product and variant set to find search hits in. Defaults to UNIVERSE if omitted in the query. color:'red' OR color:'blue' AND in_stock:'true'
locale string The locale of the sorting when the sorting is made by value. Value sorting will be made in ASCII order if omitted in the query. sv_SE
number_of_suggestions int The number of suggestions that is to be returned by the did-you-mean sub-panel. Defaults to 1 if omitted in the query. 3
presentation_attributes
Guide
string A comma-separated list of the attributes in the product data to present. Default presentation attributes are used if omitted in the query. name,brand,image_url
search_attributes
Guide
string A comma-separated list of which configured search attributes to search for the search phrase in. A typed format is also available to enable searching in category attributes. Will return empty result if search_phrase was provided. name,brand
search_phrase string The search phrase to search for in the product data. Search will only be performed in the listed search_attributes. Selection and ranking won't be based on search phrase if omitted in the query. red dress
selected_category category A selected category on the form: <tree name>:'<category key>'. Only products from this category and its sub-categories will be included in the result. Products from all categories are considered if omitted in the query. category:'Ladies'
sort_by
Guide
search_order Specifies in which order the products and variants should be sorted. Secondary orders can be given using a comma-separated list. Defaults to relevance if omitted in the query. price asc
variants_per_product int The maximum number of variants per product to include in the result. No maximum limit. 10
window_first int The first position in the list to be presented. Products before this position, according to the sorting, are not present in the result. The position of the first product in the list is 1.
Required argument.
1
window_last int The last position in the list to be presented. Products after this position, according to the sorting, are not present in the result. The following bounds apply: 1 ≤ window_firstwindow_last ≤ 10 000
Required argument.
10
×