Get Shopify search suggestions
Get a Shopify store's search suggestions across products, collections, pages, articles and queries.
Headers
Get your API keyAPI key (`sfk_...`)
The store's domain, for example `allbirds.com`, `www.allbirds.com` or `weareallbirds.myshopify.com`. A full URL is accepted and reduced to its host. Only public storefront hosts are accepted.
The partial query to suggest completions for.
min 1 chars · max 512 chars
Rows per page, 1 to 10. Default: 10.
≥ 1 · ≤ 10
ISO 3166-1 alpha-2 country used for prices, currency and language, e.g. `GB`. Default: the store's own market.
Two-letter language code, e.g. `EN`. Default: the store's own language.
Endpoint-specific response payload.
`found` on success; `not_found` when it does not exist or is not a Shopify store; `private` when the storefront is password-protected; `restricted` when the store is paused or frozen.
one of: found, not_found, private, restricted
The store host that was requested.
The partial query.
Product suggestions.
Product id; null on predictive results.
The store's global product id; null when the store does not publish it for this row.
Product handle.
Product page URL.
Product title.
Vendor.
Product type.
Tags.
Whether any variant is available.
Last update, ISO 8601 UTC.
Lowest and highest variant price. Suggestions carry no currency code, so currency is null on this route.
An amount and its currency.
The amount as a decimal number.
ISO 4217 currency code, e.g. `USD`.
An amount and its currency.
The amount as a decimal number.
ISO 4217 currency code, e.g. `USD`.
Lowest and highest compare-at price; null when the product is not on sale. Suggestions carry no currency code, so currency is null on this route.
An amount and its currency.
The amount as a decimal number.
ISO 4217 currency code, e.g. `USD`.
An amount and its currency.
The amount as a decimal number.
ISO 4217 currency code, e.g. `USD`.
The main image; null when the product has none.
Image id; null when the store does not publish it for this row.
Image URL.
Alt text the merchant set.
Pixel width.
Pixel height.
Variants the image belongs to; empty when not given.
Product body text or HTML.
Matching variants where the store lists them.
Variant id.
Variant title.
Variant price. Suggestions carry no currency code, so currency is null on this route.
The amount as a decimal number.
ISO 4217 currency code, e.g. `USD`.
Whether it is available.
Variant URL.
Variant image URL.
Collection suggestions.
Collection id; null on predictive results.
Collection handle.
Collection title.
Collection URL.
Collection body text or HTML.
Published, ISO 8601 UTC.
Collection image.
Image id; null when the store does not publish it for this row.
Image URL.
Alt text the merchant set.
Pixel width.
Pixel height.
Variants the image belongs to; empty when not given.
Page suggestions.
Page id; null on predictive results.
Page handle.
Page title.
Page URL.
Page body text or HTML.
Page author where given.
Published, ISO 8601 UTC.
Article suggestions.
Article id; null on predictive results.
Article handle.
Article title.
Article URL.
Article body text or HTML.
Article summary HTML.
Author display name.
Published, ISO 8601 UTC.
Tags.
Article image.
Image id; null when the store does not publish it for this row.
Image URL.
Alt text the merchant set.
Pixel width.
Pixel height.
Variants the image belongs to; empty when not given.
Suggested search queries.
Suggested search text.
The text with match marks.
Suggested search URL.
Notes about the answer, e.g. a requested market the store does not price in and the market it used instead.
Metadata describing the request and billing outcome.
Unique request identifier for tracing this API call.
min 1 chars
Credits charged for this request.
≥ 0
Public API version that served the response.
one of: v1
Code example
curl "https://api.socialfetch.dev/v1/shopify/search/suggest?store=www.allbirds.com&query=shirt" \
-H "x-api-key: YOUR_API_KEY"Responses
Shopify search suggestions.