Docs
Query Product Info
Request
HTTP URL | https://open.tiktokapis.com/v2/research/tts/product/ |
HTTP Method | POST |
Scopes | research.data.basic (required) |
Headers
Key | Type | Description | Example Value |
Authorization | string | The client access token obtained from /v2/oauth/token/. | Bearer clt.example12345Example12345Example |
Query Parameters
Key | Type | Description | Example | Required |
fields | string | Field names for desired data to be returned. It is a comma separated list. See Product Info Object below for a full list of values. | Complete list: product_id,product_sold_count,product_description,product_price,product_review_count,product_name,product_rating_1_count,product_rating_2_count,product_rating_3_count,product_rating_4_count,product_rating_5_count | Yes |
Body Parameters
Key | Type | Description | Example Value |
shop_id | string | shop_id as the unique identifier | "7495177166735509999" |
page_start | int | The start page for the products in the shop (start with 1) | 1 |
page_size | int | The size of data on the page (max 10) | 10 |
Example
curl --location 'https://open.tiktokapis.com/v2/research/tts/product/' \
--header 'Content-Type: application/json' \
--header 'x-tt-env: ppe_qatest_9188' \
--header 'x-use-ppe: 1' \
--header 'x-tt-target-idc: useast1a' \
--header 'Authorization: Bearer clt.2.zVnmv7TAr05oei_Z3nU-UQE-4IUhG47YsLHNBSn-blQKDAuMoaWaHJUfg2_3nCfOhfWZVpqu44azZHLQ89zA3g*3' \
--data '{
"shop_id": 7495177166735509999,
"fields": "product_id,product_sold_count,product_description,product_price,product_review_count,product_name,product_rating_1_count,product_rating_2_count,product_rating_3_count,product_rating_4_count,product_rating_5_count",
"page_start": 1,
"page_size": 2
}'Response
Body
Key | Type | Description |
data | Product Info Object | The returned product info data for products available for purchase in the EU. |
error | ErrorStructV2 | Error object |
Product Info Object
Field Name | Type | Description |
"product_name" | string | The name of the product |
"product_id" | int64 | The unique ID of the product |
"product_price" | list | The price of the product |
"product_rating" | string | The rating of the product |
"product_review_count" | int64 | The number of reviews of the product |
"product_rating_5_count" | int64 | The number of ratings of 5-stars the product has received |
"product_rating_4_count" | int64 | The number of ratings of 4-stars the product has received |
"product_rating_3_count" | int64 | The number of ratings of 3-stars the product has received |
"product_rating_2_count" | int64 | The number of ratings of 2-stars the product has received |
"product_rating_1_count" | int64 | The number of ratings of 1-star the product has received |
"product_sold_count" | int64 | The number of items sold since this item was listed on TikTok shop, including items that have been returned |
"product_description" | string | The description of the product |
"shop_name" | string | The name of the "Shop" the product is under |
Example
{
"data": {
"product_data": [
{
"product_description": "<ul><li>【Durable Polyester】: Crafted from high quality polyester material, this jacket promises longevity and easy maintenance.</li><li>【Practical Pockets】: Equipped with pockets and a drawstring, this jacket combines functionality with fashion for your daily essentials.</li><li>【Drawstring Hood】: The hood can be adjusted for a custom fit, providing added warmth and protection from the elements.</li><li>【Easy Zipper Closure】: The jacket features a smooth zipper coat, making it a breeze to put on and take off.</li><li>【Regular Fit】: Designed to provide a comfortable and flattering fit for a wide range of body types.</li></ul><p> </p><p> </p><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/78edd4458c7342f5976da975ac6e7b65~tplv-o3syd03w52-origin-jpeg.jpeg?from=1432613627\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/aa560bd5eeb84be2b007b0ac8acba065~tplv-o3syd03w52-origin-jpeg.jpeg?from=1432613627\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/3f2352de0e164405a065e3c5d99aa972~tplv-o3syd03w52-origin-jpeg.jpeg?from=1432613627\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/cd081b3ef14248978f3be098a9f54862~tplv-o3syd03w52-origin-jpeg.jpeg?from=1432613627\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/4b623813686242d690962e0b9d182905~tplv-o3syd03w52-origin-jpeg.jpeg?from=1432613627\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/922c9e2718114a3b948122839943a825~tplv-o3syd03w52-origin-jpeg.jpeg?from=1432613627\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/bc6c51d30d7c44429157c6851f25028c~tplv-o3syd03w52-origin-jpeg.jpeg?from=1432613627\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/ce1712e527dd4812bfab0edf47b487ad~tplv-o3syd03w52-origin-jpeg.jpeg?from=1432613627\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/467aa82e4a424fba8eb7b7e879c2b33c~tplv-o3syd03w52-origin-jpeg.jpeg?from=1432613627\" width=\"1350\" height=\"1800\">",
"product_id": 1729401755128991215,
"product_name": "Men's Solid Pocket Drawstring Hooded Jacket, Regular Fit Zip Up Jacket, Stylish Outfit for Spring & Fall, Windbreaker for Men, Menswear, Men's Tops, Mens Clothing, Back To School Clothes, Winter Coats, Workwear Jacket",
"product_price": [
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"20.79GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP",
"37.29GBP"
],
"product_rating_1_count": 116,
"product_rating_2_count": 47,
"product_rating_3_count": 112,
"product_rating_4_count": 353,
"product_rating_5_count": 2693,
"product_review_count": 3321,
"product_sold_count": 37741
},
{
"product_description": "<img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/572d8d361b5548eeb422376219d18b4d~tplv-o3syd03w52-origin-jpeg.jpeg?dr=15568&nonce=19656&refresh_token=5fbca2482375accac79bdf6dd012f765&from=1432613627&idc=maliva&ps=933b5bde&shcp=dbb882a5&shp=5563f\" width=\"1350\" height=\"1800\"><img src=\"https://p19-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/e5e0a076114e4a32b1fc09e819facbee~tplv-o3syd03w52-origin-jpeg.jpeg?dr=15568&nonce=67596&refresh_token=bce7c423c69ca8ee1a417e563988f28d&from=1432613627&idc=maliva&ps=933b5bde&shcp=dbb882a5&shp=5563f\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/7fd0fa7e8ce44c4daac113fab92c5425~tplv-o3syd03w52-origin-jpeg.jpeg?from=4250909378\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/2a6466ab8d1a4b56a9179250f7438d55~tplv-o3syd03w52-origin-jpeg.jpeg?from=4250909378\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/7b6b9d9993394b12867c428e3fcc536b~tplv-o3syd03w52-origin-jpeg.jpeg?from=4250909378\" width=\"1350\" height=\"1800\"><img src=\"https://p19-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/1672462efb634d90af7ffb7cdef6205d~tplv-o3syd03w52-origin-jpeg.jpeg?dr=15568&nonce=11925&refresh_token=6c904fb9f9d10e973824953313b9fcfa&from=1432613627&idc=maliva&ps=933b5bde&shcp=dbb882a5&shp=5563f\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/1b57a297be484b27b49132264d3fe835~tplv-o3syd03w52-origin-jpeg.jpeg?dr=15568&nonce=57143&refresh_token=86dfb6a097e271e2f801cb4e63dbe991&from=1432613627&idc=maliva&ps=933b5bde&shcp=dbb882a5&shp=5563f\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/89070efabd1d44c09b76677089853c18~tplv-o3syd03w52-origin-jpeg.jpeg?dr=15568&nonce=41895&refresh_token=7c85cfae51d35dd80e38aa04b6a01623&from=1432613627&idc=maliva&ps=933b5bde&shcp=dbb882a5&shp=5563f\" width=\"1350\" height=\"1800\"><img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/75ebdb745d5f4ef79df03ff64cf04db7~tplv-o3syd03w52-origin-jpeg.jpeg?dr=15568&nonce=25328&refresh_token=beb06f1bfa8581f04a40efd37c348183&from=1432613627&idc=maliva&ps=933b5bde&shcp=dbb882a5&shp=5563f\" width=\"1350\" height=\"1800\">",
"product_id": 1729405957887593967,
"product_name": "Men's Regular Fit Colorblock Zip Up Hooded Workwear Jacket, Sporty Windproof Waterproof Long Sleeve Outerwear for Outdoor, Tracksuit for Fitness, Windbreaker",
"product_price": [
"16.79GBP",
"16.79GBP",
"16.79GBP",
"16.79GBP",
"16.79GBP",
"17.49GBP",
"17.49GBP",
"17.49GBP",
"17.49GBP",
"17.49GBP",
"17.49GBP",
"17.49GBP",
"17.49GBP",
"17.49GBP",
"17.49GBP",
"17.49GBP",
"17.49GBP",
"17.49GBP",
"17.49GBP",
"17.49GBP"
],
"product_rating_1_count": 7,
"product_rating_2_count": 2,
"product_rating_3_count": 3,
"product_rating_4_count": 12,
"product_rating_5_count": 72,
"product_review_count": 96,
"product_sold_count": 1292
}
]
}
}