> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). The sections below mirror the orientation block in [`/llms.txt`](https://www.socialfetch.dev/llms.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need a structured operation inventory. The catalog covers documented operations with on-site reference pages. ## This page - **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/tiktok/shop/products/search/get](https://www.socialfetch.dev/docs/api/v1/tiktok/shop/products/search/get) - **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/tiktok/shop/products/search/get.mdx](https://www.socialfetch.dev/docs/api/v1/tiktok/shop/products/search/get.mdx) ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` 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:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/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()`. - [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users. - [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage. - [`/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`). --- # Search TikTok Shop products (https://www.socialfetch.dev/docs/api/v1/tiktok/shop/products/search/get) ## Summary Returns product cards for a TikTok Shop catalog search. Pass a `query` string and optional `page` (1-based) and `region` code. Pagination is page-based; `data.page.hasMore` indicates whether another page can be requested. **Tags:** `TikTok` ## HTTP - **Method:** GET - **Path:** `/v1/tiktok/shop/products/search` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.tiktok.searchShopProducts({ query, page?, region? })` - **Pagination:** none ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Normalization failure (502):** 1 credit charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `query` (query) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 512 - **Description:** Search query text for TikTok Shop products. ### `page` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1 - **Description:** 1-based results page number. Omit to request the first page. Pagination is page-based. ### `region` (query) - **Required:** no - **Constraints:** type `string`; enum: US, GB, DE, FR, IT, ID, MY, MX, PH, SG, ES, TH, VN, BR, JP, IE - **Description:** Optional country or region code for the product search catalog. ## Behavior notes - **`region`**: Optional country or region code for the product search catalog. ## Responses (status codes) - **200**: Product search results for the requested page. - **400**: Invalid query parameters - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed from the response (unexpected or invalid data). - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) Product search results for the requested page. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **query** (required) — type `string`. Search query that was evaluated for this response. - **products** (required) — type `array`. Products returned for the requested page. - _items:_ - **id** (required) — type `string`; minLength: 1. TikTok Shop product identifier. - **title** (required) — type `string`; minLength: 1. Product title text. - **description** (required) — type `string`; nullable. Product description, when available. - **url** (required) — type `string`; minLength: 1; nullable. Canonical public URL for the product page, when available. - **imageUrl** (required) — type `string`; minLength: 1; nullable. Primary product image URL, when available. - **image** (optional) — type `object`; nullable. Structured image size metadata when the image URL is available. - **width** (required) — type `integer`; minimum: 0; nullable. Image width in pixels, when available. - **height** (required) — type `integer`; minimum: 0; nullable. Image height in pixels, when available. - **url** (required). Primary product image URL. - **shipFrom** (required) — type `string`; nullable. Reported ship-from location text, when available. - **trustLabel** (required) — type `string`; nullable. TikTok Shop trust badge label, when available. - **labels** (required) — type `array`. Promotional, shipping, and trust labels for the product card. - _items:_ - **text** (required) — type `string`. Label text shown for the product. - **type** (required) — type `integer`; nullable. TikTok Shop label type code, when available. - **price** (required) — type `object`. Displayed price data. - **currencyCode** (required) — type `string`; nullable. Currency name or code for displayed prices, when available. - **currencySymbol** (required) — type `string`; nullable. Currency symbol for the listed price, when available. - **current** (required) — type `string`; nullable. Current sale price for the product, when available. - **original** (required) — type `string`; nullable. Original or list price before discount, when available. - **discountText** (required) — type `string`; nullable. Human-readable discount label, when available. - **savingText** (required) — type `string`; nullable. Human-readable savings line, when available. - **metrics** (required) — type `object`. Rating and sales metrics for the product. - **sold** (required) — type `integer`; minimum: 0; nullable. Approximate units sold, when available. - **reviews** (required) — type `integer`; minimum: 0; nullable. Number of product reviews, when available. - **rating** (required) — type `number`; minimum: 0; nullable. Average product rating, when available. - **shop** (required) — type `object`. Selling shop for the product. - **id** (required) — type `string`; nullable. TikTok Shop seller identifier, when available. - **name** (required) — type `string`; nullable. Shop display name, when available. - **logoUrl** (required) — type `string`; nullable. Shop logo image URL, when available. - **totalProducts** (required) — type `integer`; minimum: 0. Total matching products reported for the search, when available. - **page** (required) — type `object`. Pagination state for the current response. - **currentPage** (required) — type `integer`; minimum: 1. 1-based page number for this response. - **nextPage** (required) — type `integer`; minimum: 1; nullable. Next page number to request when more results are available; otherwise null. - **hasMore** (required) — type `boolean`. Whether more product pages are likely available for this search. - **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 (sample) ```json { "data": { "query": "shoes", "totalProducts": 100, "products": [ { "id": "1730213444857467838", "title": "Crocs Adult Classic Clogs", "description": null, "url": "https://www.tiktok.com/shop/pdp/example/1730213444857467838", "imageUrl": "https://p16.example.com/image.webp", "image": { "width": 400, "height": 400, "url": "https://p16.example.com/image.webp" }, "shipFrom": "Fontana, CA", "trustLabel": "gold", "labels": [ { "text": "Free shipping", "type": 8 } ], "price": { "currencyCode": "USD", "currencySymbol": "$", "current": "49.99", "original": "59.99", "discountText": "15%", "savingText": "Saving $10.00" }, "metrics": { "sold": 24737, "reviews": 2493, "rating": 4.8 }, "shop": { "id": "7495832567110863806", "name": "Crocs", "logoUrl": "https://p16.example.com/logo.png" } } ], "page": { "currentPage": 1, "nextPage": 2, "hasMore": true } }, "meta": { "requestId": "req_01example", "creditsCharged": 1, "version": "v1" } } ``` ### Example JSON (empty) ```json { "data": { "query": "zzzzimprobablequery", "totalProducts": 0, "products": [], "page": { "currentPage": 1, "nextPage": null, "hasMore": false } }, "meta": { "requestId": "req_01example_empty", "creditsCharged": 1, "version": "v1" } } ``` ### Example JSON (sparse) ```json { "data": { "query": "tshirt", "totalProducts": 2, "products": [ { "id": "1729505304355116874", "title": "Sample product with missing rating data", "description": null, "url": "https://www.tiktok.com/shop/pdp/1729505304355116874", "imageUrl": "https://p16.example.com/p.webp", "image": { "width": 400, "height": 400, "url": "https://p16.example.com/p.webp" }, "shipFrom": null, "trustLabel": null, "labels": [], "price": { "currencyCode": "USD", "currencySymbol": "$", "current": "16.00", "original": "39.98", "discountText": "60%", "savingText": "Saving $23.98" }, "metrics": { "sold": 16, "reviews": null, "rating": null }, "shop": { "id": "7494469722151290698", "name": "example-shop", "logoUrl": null } } ], "page": { "currentPage": 1, "nextPage": null, "hasMore": false } }, "meta": { "requestId": "req_01example_sparse", "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 query parameters **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 from the response (unexpected or invalid data). **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.tiktok.searchShopProducts({ query: "shoes", }); 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/tiktok/shop/products/search?query=shoes", { headers: { "x-api-key": "YOUR_API_KEY", } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/tiktok/shop/products/search?query=shoes" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/tiktok/shop/products/search?query=shoes", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ``` ### Example: optional query parameters First request illustrating common optional query flags (adjust values to your integration): ```javascript const url = "https://api.socialfetch.dev/v1/tiktok/shop/products/search?region=US"; const response = await fetch(url, { headers: { "x-api-key": "YOUR_API_KEY" }, }); const data = await response.json(); ```