Backend Search

Last updated: May 9, 2024

Backend search is a tool that can be used to apply text to search for entries that contain the given text value. For example, the term "blanket" could be used to search for product entries that contain the text "blanket" in the title. This functionality is accessible through the allProduct, allProductCollections, and allContent queries under the searchFilter field in the filter.

searchFilter attributes

  • fields: The searchable fields for the given entries

    • accepted values for allContent: TITLE, HANDLE, TYPE

    • accepted values for allProduct: TITLE, HANDLE, TAGS, SKU

    • accepted values for allProductCollections: TITLE, HANDLE, TAGS

  • sortField: The field by which to sort by

  • sortOrder: The order by which to sort

  • term: The search term of the entry to search

Example Filter

{
  "filter": {
    "searchFilter": {
      "fields": ["TITLE", "HANDLE"],
      "term": "blanket"
    }
  }
}