TikTok Shop products API

A seller's products, name, rating and sales

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

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

fetch('https://api.stophy.dev/v1/tiktok/shop/products', 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/products"

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

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "productUrl": "<string>",
        "price": 1,
        "productId": "<string>",
        "title": "<string>",
        "originalPrice": 1,
        "currency": "<string>",
        "sold": 4503599627370495,
        "rating": 1,
        "reviews": 4503599627370495,
        "imageUrl": "<string>",
        "shopId": "<string>",
        "shopName": "<string>"
      }
    ],
    "shopId": "<string>",
    "shopName": "<string>",
    "rating": 1,
    "sold": 4503599627370495,
    "products": 4503599627370495,
    "reviews": 4503599627370495,
    "followers": 4503599627370495,
    "shopUrl": "<string>",
    "cursor": "<string>"
  },
  "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

products

A seller's products, name, rating and sales

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

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

fetch('https://api.stophy.dev/v1/tiktok/shop/products', 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/products"

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

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "productUrl": "<string>",
        "price": 1,
        "productId": "<string>",
        "title": "<string>",
        "originalPrice": 1,
        "currency": "<string>",
        "sold": 4503599627370495,
        "rating": 1,
        "reviews": 4503599627370495,
        "imageUrl": "<string>",
        "shopId": "<string>",
        "shopName": "<string>"
      }
    ],
    "shopId": "<string>",
    "shopName": "<string>",
    "rating": 1,
    "sold": 4503599627370495,
    "products": 4503599627370495,
    "reviews": 4503599627370495,
    "followers": 4503599627370495,
    "shopUrl": "<string>",
    "cursor": "<string>"
  },
  "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 seller’s products, name, rating and sales. The shop is identified by its URL or ID.

Request

Exactly one of shopUrl or shopId 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.products({ shopUrl: "https://shop.tiktok.com/us/store/shop/7495291731420235534" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.tiktok.shop.products(shop_url="https://shop.tiktok.com/us/store/shop/7495291731420235534")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/tiktok/shop/products \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"shopUrl":"https://shop.tiktok.com/us/store/shop/7495291731420235534"}'

stophy tiktok shop products --shopUrl https://shop.tiktok.com/us/store/shop/7495291731420235534

Response

If successful, the response body contains the standard envelope. data contains the shop’s name, rating and sales, and results lists its products. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "shopId": "7496048947258165874",
    "shopName": "Gummy Glow",
    "rating": 3.9,
    "sold": 65117,
    "products": 19,
    "reviews": 7154,
    "followers": 9393,
    "shopUrl": "https://www.tiktok.com/shop/store/gummy-glow/7496048947258165874",
    "results": [
      {
        "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/fruitywax-bear-candy-12oz-pack-5-flavors-retro-party-treats/1732195217319498354",
        "price": 19.47,
        "currency": "USD",
        "sold": 28642,
        "rating": 4,
        "reviews": 2956,
        "imageUrl": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/f70c619f11344b7f9b43c50925bc731e~tplv-fhlh96ny…",
        "shopId": "7496048947258165874",
        "shopName": "Gummy Glow"
      }
    ]
  },
  "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.

Optional parameters

Parameter	Type	Description
`cursor`	string	The pagination token from the previous response.

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

Results are paginated. To retrieve the next page, pass the value of data.cursor as cursor in a subsequent request. A response that omits cursor is the last page.

TikTok Shop product: Accepts productUrl. Returns a product’s price, stock, seller, images and videos.
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

shopUrl

string

Link to the TikTok Shop store, like https://shop.tiktok.com/us/store/shop/7495291731420235534. Send this or shopId.

shopId

string

TikTok Shop store id, like 7495291731420235534. Send this or shopUrl.

cursor

string

The cursor from the previous response. Send it as is.

Minimum string length: 1

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 products API

Request

Response

Optional parameters

Billing

Authorizations

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods