Predictive Search API reference

The Predictive Search API can be used to display predictive search results for queries, products, collections, pages, and articles.

To learn how to use predictive search in a theme, refer to Add predictive search to your theme.

All Ajax API requests should use locale-aware URLs to give visitors a consistent experience.

Anchor to GET /{locale}/search/suggest.jsonGET /{locale}/search/suggest.json

The following example request retrieves predictive results for a specified search query:

GET /{locale}/search/suggest.json?q={query}

Anchor to Query parametersQuery parameters

Query parameter	Required	Description
`q`	Yes	The search query.
`resources[type]`	No	Specifies the type of results requested. The following are the accepted values, which can be combined in a comma-separated list: `product` `page` `article` `collection` `query` The default value is `query,product,collection,page`. To change the default value, you can use Search Settings in the Search & Discovery app.
`resources[limit]`	No	Limits the number of results based on `limit_scope`. The value can range from `1` to `10`, and the default is `10`.
`resources[limit_scope]`	No	Decides the distribution of results. The following are the accepted values: `all`: Return results up to `limit` across all types. `each`: Return results up to `limit` per type. The default value is `all`.
`resources[options][unavailable_products]`	No	Specifies whether to display results for unavailable products. The following are the accepted values: `show`: Show unavailable products. `hide`: Hide unavailable products. `last`: Show unavailable products below other matching results. The default value is `last`. To change the default value, you can use Search Settings in the Search & Discovery app. This parameter is only applicable to type `product`.
`resources[options][fields]`	No	Specifies the list of resource fields to search. The following are the accepted values: `author` `body` `product_type` `tag` `title` `variants.barcode` `variants.sku` `variants.title` `vendor` The default fields searched on are `title`, `product_type`, `variants.title`, and `vendor`. For the best search experience, you should search on the default field set.

Example request object

{

"q": "bag",

"resources": {

"type": "product",

"options": {

"unavailable_products": "hide",

"fields": "title,product_type,variants.title"

}

Example request using Fetch

fetch(window.Shopify.routes.root + "search/suggest.json?q=bag&resources[type]=product&resources[options][unavailable_products]=hide&resources[options][fields]=title,product_type,variants.title")

.then((response) => response.json())

.then((suggestions) => {

const productSuggestions = suggestions.resources.results.products;

if (productSuggestions.length > 0) {

const firstProductSuggestion = productSuggestions[0];

alert(`The title of the first product suggestion is: ${

firstProductSuggestion.title}`

);

}

);

Anchor to Resources responseResources response

The following example is a response to a successful request to the /{locale}/search/suggest.json endpoint, which contains resource objects associated with the specified query:

Example resources response

{

"resources": {

"results": {

"queries" : ARRAY OF RELEVANT search queries,

"products": ARRAY OF MATCHING product_object,

"collections": ARRAY OF MATCHING collection_object,

"pages": ARRAY OF MATCHING page_object,

"articles": ARRAY OF MATCHING article_object

}

Caution

You shouldn't output the body content of resource objects for stores that support multiple languages. When a store supports multiple languages, the body content contains a combination of the content translated in each language.

Example product_object

{

"available": BOOLEAN,

"body": STRING w/HTML,

"compare_at_price_max": DECIMAL ("0.00" when the product has no variants with a "compare_at_price"),

"compare_at_price_min": DECIMAL ("0.00" when the product has no variants with a "compare_at_price"),

"handle": STRING,

"id": INTEGER,

"image": STRING e.g, "https://cdn.shopify.com/s/...",

"price": DECIMAL,

"price_max": DECIMAL,

"price_min": DECIMAL,

"tags" : ARRAY OF STRING,

"title": STRING,

"type" : STRING,

"url": STRING e.g, "/products/fast-snowboard?_pos=1&_psq=snowb&_ss=e&_v=1.0",

"variants": [{

"available": BOOLEAN,

"compare_at_price": DECIMAL (nullable),

"id": INTEGER,

"image": STRING e.g, "https://cdn.shopify.com/s/...",

"price": DECIMAL,

"title": STRING,

"url": STRING e.g, "/products/fast-snowboard?_pos=1&_psq=snowb&_ss=e&_v=1.0",

"featured_image": {

"alt": STRING,

"aspect_ratio": DECIMAL,

"height": INTEGER,

"url": STRING e.g, "https://cdn.shopify.com/s/...",

"width": INTEGER

}

}],

"vendor": STRING,

"featured_image": {

"alt": STRING,

"aspect_ratio": DECIMAL,

"height": INTEGER,

"url": STRING e.g, "https://cdn.shopify.com/s/...",

"width": INTEGER

}

Note

A product variant is returned only when the query matches terms specific to the variant title. Only the variant with the most matching terms is returned. When a variant is returned, the following product_object fields will match those of the variant:

featured_image
image
url For example, a store has a snowboard with a blue variant and a light blue variant. If you search for snowbo, then only the snowboard product is returned. However, if you search for light blue snowbo, then the snowboard product is returned with the light blue variant.

Example collection_object

{

"body": STRING w/HTML,

"handle": STRING,

"id": INTEGER,

"featured_image": {

"alt": STRING,

"width": INTEGER,

"height": INTEGER,

"aspect_ratio": DECIMAL,

"url": STRING e.g, "https://cdn.shopify.com/s/..."

"published_at": STRING DATE,

"title": STRING,

"url": STRING e.g, "/collections/snowboards?_pos=1&_psq=sno&_ss=e&_v=1.0"

}

Example query_object

{

"url": STRING e.g, "/search?_pos=1&_psq=cos&_ss=e&_v=1.0&q=costume",

"text":STRING,

"styled_text": STRING e.g, "<mark>cos</mark><span>tume</span>"

}

Example page_object

{

"author": STRING,

"body": STRING w/HTML,

"handle":STRING,

"id": INTEGER,

"published_at": STRING DATE,

"title": STRING,

"url": STRING e.g, "/pages/my-page?_pos=1&_psq=my&_ss=e&_v=1.0"

}

Example article_object

{

"author": STRING,

"body": STRING w/HTML,

"handle": STRING,

"id": INTEGER,

"image": STRING e.g, "https://cdn.shopify.com/s/...",

"published_at": STRING DATE,

"summary_html": STRING w/HTML,

"tags": ARRAY OF STRING,

"title": STRING,

"url": STRING e.g, "/blogs/news/my-article?_pos=1&_psq=my&_ss=e&_v=1.0"

}

Anchor to Error responsesError responses

When a request to the /{locale}/search/suggest.json endpoint is unsuccessful, one of the following error responses is returned:

Invalid parameter error
Expectation failed
Too many requests

Any other errors not listed will return a 5xx status code.

Anchor to Invalid parameter errorInvalid parameter error

All errors related to the request parameters are returned with a 422 status code and a relevant error message. The description field describes the request error.

Invalid parameter example

{

"status": "422",

"message": "Invalid parameter error",

"description": "Invalid option for `unavailable_products` parameter"

}

Anchor to Expectation failedExpectation failed

If your theme isn't using one of the supported languages, then the API returns the following error:

Expectation failed example

{

"status": "417",

"message": "Expectation Failed",

"description": "Unsupported buyer locale"

}

Anchor to Too many requestsToo many requests

Exceeding the request throttle limit will return a 429 status code with a relevant error message.

Example

{

"status": "429",

"message": "Too many requests",

"description": "Throttled"

}

In this case, the response will also contain an HTTP header with the Retry-After value in seconds.

Retry-After example

Retry-After: 1

Anchor to GET /{locale}/search/suggestGET /{locale}/search/suggest

The following example request retrieves the HTML from a section rendered with the predictive results for a specified search query.

GET /{locale}/search/suggest?q={query}&resources[type]=product&section_id={section_id}

Anchor to Query parametersQuery parameters

The /search/suggest endpoint supports the same query parameters as the /search/suggest.json endpoint, in addition to the following:

Query parameter	Required	Description
`section_id`	Yes	The unique section ID of the section file that you want render with the predictive search query.

Example request object

{

"q": "bag",

"resources": {

"type": "product",

"options": {

"unavailable_products": "hide",

"fields": "title, product_type, variants.title"

}

"section_id": "predictive-search"

}

Example request using Fetch

const predictiveSearchSection = document.querySelector('.predictive-search-results');

var requestResponse;

fetch(window.Shopify.routes.root + "search/suggest?q=bag&resources[type]=product&resources[options][unavailable_products]=hide&resources[options][fields]=title,product_type,variants.title&section_id=predictive-search")

.then((response) => {

requestResponse = response;

return response.text();

})

.then((text) => {

if (!requestResponse.ok) {

throw new Error(`${requestResponse.status}: ${text}`);

}

const resultsMarkup = new DOMParser()

.parseFromString(text, 'text/html')

.querySelector('#shopify-section-predictive-search').innerHTML;

predictiveSearchSection.innerHTML = resultsMarkup;

})

.catch((error) => {

console.error(error);

});

Anchor to Section responseSection response

The response to a successful request to the /{locale}/search/suggest endpoint.

The section response contains the HTML of the provided section rendered with the predictive_search object containing the results of the specified query.

For example, the following section would generate the following section response:

Example section

{%- if predictive_search.performed -%}

{%- if predictive_search.resources.products.size > 0 -%}

<h3>Products</h3>

<ul>

{%- for product in predictive_search.resources.products -%}

<li><a href="{{ product.url }}">{{ product.title }}</a></li>

{%- endfor -%}

</ul>

{%- endif -%}

</div>

{%- endif -%}

Example section response

<h3>Products</h3>

<ul>

<li><a href="/products/running-shoes">Running Shoes</a></li>

<li><a href="/products/tennis-shoes">Tennis Shoes</a></li>

</ul>

</div>

Note

For the product resources type, if the query matches terms specific to a variant's title, the following product object fields will match those of the variant:

featured_media
url For example, a store has a snowboard with a blue variant and a light blue variant. If you search for snowbo, then the snowboard product is returned showing the featured media and URL for the snowboard product. However, if you search for light blue snowbo, then the snowboard product is returned showing the featured media and URL for the light blue variant.

Anchor to Error responsesError responses

When a request to the /{locale}/search/suggest endpoint is unsuccessful, one of the following error status codes is returned:

Status code	Description
`404`	Section not found - The provided section ID wasn't found in the theme.
`417`	Expectation failed - The buyer isn't using one of the supported languages.
`422`	Invalid parameter error - The value used for a query parameter was invalid.
`429`	Too many requests - The request throttle limit has been exceeded.

You can output the response text to get more details about an error. Refer to the example request using Fetch to learn more.

Note

Any other errors not listed will return a 5xx status code.

Anchor to Searchable propertiesSearchable properties

Search results are based on different searchable properties, depending on the resource type that you include in your query.

Resource type	Searchable properties
Products	`body` `product_type` `tag` `title` `variants.barcode` `variants.sku` `variants.title` `vendor`
Pages	`author` `body` `title`
Articles	`author` `body` `tag` `title`
Collections	`title`

Anchor to Searchable translationsSearchable translations

When searching a translated storefront, you can search the following properties:

Resource type	Searchable translations
Products	`body` `title` `variants.title`
Pages	`body` `title`
Articles	`body` `title`

Anchor to Typo toleranceTypo tolerance

Predictive search includes typo tolerance, which lets search terms containing typos return the correct matching search results.

Typo tolerance is set to 1, which means that search displays results that differ from the search term by 1 letter, or results that have 2 letters in a different order. The first 4 letters of a search term need to be entered correctly for typo tolerance to take effect.

The following fields support typo tolerance:

Resource type	Fields supporting typo tolerance
Products	`title` `product_type` `variants.title` `vendor`
Pages	`author` `title`
Articles	`author` `title`
Collections	`title`

Anchor to Partial word matchesPartial word matches

Predictive search supports partial word matches. This means that it suggests results even if the word you've entered is still incomplete. For example, if you enter sweate, then you might see a suggested search result for sweater.

Predictive search has the following limitations when it applies partial word matches:

If a search query has more than one term, then partial word matches are applied only to the last term in the query.
Partial word matches are applied only to the end of a search term. For example, if you enter book, then you won't see a suggested search result for ebook.
Partial word matches are supported only for themes using specific languages. For more details, refer to Requirements and limitations.

Predictive search uses a different search engine than storefront search. Because of this, it doesn't handle partial word matches in the same way. Although predictive search supports partial word matches, storefront search supports them only if the prefix option parameter is set to last.

Anchor to Requirements and limitationsRequirements and limitations

This section contains information about how predictive search is supported, and any current limitations.

Anchor to Supported languagesSupported languages

Predictive search is supported when the customer's online store session (buyer locale) is in one of the following supported languages:

Afrikaans
Albanian
Armenian
Bosnian
Bulgarian
Catalan
Croatian
Czech
Danish
Dutch
English
Estonian
Faroese
Finnish
French
Gaelic
German
Greek
Hungarian
Icelandic
Indonesian
Italian
Latin
Latvian
Lithuanian
Macedonian
Moldovan
Norwegian
Norwegian (Bokmål)
Norwegian Nynorsk
Polish
Portuguese (Brazil)
Portuguese (Portugal)
Romanian
Russian
Serbian
Serbo-Croatian
Slovak
Slovenian
Spanish
Swedish
Turkish
Ukrainian
Vietnamese
Welsh

A script tag in the <head> section indicates whether predictive search is supported for the theme language: <script id="shopify-features"></script>. This script tag includes a JSON-encoded predictiveSearch key with a boolean value. When it's set to true, the theme language is supported, and predictive search is enabled. Otherwise, it's set to false.

Anchor to LimitationsLimitations

Individual products can't be excluded from predictive search results. If a product is hidden from search engines and sitemaps with the metafield seo.hidden, then it won't appear in predictive search results. Learn more about hiding resources with this metafield.
The API returns no more than 10 predictive suggestions per request type.
Collection suggestions are based on the store's primary language. A customer's search won't be compared to a collection's translated content.
Query suggestions are available in English only, and require the store's primary language (shop primary locale) and the customer's online store session (buyer locale) to be in English.

Was this page helpful?