Get Shopify collection
Get one Shopify collection with its filter facets and counts.
Headers
Get your API keyAPI key (`sfk_...`)
The collection handle, as it appears in its URL.
min 1 chars · max 255 chars · pattern: ^[^\s/?#]+$
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.
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 collection when found; null otherwise.
Numeric collection id as a string.
The store's global collection id; null when the store does not publish it for this row.
Collection handle.
Collection title.
Collection page URL.
Description as plain text.
Description as HTML.
The merchant's meta tags.
SEO title.
SEO description.
Collection image; null when 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.
Last update, ISO 8601 UTC.
Number of products; null when the store does not share it.
The store's 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.
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/collections/general-clothes-example-products?store=000000band.myshopify.com" \
-H "x-api-key: YOUR_API_KEY"Responses
One Shopify collection with its filter facets.