Search Shopify store
Search a Shopify store's products, articles and pages, with the store's facets and result count.
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.
What to search for in the store.
min 1 chars · max 512 chars
Restrict the search to `product`, `article` or `page`. Default: all three.
one of: product, article, page
Only products with an available variant.
Lowest product price to include.
≥ 0 · ≤ 1000000000
Highest product price to include.
≥ 0 · ≤ 1000000000
Rows per page, 1 to 250. Default: 50.
≥ 1 · ≤ 250
Cursor from `page.nextCursor` of the previous response. It only works with the same filters.
min 1 chars · max 4096 chars
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 query that was searched.
The result types that were searched.
any of: product, article, page (comma-separated)
one of: product, article, page
Matching results.
True when the store's own count is capped at 1000.
Product hits.
Product id; null when the answer omits it.
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.
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.
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.
Article hits.
Numeric article id as a string.
Article handle.
Article title.
Article URL.
Excerpt.
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.
Page hits.
Numeric page id as a string.
Page handle.
Page title.
Page URL.
Page summary.
Updated, ISO 8601 UTC.
The store's product filter facets with counts.
Filter id.
Label.
`LIST`, `PRICE_RANGE` or `BOOLEAN`.
How the store presents it, e.g. `TEXT`.
Facet values.
Filter value id.
Label.
Matching products.
The store's own filter input as JSON, e.g. `{"available":true}`.
Colour swatch where given.
Hex colour.
Pagination state for the current page.
Whether another page is available.
Cursor for the next page; null on the last page.
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?store=www.allbirds.com&query=shirt" \
-H "x-api-key: YOUR_API_KEY"Responses
Shopify search results and facets.