InsightSocial
GET /v1/shopify/collectionbeta

Shopify Collection API

Get one Shopify collection with its filter facets and counts.

20 credits a call · single call · failed calls free · 10 free calls to start

curl "https://api.insightsocial.app/v1/shopify/collection?handle=<handle>&store=<store>" \
-H "x-api-key: $INSIGHTSOCIAL_API_KEY"
200 OKJSON
{
"success": true,
"platform": "shopify",
"endpoint": "/v1/shopify/collection",
"schema_version": "2",
"data": {
"<field>": "<value>"
},
"unavailable": [],
"credits_used": "<integer>"
}

Parameters

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

NameRequiredDescription
handleYesThe collection handle, as it appears in its URL.
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.
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.

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 Collection API reference.

How much does the Shopify Collection 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 Collection API: frequently asked questions

Send GET /v1/shopify/collection with the handle and store parameters and your key in the x-api-key header. Get one Shopify collection with its filter facets and counts.