InsightSocial
GET /v1/shopify/searchbeta

Shopify Search API

Search a Shopify store's products, articles and pages, with the store's facets and result count.

20 credits a call · cursor pagination · failed calls free · 10 free calls to start

curl "https://api.insightsocial.app/v1/shopify/search?store=<store>&query=<query>" \
-H "x-api-key: $INSIGHTSOCIAL_API_KEY"
200 OKJSON
{
"success": true,
"platform": "shopify",
"endpoint": "/v1/shopify/search",
"schema_version": "2",
"data": {
"<field>": "<value>"
},
"pagination": {
"next_cursor": "<string | null>",
"has_more": "<boolean>"
},
"unavailable": [],
"credits_used": "<integer>"
}

Parameters

Query parameters for GET /v1/shopify/search. Send your key in the x-api-key header.

NameRequiredDescription
storeYesThe 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.
queryYesWhat to search for in the store.
typeNoRestrict the search to product, article or page. Default: all three.
availableNoOnly products with an available variant.
price_minNoLowest product price to include.
price_maxNoHighest product price to include.
limitNoRows per page, 1 to 250. Default: 50.
countryNoISO 3166-1 alpha-2 country used for prices, currency and language, e.g. GB. Default: the store's own market.
languageNoTwo-letter language code, e.g. EN. Default: the store's own language.
cursorNoPass pagination.next_cursor from the previous response to get the next page. Keep the other parameters the same.

Response

This endpoint is beta: data holds the platform's own fields under our naming rules (snake_case keys, string ids, ISO times where the platform gives a timestamp) rather than a unified post or profile, and those fields may change.

Every field, error and example is in the Shopify Search API reference.

How much does the Shopify Search API cost?

20 credits per successful call.

  • Failed calls are free

    A call that errors or finds nothing costs 0 credits.

  • Know the price first

    Add dry_run=1 and the response quotes the call without making it. Nothing is charged.

  • One balance

    API calls and Chrome extension exports share the same credits, on the free plan too.

Shopify Search API: frequently asked questions

Send GET /v1/shopify/search with the store and query parameters and your key in the x-api-key header. Search a Shopify store's products, articles and pages, with the store's facets and result count.