> **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`). --- # Get Shopify product (https://www.socialfetch.dev/docs/api/v1/shopify/products/handle/get) ## Summary Get one Shopify product with its variants, images, collections, SEO, and stock detail where the store exposes it. **Tags:** `Shopify` ## HTTP - **Method:** GET - **Path:** `/v1/shopify/products/{handle}` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.shopify.getProduct({ store: "www.allbirds.com", handle: "mens-wool-runners" })` - **Accepted identifiers:** `handle` (path) - **Pagination:** none - **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 product 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. ### `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. ## Responses (status codes) - **200**: One Shopify product with its detail. - **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) One Shopify product with its detail. ### 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. - **product** (required) — type `object`; nullable. The product when found; null otherwise. - **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. - **min** (required) — type `object`. An amount and its currency. - **max** (required) — type `object`. An amount and its currency. - **compareAtPriceRange** (required) — type `object`; nullable. Lowest and highest compare-at price. - **min** (required) — type `object`. An amount and its currency. - **max** (required) — type `object`. An amount and its currency. - **featuredImage** (required) — type `object`; nullable. The main image; null when the product has none. - **id** (required) — type `string`; nullable. Image id; null when the store does not publish it for this row. - **url** (required) — type `string`; nullable. Image URL. - **altText** (required) — type `string`; nullable. Alt text the merchant set. - **width** (required) — type `integer`; nullable. Pixel width. - **height** (required) — type `integer`; nullable. Pixel height. - **variantIds** (required) — type `array`. Variants the image belongs to; empty when not given. - _items:_ - type `string` - **description** (required) — type `string`; nullable. Description as plain text. - **descriptionHtml** (required) — type `string`; nullable. Description as HTML; null when empty. - **isGiftCard** (required) — type `boolean`; nullable. Whether it is a gift card. - **createdAt** (required) — type `string`; nullable. Created, ISO 8601 UTC. - **publishedAt** (required) — type `string`; nullable. Published, ISO 8601 UTC. - **hasOnlyDefaultVariant** (required) — type `boolean`. True when the product has one variant titled `Default Title`. - **category** (required) — type `object`; nullable. The standard taxonomy category. - **id** (required) — type `string`; nullable. Shopify taxonomy id; null when the answer omits it. - **name** (required) — type `string`; nullable. Taxonomy name. - **seo** (required) — type `object`. The merchant's meta tags. - **title** (required) — type `string`; nullable. SEO title. - **description** (required) — type `string`; nullable. SEO description. - **options** (required) — type `array`. Product options. - _items:_ - **variants** (required) — type `array`. All variants, up to 250. - _items:_ - **images** (required) — type `array`. Product images, up to 250. - _items:_ - **media** (required) — type `array`. Images, video and 3D media. - _items:_ - **collections** (required) — type `array`. Collections the product is in. - _items:_ - **sellingPlanGroups** (required) — type `array`. Subscription groups. - _items:_ - **requiresSellingPlan** (required) — type `boolean`; nullable. Whether it can only be bought on a plan. - **templateSuffix** (required) — type `string`; nullable. The theme template the merchant assigned; null when not published. - **variantsTruncated** (required) — type `boolean`. True when the product has more than 250 variants. - **imagesTruncated** (required) — type `boolean`. True when the product has more than 250 images. - **mediaTruncated** (required) — type `boolean`. True when the product has more than 50 media items. - **stockAvailable** (required) — type `boolean`. True when the store exposes stock levels in this answer, so `inventoryQuantity` and `inventoryPolicy` are populated where it does. False means those fields are null for this answer, not that stock is zero. - **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": "www.allbirds.com", "product": { "id": "1878193471557", "gid": "gid://shopify/Product/1878193471557", "handle": "mens-wool-runners", "title": "Men's Wool Runner - Natural Grey (Light Grey Sole)", "url": "https://www.allbirds.com/products/mens-wool-runners", "vendor": "Allbirds", "productType": "Shoes", "tags": [ "allbirds::carbon-score => 7.07" ], "availableForSale": true, "updatedAt": "2026-11-04T19:39:16.000Z", "priceRange": { "min": { "amount": 110, "currency": "USD" }, "max": { "amount": 110, "currency": "USD" } }, "compareAtPriceRange": null, "featuredImage": { "id": null, "url": "https://cdn.shopify.com/s/files/1/1104/4168/files/Allbirds_WL_RN_SF_PDP_Natural_Grey_LAT.png?v=1751143404", "altText": null, "width": 1600, "height": 1600, "variantIds": [] }, "description": "The Allbirds Wool Runner is the orginal wool sneaker that started it all. Called the world's most comfortable shoe, it's flexible, supportive, astonishingly soft, and machine washable. The Wool Runner is breathable, lightweight, and can be…", "descriptionHtml": "

The Allbirds Wool Runner is the orginal wool sneaker that started it all. Called the world's most comfortable shoe, it's flexible, supportive, astonishingly soft, and machine washable. The Wool Runner is breathable, lightweight, and can…", "isGiftCard": null, "createdAt": "2018-11-12T22:25:43.000Z", "publishedAt": "2026-09-25T23:06:01.000Z", "hasOnlyDefaultVariant": false, "category": { "id": null, "name": "Shoes" }, "seo": { "title": null, "description": null }, "options": [ { "id": null, "name": "Size", "values": [ "8" ], "swatches": [] } ], "variants": [ { "id": "31338073981072", "title": "8", "sku": "WR3MNCW080", "barcode": "843416126274", "createdAt": "2020-02-25T04:15:00.000Z", "updatedAt": "2026-11-05T01:19:14.000Z", "available": false, "currentlyNotInStock": null, "price": { "amount": 110, "currency": "USD" }, "compareAtPrice": null, "options": [ { "name": "Size", "value": "8" } ], "weight": { "value": 1.872, "unit": "POUNDS" }, "requiresShipping": true, "taxable": true, "inventoryQuantity": 0, "inventoryPolicy": "deny", "inventoryManagement": "shopify", "image": { "id": null, "url": "https://cdn.shopify.com/s/files/1/1104/4168/files/Allbirds_WL_RN_SF_PDP_Natural_Grey_LAT.png?v=1751143404", "altText": null, "width": null, "height": null, "variantIds": [] }, "quantityRule": { "min": 1, "max": null, "increment": 1 }, "taxCode": "PC040144", "unitPrice": null, "unitPriceMeasurement": null, "sellingPlanAllocations": [] } ], "images": [ { "id": null, "url": "https://cdn.shopify.com/s/files/1/1104/4168/files/Allbirds_WL_RN_SF_PDP_Natural_Grey_LAT.png?v=1751143404", "altText": null, "width": 1600, "height": 1600, "variantIds": [] } ], "media": [], "collections": [ { "id": null, "handle": "shoes", "title": "Shoes" } ], "sellingPlanGroups": [], "requiresSellingPlan": null, "templateSuffix": "mens-wool-runners" }, "variantsTruncated": false, "imagesTruncated": false, "mediaTruncated": false, "stockAvailable": true, "warnings": [] }, "meta": { "requestId": "req_01example_shopify_product_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.getProduct({ handle: "mens-wool-runners", store: "www.allbirds.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/products/mens-wool-runners?store=www.allbirds.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/products/mens-wool-runners?store=www.allbirds.com" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/shopify/products/mens-wool-runners?store=www.allbirds.com", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```