> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration. ## This page - **On-site (HTML):** - **Markdown (.mdx) URL:** ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route). - **OpenAPI JSON:** ## Recommended docs entrypoints (this site) - [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown). - [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope. - [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages. - [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples. - [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths. - [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install. - [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help. - [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples. - [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start. - [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog. - [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI). - [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls). - [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist. - [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping. - [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages. - [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance. - [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs. - Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract. ## Markdown docs convention - Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`). - Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`). - Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`). --- # List Shopify collection products (https://www.socialfetch.dev/docs/api/v1/shopify/collections/handle/products/get) ## Summary List the products in a Shopify collection with filters, sorting and cursor paging. **Tags:** `Shopify` ## HTTP - **Method:** GET - **Path:** `/v1/shopify/collections/{handle}/products` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.shopify.listCollectionProducts({ store: "000000band.myshopify.com", handle: "general-clothes-example-products" })` - **Accepted identifiers:** `handle` (path) - **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore` - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`, `private`, `restricted` ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Failed requests (`lookup_failed`, `503`):** not charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `handle` (path) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 255; pattern: `^[^\s/?#]+$` - **Description:** The collection handle, as it appears in its URL. ### `store` (query) - **Required:** yes - **Constraints:** type `string` - **Description:** 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. ### `sort` (query) - **Required:** no - **Constraints:** type `string`; enum: collection_default, best_selling, created, price, title - **Description:** `collection_default`, `best_selling`, `created`, `price` or `title`. A collection cannot be ordered by vendor or product type on Shopify; filter on them instead. ### `reverse` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Reverse the sort order. ### `available` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Only products with an available variant. ### `priceMin` (query) - **Required:** no - **Constraints:** type `number`; minimum: 0; maximum: 1000000000 - **Description:** Lowest price to include. ### `priceMax` (query) - **Required:** no - **Constraints:** type `number`; minimum: 0; maximum: 1000000000 - **Description:** Highest price to include. ### `productType` (query) - **Required:** no - **Constraints:** type `string`; maxLength: 255 - **Description:** Product type. ### `vendor` (query) - **Required:** no - **Constraints:** type `string`; maxLength: 255 - **Description:** The product vendor to filter by. ### `tag` (query) - **Required:** no - **Constraints:** type `string`; maxLength: 255 - **Description:** The product tag to filter by. ### `limit` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 250 - **Description:** Rows per page, 1 to 250. Default: 50. ### `cursor` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 4096 - **Description:** Cursor from `page.nextCursor` of the previous response. It only works with the same filters. ### `country` (query) - **Required:** no - **Constraints:** type `string` - **Description:** ISO 3166-1 alpha-2 country used for prices, currency and language, e.g. `GB`. Default: the store's own market. ### `language` (query) - **Required:** no - **Constraints:** type `string` - **Description:** Two-letter language code, e.g. `EN`. Default: the store's own language. ## Pagination This endpoint uses **cursor-based pagination** via the `cursor` query parameter. - Read **hasMore** from `data.page.hasMore`. - When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string). - Omit `cursor` on the **first** request. - Stop when **hasMore** is `false` or **nextCursor** is null (end of list). ## Responses (status codes) - **200**: Shopify collection products with filter facets. - **400**: Invalid request - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed. - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) Shopify collection products with filter facets. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found, private, restricted. `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. - **store** (required) — type `string`. The store host that was requested. - **collection** (required) — type `object`; nullable. The collection when found; null otherwise. - **id** (required) — type `string`. Collection id. - **handle** (required) — type `string`. Collection handle. - **title** (required) — type `string`; nullable. Collection title. - **products** (required) — type `array`. Products on this page. - _items:_ - **id** (required) — type `string`. Numeric product id as a string. - **gid** (required) — type `string`; nullable. The store's global product id; null when the store does not publish it for this row. - **handle** (required) — type `string`. Product handle. - **url** (required) — type `string`; nullable. Product page URL. - **title** (required) — type `string`. Product title. - **vendor** (required) — type `string`; nullable. Vendor. - **productType** (required) — type `string`; nullable. Product type. - **tags** (required) — type `array`. Tags. - _items:_ - type `string` - **availableForSale** (required) — type `boolean`; nullable. Whether any variant is available. - **updatedAt** (required) — type `string`; nullable. Last update, ISO 8601 UTC. - **priceRange** (required) — type `object`; nullable. Lowest and highest variant price. - **compareAtPriceRange** (required) — type `object`; nullable. Lowest and highest compare-at price. - **featuredImage** (required) — type `object`; nullable. The main image; null when the product has none. - **filters** (required) — type `array`. The collection's filter facets. - _items:_ - **id** (required) — type `string`. Filter id. - **label** (required) — type `string`. Label. - **type** (required) — type `string`. `LIST`, `PRICE_RANGE` or `BOOLEAN`. - **presentation** (required) — type `string`; nullable. How the store presents it, e.g. `TEXT`. - **values** (required) — type `array`. Facet values. - _items:_ - **page** (required) — type `object`. Pagination state for the current page. - **hasMore** (required) — type `boolean`. Whether another page is available. - **nextCursor** (required) — type `string`; nullable. Cursor for the next page; null on the last page. - **warnings** (optional) — type `array`. Notes about the answer, e.g. a requested market the store does not price in and the market it used instead. - _items:_ - type `string` - **meta** (required) — type `object`. Metadata describing the request and billing outcome. - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call. - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request. - **version** (required) — type `string`; enum: v1. Public API version that served the response. ### Example JSON (found) ```json { "data": { "lookupStatus": "found", "store": "000000band.myshopify.com", "collection": { "id": "", "handle": "general-clothes-example-products", "title": null }, "products": [ { "id": "10282954260802", "gid": "gid://shopify/Product/10282954260802", "handle": "000000-hoodie", "title": "#000000 hoodie", "url": "https://000000band.myshopify.com/products/000000-hoodie", "vendor": "000000", "productType": "T-SHIRT", "tags": [], "availableForSale": true, "updatedAt": "2026-08-28T22:14:32.000Z", "priceRange": { "min": { "amount": 50, "currency": "USD" }, "max": { "amount": null, "currency": null } }, "compareAtPriceRange": null, "featuredImage": { "id": null, "url": "https://cdn.shopify.com/s/files/1/0999/1559/6098/files/unisex-premium-pullover-hoodie-black-front-69cc424d9c9bc.jpg?v=1774994019", "altText": null, "width": null, "height": null, "variantIds": [] } } ], "filters": [], "page": { "hasMore": false, "nextCursor": null }, "warnings": [] }, "meta": { "requestId": "req_01example_shopify_collection_products_openapi_200_example", "creditsCharged": 1, "version": "v1" } } ``` ### Machine-readable error codes When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime): - `bad_request` ## Error handling & retries Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status. - **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help. - **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help. - **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help). - **500**: Unexpected or billing error - **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable. - **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter. ### Suggested client defaults - Send the API key using the `x-api-key` header on every request. - On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user. - On `402`, surface an actionable billing message rather than blind retries. ## Examples ### TypeScript SDK ```typescript import { SocialFetchClient } from "@socialfetch/sdk"; const client = new SocialFetchClient({ apiKey: process.env.SOCIALFETCH_API_KEY!, }); const result = await client.shopify.listCollectionProducts({ handle: "general-clothes-example-products", store: "000000band.myshopify.com", }); if (!result.ok) { console.error(result.error); } else { console.log(result.value.data); } ``` ### Node.js ```javascript const response = await fetch( "https://api.socialfetch.dev/v1/shopify/collections/general-clothes-example-products/products?store=000000band.myshopify.com", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/shopify/collections/general-clothes-example-products/products?store=000000band.myshopify.com" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/shopify/collections/general-clothes-example-products/products?store=000000band.myshopify.com", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ``` ### Example: next page (pagination) After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string): ```javascript const previous = await response.json(); const nextCursor = previous?.data?.page?.nextCursor; const hasMore = previous?.data?.page?.hasMore; if (!hasMore || nextCursor == null) { // no more pages } else { const nextUrl = new URL("https://api.socialfetch.dev/v1/shopify/collections/charlidamelio/products"); nextUrl.searchParams.set("cursor", nextCursor); // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest"); const nextResponse = await fetch(nextUrl.toString(), { headers: { "x-api-key": "YOUR_API_KEY" }, }); const nextData = await nextResponse.json(); } ```