TikTok Shop product API

A product's price, stock, seller, images and videos

curl --request POST \
  --url https://api.stophy.dev/v1/tiktok/shop/product \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productUrl": "<string>",
  "productId": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({productUrl: '<string>', productId: '<string>'})
};

fetch('https://api.stophy.dev/v1/tiktok/shop/product', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/tiktok/shop/product"

payload = {
    "productUrl": "<string>",
    "productId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "productUrl": "<string>",
    "price": 1,
    "imageUrls": [
      "<string>"
    ],
    "videos": [
      {
        "videoUrl": "<string>",
        "videoId": "<string>",
        "title": "<string>",
        "authorName": "<string>",
        "authorId": "<string>",
        "plays": 4503599627370495,
        "likes": 4503599627370495,
        "durationSeconds": 1
      }
    ],
    "productId": "<string>",
    "title": "<string>",
    "originalPrice": 1,
    "currency": "<string>",
    "sold": 4503599627370495,
    "rating": 1,
    "reviews": 4503599627370495,
    "stock": 4503599627370495,
    "shopId": "<string>",
    "shopName": "<string>",
    "shopUrl": "<string>",
    "shopRating": 1,
    "shopProducts": 4503599627370495,
    "shopFollowers": 4503599627370495,
    "videoUrl": "<string>",
    "videoDurationSeconds": 1
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

tiktok

shop

product

A product's price, stock, seller, images and videos

curl --request POST \
  --url https://api.stophy.dev/v1/tiktok/shop/product \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productUrl": "<string>",
  "productId": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({productUrl: '<string>', productId: '<string>'})
};

fetch('https://api.stophy.dev/v1/tiktok/shop/product', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/tiktok/shop/product"

payload = {
    "productUrl": "<string>",
    "productId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "productUrl": "<string>",
    "price": 1,
    "imageUrls": [
      "<string>"
    ],
    "videos": [
      {
        "videoUrl": "<string>",
        "videoId": "<string>",
        "title": "<string>",
        "authorName": "<string>",
        "authorId": "<string>",
        "plays": 4503599627370495,
        "likes": 4503599627370495,
        "durationSeconds": 1
      }
    ],
    "productId": "<string>",
    "title": "<string>",
    "originalPrice": 1,
    "currency": "<string>",
    "sold": 4503599627370495,
    "rating": 1,
    "reviews": 4503599627370495,
    "stock": 4503599627370495,
    "shopId": "<string>",
    "shopName": "<string>",
    "shopUrl": "<string>",
    "shopRating": 1,
    "shopProducts": 4503599627370495,
    "shopFollowers": 4503599627370495,
    "videoUrl": "<string>",
    "videoDurationSeconds": 1
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

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.

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);

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"])

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"}'

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.

{
  "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.

TikTok Shop products: Accepts shopUrl. Returns a seller’s products, name, rating and sales.
TikTok Shop reviews: Accepts productUrl. Returns the first page of a product’s reviews.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

productUrl

string

Link to the TikTok Shop product, like https://shop.tiktok.com/us/pdp/p/1729592969712207012. Send this or productId.

productId

string

TikTok Shop product id, like 1729592969712207012. Send this or productUrl.

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

TikTok Shop product API

Request

Response

Billing

Authorizations

Body

Response

​Request

​Response

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Billing

Pagination

Related methods