Information about a storefront search query.

To learn about storefront search and how to include it in your theme, refer to Storefront search.

PropertiesTypeDescription
performedbooleanReturns true if a search was successfully performed. Returns false if not.
resultsThe search result items. It contains a product list and product count.
results_countnumberThe number of results.
termsstringThe entered search terms.
typesan array of stringThe object types that the search was performed on.
{
  "performed": true,
  "types": [
    "product"
  ],
  "terms": "1",
  "results_count": 76,
  "results": {
    "products": [],
    "products_count": 76
  }
}