stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202604/opportunities/{opportunity_id}
#§2 Method: [GET]
#§3 Function Description
Retrieve the full details of a single opportunity lead by its ID, including market trend data, competition level, and recommended actions.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. |
| Get by API Get Authorization Shop | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| opportunity_id | string | Y | 7123456789012345678 | The unique ID of the opportunity lead generated by TikTok Shop. |
§6 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| locale | string | N | en-US | Expressed using {language_code}-{COUNTRY_CODE}, in accordance with the BCP-47 standard. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202604/opportunities/7123456789012345678?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&locale=en-US
§8 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^opportunity | object | The information of the opportunity | |
| ^^id | string | 7123456789012345678 | Unique ID of the opportunity |
| ^^action_type | string | LIST_SAME | Recommended action type: LIST_SAME（发同款）/ LIST_SIMILAR（发相似品） |
| ^^listing_criteria | object | The criteria for products that match the opportunity lead. | |
| ^^^product_brand | string | brand1 | Requirement for product brand. |
| ^^^product_category | string | Phones & Electronics > Gaming & Consoles > Console Accessories | Requirement for product category. |
| ^^^product_status | string | LIVE | Requirement for product status : LIVE / DRAFT |
| ^^^keywords | string | word1,word2 | Keywords listed are required to be included in title/attributes/description,etc. |
| ^^content_data | object | The relevant data for the past 30 days. | |
| ^^^video_view_pv | string | 7k+ | The cumulative short video view count of all videos associated with this product opportunity. |
| ^^^shoppable_video_search_pv | string | 336k+ | Search PV count of all short videos with shopping intent associated with product opportunity. |
| ^^^trending_hashtag | string | tag1,tag2 | The top 1 video hashtag of the product-related videos, sorted by view count. |
| ^^^top_shoppable_video_links | []string | ["https://www.tiktok.com/@/video/v15044gf0000d4l7p57og65m3s0tqfa0","https://www.tiktok.com/@/video/v15044gf0000d306lrnog65h1a6283ug"] | Links to the top 10 shoppable short videos related to the product, sorted by view count. |
| ^^market_data | object | The relevant data for the past 30 days. | |
| ^^^est_market_sales_volume | string | 100k+ | Estimated overall market sales volume. |
| ^^^est_market_gmv | string | $9M+ | Estimated overall market sales GMV in USD. |
| ^^^market_buzz | string | HOT | Popularity level of the product: HOT / HIGH / MEDIUM |
| ^^^search_volume | string | 100k+ | TikTok Shop in-site user search volume. |
| ^^^search_keyword | string | holiday | TikTok Shop in-site user search keyword. |
| ^^^competitor_product_count | string | 100k+ | Number of competing products currently listed. |
| ^^^competitor_seller_count | string | 35 | Number of competing sellers with the products currently listed. |
| ^^basic_info | object | The detailed information of the opportunity. | |
| ^^^opportunity_type | string | PRODUCT | Type of opportunity: PRODUCT（品线索）/ KEYWORD（词线索）/ CATEGORY（类目线索） |
| ^^^status | string | ACTIVE | Opportunity status: ACTIVE / EXPIRED / FULFILLED(已提报) |
| ^^^create_time | int | 1775973876 | Opportunity creation timestamp, second-level timestamp |
| ^^^expire_time | int | 1775973876 | Opportunity expiry date, second-level timestamp |
| ^^^title | string | title | Opportunity title. |
| ^^^category_id_level_1 | string | 901128 | TikTok Shop L1 category ID. |
| ^^^category_id_level_2 | string | 30122212 | TikTok Shop L2 category ID. |
| ^^^category_id_level_3 | string | 40122212 | TikTok Shop L3 category ID. |
| ^^^category_name_level_1 | string | Shoes | Category name of 1st level category. |
| ^^^category_name_level_2 | string | Women's Shoes | Category name of 2nd level category. |
| ^^^category_name_level_3 | string | Sandals & Flip Flops | Category name of 3rd level category. |
| ^^^reference_price | string | $36.3 - $38.5 | Reference price of the product to list. |
| ^^^reference_images | []string | ["https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/61e605ce483f4f7b9b419d510f74fd22~tplv-o3syd03w52-resize-image:400:400.image?dr=15586&t=555f072d&ps=933b5bde&shp=5563f2fb&shcp=122e87b3&idc=maliva&from=1432613627&from_p=305039283"] | Reference product images of the product to list. |
| ^^^brand_info | string | some brand info | Brand requirements for products specified by the opportunity. |
| ^^^reward_info | string | Boost shoptab visibility | Rewards that sellers can gain by listing products as required. |
| ^^^recom_info | string | Trending, but out of stock | Recommendation reason why this is an opportunity. |
| ^^^tags | string | Pencarian teratas,Pencarian trending,Persaingan rendah,Trending di TikTok,Terlaris | the tag list of opportunity |
| ^^^tag_codes | []string | ["CORE_PRODUCT"] | The tag code list of opportunity, mapped one-to-one in order with tags. Allowed values for Latam include: CORE_PRODUCT, TOP_PRODUCT. |
| ^^^external_product_id | string | SH1234567890 | Product ID on the reference source. |
| ^^^reference_source | string | 1 | The code of the reference_source. Returned only when external_product_id is present. |
§9 Response Sample
{"code":0,"data":{"opportunity":{"id":"7123456789012345678","action_type":"LIST_SAME","listing_criteria":{"product_brand":"brand1","product_category":"Phones \u0026 Electronics \u003e Gaming \u0026 Consoles \u003e Console Accessories","product_status":"LIVE","keywords":"word1,word2"},"content_data":{"video_view_pv":"7k+","shoppable_video_search_pv":"336k+","trending_hashtag":"tag1,tag2","top_shoppable_video_links":["https://www.tiktok.com/@/video/v15044gf0000d4l7p57og65m3s0tqfa0","https://www.tiktok.com/@/video/v15044gf0000d306lrnog65h1a6283ug"]},"market_data":{"est_market_sales_volume":"100k+","est_market_gmv":"$9M+","market_buzz":"HOT","search_volume":"100k+","search_keyword":"holiday","competitor_product_count":"100k+","competitor_seller_count":"35"},"basic_info":{"opportunity_type":"PRODUCT","status":"ACTIVE","create_time":1775973876,"expire_time":1775973876,"title":"title","category_id_level_1":"901128","category_id_level_2":"30122212","category_id_level_3":"40122212","category_name_level_1":"Shoes","category_name_level_2":"Women's Shoes","category_name_level_3":"Sandals \u0026 Flip Flops","reference_price":"$36.3 - $38.5","reference_images":["https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/61e605ce483f4f7b9b419d510f74fd22~tplv-o3syd03w52-resize-image:400:400.image?dr=15586\u0026t=555f072d\u0026ps=933b5bde\u0026shp=5563f2fb\u0026shcp=122e87b3\u0026idc=maliva\u0026from=1432613627\u0026from_p=305039283"],"brand_info":"some brand info","reward_info":"Boost shoptab visibility","recom_info":"Trending, but out of stock","tags":"Pencarian teratas,Pencarian trending,Persaingan rendah,Trending di TikTok,Terlaris","tag_codes":["CORE_PRODUCT"],"external_product_id":"SH1234567890","reference_source":"1"}}},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|