TikTok Shop products of a shop API
Every product of one shop; `parent` is the shop's profile (first page).
GET /v1/tiktok/shop/products
GET /v1/tiktok/shop/products
Every product of one shop; parent is the shop's profile (first page). 20 products a page in TikTok's own order, which puts a shop's best sellers first. sort=new_releases reads the whole catalogue (up to 120 products) and orders it newest first by product id, so it ignores the cursor and returns one page. US catalogue only.
- Cost: 1 credit
- Cache: Results are kept up to 30 days; send
max_age_daysto reuse them for free. - Timeout: A request still running after about 25 seconds answers
202with a job to poll (Batch and jobs).
Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
url | URL | yes | Shop URL (tiktok.com/shop/store/<name>/<id>). Accepted hosts: tiktok.com. |
sort | string | no | Order of results. Changing it restarts the cursor chain. One of top, new_releases. Default top. Also accepted as sort_by, sortBy, order. |
Every request also accepts:
cursor: the cursor from the previous page (Pagination).region: two-letter country code for results that vary by country. Changing it restarts the cursor chain.trim:truefor a smaller response withoutnullfields andextra.raw:trueto also get the platform's original object asraw.max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).
Example request#
Set your key in the environment first (see Authentication).
1curl -G "https://api.socialscrape.dev/v1/tiktok/shop/products" \2 -H "x-api-key: $SOCIALSCRAPE_API_KEY" \3 --data-urlencode "url=https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079"1import os2import requests34params = {5 "url": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079",6}7res = requests.get(8 "https://api.socialscrape.dev/v1/tiktok/shop/products",9 headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},10 params=params,11)12body = res.json()1314if body["ok"]:15 print(body["data"])16else:17 print(body["error"]["code"], body["error"]["message"])1const url = new URL("https://api.socialscrape.dev/v1/tiktok/shop/products");2url.search = new URLSearchParams({3 "url": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079"4}).toString();5const res = await fetch(url, {6 headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },7});8const body = await res.json();910if (body.ok) {11 console.log(body.data);12} else {13 console.error(body.error.code, body.error.message);14}1{2 "nodes": [3 {4 "name": "SocialScrape TikTok Shop products of a shop",5 "type": "n8n-nodes-base.httpRequest",6 "typeVersion": 4.2,7 "position": [8 0,9 010 ],11 "parameters": {12 "method": "GET",13 "url": "https://api.socialscrape.dev/v1/tiktok/shop/products",14 "sendQuery": true,15 "queryParameters": {16 "parameters": [17 {18 "name": "url",19 "value": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079"20 }21 ]22 },23 "sendHeaders": true,24 "headerParameters": {25 "parameters": [26 {27 "name": "x-api-key",28 "value": "={{ $env.SOCIALSCRAPE_API_KEY }}"29 }30 ]31 }32 }33 }34 ],35 "connections": {}36}Example response#
This is a sample from a recorded response, lists and long text are shortened, dash characters in the text are replaced with hyphens. Status 200.
1{2 "ok": true,3 "credits_charged": 1,4 "credits_remaining": 4999,5 "cached": false,6 "cached_at": null,7 "request_id": "req_b0074802ede3c6d7f03c29f6",8 "data": {9 "object": "list",10 "items": [11 {12 "object": "product",13 "platform": "tiktok",14 "id": "1729527313880355335",15 "url": "https://www.tiktok.com/shop/pdp/ashwagandha-gummies-by-goli-ksm-66-mixed-berry-vegan-non-gmo/1729527313880355335",16 "title": "Goli Ashwagandha & Vitamin D Gummy - Mixed Berry, KSM-66, Vegan, Plant Based, Non-GMO, Gluten-Free & Gelatin Free. America's #1 Ashwagandha Brand",17 "description": null,18 "price": {19 "amount": 19.47,20 "currency": "USD",21 "original_amount": 24.7,22 "display": "$19.47"23 },24 "seller": {25 "id": "7495794203056835079",26 "handle": null,27 "name": "Goli Nutrition",28 "url": null,29 "avatar_url": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/e7478d3e93d4487a9e772fa74e10f506~tplv-fhlh96nyum-resize-png:300:300.png?dr=12184&t=555f072d&ps=933b5bde&shp=905da467&shcp=d9d491bf&idc=useast5&from=2422056039",30 "verified": null31 },32 "rating": 4.5,33 "review_count": 94470,34 "sold_count": 1306215,35 "image_urls": [36 "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/2bc69aa9f6084480beee1bb4a8db3a69~tplv-fhlh96nyum-crop-webp:1500:1500.webp?dr=12190&t=555f072d&ps=933b5bde&shp=8dbd94bf&shcp=a6e80448&idc=useast5&from=2378011839"37 ],38 "category": null,39 "in_stock": null,40 "location": null,41 "published_at": null,42 "extra": {43 "brand": "Goli",44 "discount": "21%",45 "labels": [46 "Free shipping"47 ],48 "sku_id": "1729527298861535751"49 }50 },51 {52 "object": "product",53 "platform": "tiktok",54 "id": "1731194857673101831",55 "url": "https://www.tiktok.com/shop/pdp/zero-sugar-best-seller-trio-goli-ashwagandha-gummies-vegan-non-gmo/1731194857673101831",56 "title": "Goli Zero Sugar Best Seller Trio - Daily Gut & Wellness Support with Pre, Post & Probiotics, Apple Cider Vinegar, Ashwagandha & L-Theanine Gummies",57 "description": null,58 "price": {59 "amount": 49.37,60 "currency": "USD",61 "original_amount": 74.1,62 "display": "$49.37"63 },64 "seller": {65 "id": "7495794203056835079",66 "handle": null,67 "name": "Goli Nutrition",68 "url": null,69 "avatar_url": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/e7478d3e93d4487a9e772fa74e10f506~tplv-fhlh96nyum-resize-png:300:300.png?dr=12184&t=555f072d&ps=933b5bde&shp=905da467&shcp=d9d491bf&idc=useast5&from=2422056039",70 "verified": null71 },72 "rating": 4.4,73 "review_count": 49061,74 "sold_count": 1041805,75 "image_urls": [76 "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/02f1b939f53d400998099bfad0f85a14~tplv-fhlh96nyum-crop-webp:3000:3000.webp?dr=12190&t=555f072d&ps=933b5bde&shp=8dbd94bf&shcp=a6e80448&idc=useast5&from=2378011839"77 ],78 "category": null,79 "in_stock": null,80 "location": null,81 "published_at": null,82 "extra": {83 "brand": "Goli",84 "discount": "33%",85 "labels": [86 "Free shipping"87 ],88 "sku_id": "1731194889857176071"89 }90 }91 ],92 "cursor": "eyJzIjoiNzQ5NTc5NDIwMzA1NjgzNTA3OSIsInNwIjoiMjBfV3pNM05qUXpMRFUzTURBd01EQXdMREUzTkRjek16TTNNRFF6TURBc0lqRTNNekV4TnpNM01ETTBOelU1TlRneU56a2lYUT09IiwibyI6MjB9",93 "has_more": true,94 "parent": {95 "object": "profile",96 "platform": "tiktok",97 "id": "7495794203056835079",98 "handle": null,99 "name": "Goli Nutrition",100 "headline": null,101 "url": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079",102 "kind": "shop",103 "bio": "Shop Goli Nutrition on TikTok Shop! 5.8M sold, 601.5K+ followers. 89+% positive feedback. 0+% Ships in 48h, 99+% replies in 24h. Join the trend!",104 "avatar_url": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/e7478d3e93d4487a9e772fa74e10f506~tplv-fhlh96nyum-resize-webp:300:300.webp?dr=12185&t=555f072d&ps=933b5bde&shp=905da467&shcp=8dbd94bf&idc=useast5&from=2422056039",105 "banner_url": null,106 "verified": null,107 "is_private": null,108 "external_url": null,109 "links": [110 {111 "title": "TikTok Shop",112 "url": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079"113 }114 ],115 "location": null,116 "category": null,117 "created_at": null,118 "stats": {119 "followers": 601537,120 "following": null,121 "posts": 5637,122 "likes": null,123 "views": null124 },125 "extra": {126 "creator_name": "Goli® Nutrition",127 "identity": "OFFICIAL SHOP",128 "product_count": 53,129 "rating": 4.6,130 "region": "US",131 "review_count": 412514,132 "scores": [133 {134 "score": 99.0,135 "type": 1136 },137 {138 "score": 0.0,139 "type": 2140 },141 {142 "score": 89.0,143 "type": 3144 }145 ],146 "sold_count": 5808324,147 "video_count": 5637148 }149 }150 },151 "cursor": "eyJzIjoiNzQ5NTc5NDIwMzA1NjgzNTA3OSIsInNwIjoiMjBfV3pNM05qUXpMRFUzTURBd01EQXdMREUzTkRjek16TTNNRFF6TURBc0lqRTNNekV4TnpNM01ETTBOelU1TlRneU56a2lYUT09IiwibyI6MjB9",152 "has_more": true153}Response#
A list of Product objects in data.items, with data.cursor and data.has_more.
See Data models for every field. The envelope around data is described in Responses.
Errors#
Failures are free: credits_charged is 0. Branch on error.code, never on the message.
| Code | HTTP | Retry | Meaning |
|---|---|---|---|
invalid_params | 400 | no | A parameter is missing, unknown or has the wrong type. |
unsupported_url | 400 | no | The URL is not one this endpoint accepts (wrong platform or form). |
not_found | 404 | no | The platform says this profile, post or item does not exist. |
Every request can also fail with the account and platform errors listed on the Errors page.
Example error:
1{2 "ok": false,3 "error": {4 "code": "not_found",5 "message": "The platform says this profile, post or item does not exist.",6 "retryable": false7 },8 "credits_charged": 0,9 "request_id": "req_c718ca683eced44b07c144bd"10}Related endpoints#
- TikTok profile (
GET /v1/tiktok/profile) - TikTok profile videos (
GET /v1/tiktok/profile/videos) - TikTok collection videos (
GET /v1/tiktok/collection/videos) - TikTok video details (
GET /v1/tiktok/video) - TikTok video transcript (
GET /v1/tiktok/video/transcript) - TikTok video comments (
GET /v1/tiktok/video/comments) - TikTok comment replies (
GET /v1/tiktok/video/comment/replies) - TikTok user search (
GET /v1/tiktok/search/users)