> ## Documentation Index > Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt > Use this file to discover all available pages before exploring further. # TikTok Shop product API > A product's price, stock, seller, images and videos. Call the TikTok Shop product API for JSON. 1 credit per call. Every call returns the same flat shape. Returns a product's price, stock, seller, images and videos. The product is identified by its URL or ID. ## Request Exactly one of `productUrl` or `productId` is required. A request that sets both, or none, fails with `invalidRequest`. ```typescript TypeScript icon="https://mintlify.s3.us-west-1.amazonaws.com/sirathic/images/icons/typescript.svg" theme={null} theme={null} import { Stophy } from "stophy"; const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY }); const result = await stophy.tiktok.shop.product({ productUrl: "https://shop.tiktok.com/us/pdp/p/1729592969712207012" }); console.log(result.data); ``` ```python Python icon="python" theme={null} theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.tiktok.shop.product(product_url="https://shop.tiktok.com/us/pdp/p/1729592969712207012") print(result["data"]) ``` ```bash cURL icon="terminal" theme={null} theme={null} curl -X POST https://api.stophy.dev/v1/tiktok/shop/product \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"productUrl":"https://shop.tiktok.com/us/pdp/p/1729592969712207012"}' ``` ```bash CLI icon="square-terminal" theme={null} theme={null} stophy tiktok shop product --productUrl https://shop.tiktok.com/us/pdp/p/1729592969712207012 ``` ## Response If successful, the response body contains the standard envelope. `data` contains the product's price, stock, seller and images. The following example is a real response, truncated: each list shows one item and long strings are cut. ```json theme={null} { "success": true, "data": { "productId": "1732195217319498354", "title": "GummyGlow Brand New Upgrade Fruity Wax Gummies, 12oz Party-Ready Pack - 5 Sour Flavors, Crunchy ASMR Sweet Snacks,…", "productUrl": "https://shop.tiktok.com/us/pdp/p/1732195217319498354", "price": 19.47, "originalPrice": 24.98, "currency": "USD", "sold": 28642, "rating": 4, "reviews": 2956, "stock": 3226, "shopId": "7496048947258165874", "shopName": "Gummy Glow", "shopUrl": "https://shop.tiktok.com/us/store/gummy-glow/7496048947258165874", "shopRating": 3.9, "shopProducts": 19, "shopFollowers": 9393, "imageUrls": ["https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/f70c619f11344b7f9b43c50925bc731e~tplv-fhlh96ny…"] }, "creditsUsed": 1, "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b" } ``` | Field | Type | Description | | - | - | - | | `rating` | number | The average star rating, on a scale of 1 to 5. | | `reviews` | integer | The number of reviews the rating is based on. | | `sold` | integer | The number of units sold. | For every field, see the response schema on this page. ## Billing Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed. ## Pagination This method is not paginated. A single request returns the complete result. ## Related methods * [TikTok Shop products](/api-reference/endpoint/tiktok-shop-products): Accepts `shopUrl`. Returns a seller's products, name, rating and sales. * [TikTok Shop reviews](/api-reference/endpoint/tiktok-shop-reviews): Accepts `productUrl`. Returns the first page of a product's reviews. ## OpenAPI ````yaml api-reference/openapi.json POST /v1/tiktok/shop/product openapi: 3.1.0 info: title: Stophy API version: '1' description: >- Every endpoint is a POST that takes its input as a JSON object body. Unknown fields are rejected with 400. Responses leave out empty values: null, empty strings, empty objects and empty nested lists are not sent. x-credits is what one call costs. Every call costs the same, whatever it returns, unless an operation's description says it costs per 10 results, or per second of audio. Then x-credits is the lowest price and x-credits-max the most one call can cost. Where an operation takes limit, send it to return fewer results and pay for fewer. When a response has a cursor, send it back unchanged with the same input to get the next page. When it has a page, send the next page number. servers: - url: https://api.stophy.dev security: - apiKey: [] paths: /v1/tiktok/shop/product: post: summary: A product's price, stock, seller, images and videos description: Costs 1 credit per call. operationId: tiktokShopProduct requestBody: required: true content: application/json: schema: type: object properties: productUrl: type: string description: >- Link to the TikTok Shop product, like https://shop.tiktok.com/us/pdp/p/1729592969712207012. Send this or productId. productId: type: string description: >- TikTok Shop product id, like 1729592969712207012. Send this or productUrl. sendOne: - productUrl - productId additionalProperties: false responses: '200': description: The data, and the credits this call used. headers: X-Request-ID: $ref: '#/components/headers/RequestId' x-credits-used: $ref: '#/components/headers/CreditsUsed' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' x-cache: $ref: '#/components/headers/Cache' x-cache-age: $ref: '#/components/headers/CacheAge' content: application/json: schema: type: object required: - success - data - creditsUsed - requestId properties: success: const: true data: type: object additionalProperties: false properties: productId: type: string title: type: string productUrl: type: string format: uri price: type: number minimum: 0 originalPrice: type: number minimum: 0 currency: type: string pattern: ^[A-Z]{3}$ description: ISO 4217 currency code, e.g. USD. sold: type: integer minimum: 0 maximum: 9007199254740991 rating: type: number minimum: 0 reviews: type: integer minimum: 0 maximum: 9007199254740991 stock: type: integer minimum: 0 maximum: 9007199254740991 shopId: type: string shopName: type: string shopUrl: type: string format: uri shopRating: type: number minimum: 0 shopProducts: type: integer minimum: 0 maximum: 9007199254740991 shopFollowers: type: integer minimum: 0 maximum: 9007199254740991 imageUrls: type: array items: type: string format: uri videoUrl: type: string format: uri videoDurationSeconds: type: number minimum: 0 videos: type: array items: type: object additionalProperties: false properties: videoId: type: string videoUrl: type: string format: uri title: type: string authorName: type: string authorId: type: string plays: type: integer minimum: 0 maximum: 9007199254740991 likes: type: integer minimum: 0 maximum: 9007199254740991 durationSeconds: type: number minimum: 0 required: - videoUrl required: - productUrl - price - imageUrls - videos creditsUsed: type: integer requestId: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' components: headers: RequestId: description: The request id. Quote it when you report a problem. schema: type: string CreditsUsed: description: Credits this call used. schema: type: integer RateLimitLimit: description: Requests allowed in the current window. schema: type: integer RateLimitRemaining: description: Requests left in the current window. schema: type: integer RateLimitReset: description: Unix time in seconds when the current window resets. schema: type: integer Cache: description: hit if this result came from the cache, miss if it was fetched live. schema: type: string CacheAge: description: Seconds since the returned result was written to the cache. schema: type: integer RetryAfter: description: Seconds to wait before retrying. schema: type: integer responses: Error: description: The request failed. retryable says whether trying again can help. headers: X-Request-ID: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object required: - success - error properties: success: const: false error: type: object required: - code - message - retryable - requestId properties: code: type: string enum: - cliSessionCompleted - cliSessionExists - cliSessionNotFound - forbidden - insufficientCredits - internalError - inviteClaimed - inviteDisabled - inviteExpired - inviteUsedUp - invalidCliSession - invalidCliVerifier - invalidRequest - notFound - rateLimited - sourceChanged - sourceRefused - sourceTimeout - sourceUnavailable - tooManyInFlight - unauthorized - unsupportedMediaType message: type: string retryable: type: boolean retryAfterSeconds: type: integer requestId: type: string requiredCredits: type: number availableCredits: type: number billingUrl: type: string const: https://stophy.dev/billing securitySchemes: apiKey: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.