Choose a version:

predictiveSearch

query

List of the predictive search results.

Anchor to Arguments

Arguments

Anchor to limitlimit

•Int

Limits the number of results based on limit_scope. The value can range from 1 to 10, and the default is 10.

Anchor to limitScopelimitScope

•PredictiveSearchLimitScope

Decides the distribution of results.

Anchor to queryquery

•String!

required

The search query.

Anchor to searchableFieldssearchableFields

•[SearchableField!]

Specifies the list of resource fields to use for search. The default fields searched on are TITLE, PRODUCT_TYPE, VARIANT_TITLE, and VENDOR. For the best search experience, you should search on the default field set.

The input must not contain more than 250 values.

Anchor to typestypes

•[PredictiveSearchType!]

The types of resources to search for.

The input must not contain more than 250 values.

Anchor to unavailableProductsunavailableProducts

•SearchUnavailableProductsType

Specifies how unavailable products are displayed in the search results.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to PredictiveSearchResultPredictiveSearchResult

•PredictiveSearchResult

A predictive search result represents a list of products, collections, pages, articles, and query suggestions that matches the predictive search query.

Anchor to articlesarticles •[Article!]! non-null: The articles that match the search query.
Anchor to collectionscollections •[Collection!]! non-null: The articles that match the search query.
Anchor to pagespages •[Page!]! non-null: The pages that match the search query.
Anchor to productsproducts •[Product!]! non-null: The products that match the search query.
Anchor to queriesqueries •[SearchQuerySuggestion!]! non-null: The query suggestions that are relevant to the search query.

Was this section helpful?