Search
An auto-generated type for paginating through multiple SearchResultItems.
Anchor to Queries with this connectionQueries with this connection
- search (SearchResultItemConnection!)
- •query
Returns paginated search results for
Product,Page, andArticleresources based on a query string. Results are sorted by relevance by default.The response includes the total result count and available product filters for building faceted search interfaces. A search returns up to 1,000 results. When product results are included, a search returns up to 2 pages or articles, on the first page of results only. To get more pages and articles, run a separate search with
types: [PAGE, ARTICLE]. Product results match partial words automatically. For page and article results, use theprefixargument to match partial words on the last search term, so that a query like "winter snow" can match pages that contain "snowboard" or "snowshoe".Show fields
- Anchor to afterafter•String
Returns the elements that come after the specified cursor.
- Anchor to beforebefore•String
Returns the elements that come before the specified cursor.
- Anchor to firstfirst•Int
Returns up to the first
nelements from the list.- Anchor to lastlast•Int
Returns up to the last
nelements from the list.- Anchor to prefixprefix•Search
Prefix Query Type For page and article results, specifies whether to match partial words on the last search term. Product results match partial words automatically.
Show enum values
- Anchor to productFiltersproduct•[Product
Filters Filter!] Returns a subset of products matching all product filters.
The input must not contain more than
250values.Show input fields
- Anchor to queryquery•String!required
The search query.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Search
Key Sort Keys Default:RELEVANCE Sort the underlying list by the given key.
Show enum values
- Anchor to typestypes•[Search
Type!] The types of resources to search for.
The input must not contain more than
250values.Show enum values
- •Search
Unavailable Products Type Specifies how unavailable products or variants are displayed in the search results.
Show enum values
Arguments
Anchor to Possible returnsPossible returns
- edges ([SearchResultItemEdge!]!)
- nodes ([SearchResultItem!]!)
- pageInfo (PageInfo!)
- productFilters ([Filter!]!)
- totalCount (Int!)
- Anchor to edgesedges•[Search
Result Item Edge!]! non-null A list of edges.
Show fields
- Anchor to nodesnodes•[Search
Result Item!]! non-null A list of the nodes contained in SearchResultItemEdge.
Show union types
- Anchor to pageInfopage•Page
Info Info! non-null Information to aid in pagination.
Show fields
- Anchor to productFiltersproduct•[Filter!]!
Filters non-null A list of available filters.
Show fields
- Anchor to totalCounttotal•Int!
Count non-null The total number of results, up to a maximum of 1,000. If a search matches more than 1,000 results, then it returns 1,000, and pagination returns up to the first 1,000 results.