SocialScrape
Get an API key
TikTok Shop product details API
  1. Docs
  2. TikTok
  3. TikTok Shop product details API

TikTok Shop product details API

One product with its SKUs and stock levels (in `extra`), rating, rating spread, specifications and shipping.

GET /v1/tiktok/shop/product

GET /v1/tiktok/shop/product

One product with its SKUs and stock levels (in extra), rating, rating spread, specifications and shipping. US catalogue only. TikTok sometimes treats an exit as a crawler; the request is retried on fresh exits and answers upstream_blocked (free) if all three are refused.

  • Cost: 1 credit
  • Cache: Results are kept up to 30 days; send max_age_days to reuse them for free.
  • Timeout: A request still running after about 25 seconds answers 202 with a job to poll (Batch and jobs).

Parameters#

NameTypeRequiredDescription
urlURLone ofProduct URL (tiktok.com/shop/pdp/...). Accepted hosts: tiktok.com.
idstringone ofProduct id. Also accepted as product_id.

Send at least one of url, id. If you send several, the first listed is used and the rest are ignored.

Every request also accepts:

  • region: two-letter country code for results that vary by country. Changing it restarts the cursor chain.
  • trim: true for a smaller response without null fields and extra.
  • raw: true to also get the platform's original object as raw.
  • 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/product" \2  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \3  --data-urlencode "id=1729527313880355335"

Example response#

This is a sample from a recorded response, lists and long text are shortened. Status 200.

200 OKSample response
1{2  "ok": true,3  "credits_charged": 1,4  "credits_remaining": 4999,5  "cached": false,6  "cached_at": null,7  "request_id": "req_ee8d4bff7a7b3f76c6babad5",8  "data": {9    "object": "product",10    "platform": "tiktok",11    "id": "1729527313880355335",12    "url": "https://www.tiktok.com/shop/pdp/ashwagandha-gummies-by-goli-ksm-66-mixed-berry-vegan-non-gmo/1729527313880355335",13    "title": "Goli Ashwagandha & Vitamin D Gummy - Mixed Berry, KSM-66, Vegan, Plant Based, Non-GMO, Gluten-Free & Gelatin Free. America's #1 Ashwagandha Brand",14    "description": "Goli Nutrition has sold over 90 Million bottles of gummy vitamins.\nVegan, Non-GMO, Gluten-free & Gelatin-free: Each bottle of Goli contains 60 delicious, vegan, non-gmo, gluten-free & gelatin-free Apple Cider Vinegar gummies, which makes th...",15    "price": {16      "amount": 19.47,17      "currency": "USD",18      "original_amount": 24.7,19      "display": "$19.47"20    },21    "seller": {22      "id": "7495794203056835079",23      "handle": null,24      "name": "Goli Nutrition",25      "url": "https://shop.tiktok.com/us/store/goli-nutrition/7495794203056835079",26      "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=6ce186a1&idc=useast5&from=2422056039",27      "verified": null28    },29    "rating": 4.5,30    "review_count": 94470,31    "sold_count": 1306215,32    "image_urls": [33      "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/2bc69aa9f6084480beee1bb4a8db3a69~tplv-fhlh96nyum-crop-webp:800:800.webp?dr=12190&t=555f072d&ps=933b5bde&shp=c940a200&shcp=9b759fb9&idc=useast5&from=3376456192",34      "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/e55105f652d84992807aefb34664bb00~tplv-fhlh96nyum-crop-webp:800:800.webp?dr=12190&t=555f072d&ps=933b5bde&shp=c940a200&shcp=9b759fb9&idc=useast5&from=3376456192",35      "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/f1fb81b18a5d4f88bb70c8a72e466d02~tplv-fhlh96nyum-crop-webp:800:800.webp?dr=12190&t=555f072d&ps=933b5bde&shp=c940a200&shcp=9b759fb9&idc=useast5&from=3376456192"36    ],37    "category": "Vitamins Supplements",38    "in_stock": true,39    "location": null,40    "published_at": null,41    "extra": {42      "categories": [43        {44          "id": "700645",45          "level": 1,46          "name": "Health"47        },48        {49          "id": "700646",50          "level": 2,51          "name": "Nutrition & Wellness"52        },53        {54          "id": "700650",55          "level": 3,56          "name": "Vitamins, Minerals & Wellness Supplements"57        }58      ],59      "default_sku_id": "1729527298861535751",60      "free_shipping": true,61      "rating_distribution": {62        "1": 5782,63        "2": 1511,64        "3": 3736,65        "4": 7816,66        "5": 7562567      },68      "seller_followers": 601537,69      "seller_product_count": 53,70      "seller_rating": 4.6,71      "seller_sold_count": 5808324,72      "shipping_days": {73        "max": 8,74        "min": 575      },76      "skus": [77        {78          "id": "1729527298861535751",79          "options": {80            "Size": "1 Bottle"81          },82          "original_price": 24.7,83          "price": 19.47,84          "purchase_limit": 200,85          "stock": 32895586        }87      ],88      "specifications": {89        "Age warning": "No",90        "Brand": "Goli",91        "Container type": "Bottle",92        "Dietary supplement disclaimer": "Yes",93        "Flavor": "Berry",94        "Ingredients": "Goli Nutrition Ashwagandha Gummies Relax, Restore and Unwind, Mixed Berry Flavor, Vegan, Plant Based, Non GMO, Gluten Free and Gelatin Free",95        "Manufacturer": "Goli Nutrition Inc",96        "Product form": "Gummy",97        "Region of origin": "US"98      },99      "total_stock": 328955,100      "variants": [101        {102          "name": "Size",103          "values": [104            "1 Bottle"105          ]106        }107      ]108    }109  },110  "cursor": null,111  "has_more": null112}

Response#

A Product object in data.

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.

CodeHTTPRetryMeaning
invalid_params400noA parameter is missing, unknown or has the wrong type.
unsupported_url400noThe URL is not one this endpoint accepts (wrong platform or form).
not_found404noThe platform says this profile, post or item does not exist.
upstream_blocked503yesThe platform blocked this fetch; retry (a fresh exit is used).

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": "upstream_blocked",5    "message": "The platform blocked this fetch; retry (a fresh exit is used).",6    "retryable": true7  },8  "credits_charged": 0,9  "request_id": "req_faeda5ba8140c1c4f679f436"10}

Also served at#

These paths answer the same request, so code written for other APIs keeps working: /v1/tiktok/product. See Switching from ScrapeCreators.