# 获取商品评论V2/Get product reviews V2 ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v1/tiktok/shop/web/fetch_product_reviews_v2: get: summary: 获取商品评论V2/Get product reviews V2 deprecated: false description: |- # [中文] ### 用途: - 获取TikTok Shop商品评论 - 支持多种筛选和排序方式 - 数据结构更完整，包含更多评论详情 ### 参数: - product_id: 商品ID (必填) - page_start: 起始页码，默认1 - 当响应中 has_more=1 时，使用当前页码 +1 进行下一页请求 - sort_rule: 排序规则，默认2 - 1: 推荐排序 - 2: 最近时间 - filter_type: 评论筛选类型，默认1 - 1: 全部评论；通过 filter_value 选择全部星级或指定星级 - 2: 仅包含图片或视频的评论；filter_value 固定传1 - 3: 仅真实购买评论；filter_value 固定传1 - filter_value: 与 filter_type 配合使用 - filter_type=1 时：6=全部星级(默认)，5=5星，4=4星，3=3星，2=2星，1=1星 - filter_type=2 或 3 时：固定传1 - region: 地区代码，可用地区如下： - US: 美国 - SG: 新加坡 - MY: 马来西亚 - PH: 菲律宾 - TH: 泰国 - VN: 越南 - ID: 印度尼西亚 - JP: 日本 - MX: 墨西哥 - BR: 巴西 ### 筛选组合示例: - 全部评论: filter_type=1, filter_value=6 - 5星评论: filter_type=1, filter_value=5 - 包含图片或视频: filter_type=2, filter_value=1 - 真实购买: filter_type=3, filter_value=1 ### 重要提示: - 建议将请求timeout设置为30秒 - 仅支持 TikTok Shop Web 端可访问的商品 ### 返回数据结构: ```json { "code": 0, "message": "success", "data": { "reviews": [ // 评论列表(每页20条) { "review_id": "xxx", "user": { // 用户信息 "user_id": "xxx", "nickname": "用户昵称", "avatar": "头像URL" }, "rating": 5, // 评分(1-5星) "content": "评论内容", "medias": [ // 媒体文件(图片/视频) { "type": "image", "url": "媒体URL" } ], "create_time": 0, // 创建时间戳 "verified_purchase": true, // 是否认证购买 "product_info": {}, // 商品信息 "likes_count": 10, // 点赞数 "seller_reply": {} // 卖家回复 } ], "has_more": 1, // 是否有更多: 1=有, 0=无 "page_start": 1, // 当前页码 "total_count": 500, // 总评论数 "review_summary": { // 评论摘要 "average_rating": 4.8, "star_distribution": { // 星级分布 "5": 400, "4": 80, "3": 15, "2": 3, "1": 2 } } } } ``` # [English] ### Purpose: - Get TikTok Shop product reviews - Support multiple filtering and sorting options - More complete data structure with detailed review information ### Parameters: - product_id: Product ID (required) - page_start: Starting page number, default 1 - When has_more=1 in response, use current page +1 for next page - sort_rule: Sort order, default 2 - 1: Recommended - 2: Most recent - filter_type: Review filter type, default 1 - 1: All reviews; use filter_value to select all ratings or a specific rating - 2: Reviews containing images or videos; filter_value must be 1 - 3: Verified-purchase reviews; filter_value must be 1 - filter_value: Used together with filter_type - When filter_type=1: 6=all ratings (default), 5=5-star, 4=4-star, 3=3-star, 2=2-star, 1=1-star - When filter_type=2 or 3: use 1 - region: Region code, available regions are as follows: - US: United States - SG: Singapore - MY: Malaysia - PH: Philippines - TH: Thailand - VN: Vietnam - ID: Indonesia - JP: Japan - MX: Mexico - BR: Brazil ### Filter Combination Examples: - All reviews: filter_type=1, filter_value=6 - 5-star reviews: filter_type=1, filter_value=5 - Reviews with images or videos: filter_type=2, filter_value=1 - Verified-purchase reviews: filter_type=3, filter_value=1 ### Important Notice: - Set the request timeout to 30 seconds - Only products accessible via TikTok Shop Web are supported ### Response Structure: ```json { "code": 0, "message": "success", "data": { "reviews": [ // Review list (20 per page) { "review_id": "xxx", "user": { // User info "user_id": "xxx", "nickname": "Username", "avatar": "Avatar URL" }, "rating": 5, // Rating (1-5 stars) "content": "Review content", "medias": [ // Media files (images/videos) { "type": "image", "url": "Media URL" } ], "create_time": 0, // Create timestamp "verified_purchase": true, // Is verified purchase "product_info": {}, // Product info "likes_count": 10, // Likes count "seller_reply": {} // Seller reply } ], "has_more": 1, // Has more: 1=yes, 0=no "page_start": 1, // Current page "total_count": 500, // Total review count "review_summary": { // Review summary "average_rating": 4.8, "star_distribution": { // Star distribution "5": 400, "4": 80, "3": 15, "2": 3, "1": 2 } } } } ``` # [示例/Example] product_id = "1729408816995078528" page_start = 1 sort_rule = 2 filter_type = 1 filter_value = 6 region = "US" operationId: >- fetch_product_reviews_v2_api_v1_tiktok_shop_web_fetch_product_reviews_v2_get tags: - TikTok-Shop-Web-API - TikTok-Shop-Web-API parameters: - name: product_id in: query description: 商品ID/Product ID required: true example: '1729408816995078528' schema: type: string description: 商品ID/Product ID title: Product Id - name: page_start in: query description: 起始页码/Page start required: false example: 1 schema: type: integer description: 起始页码/Page start default: 1 title: Page Start - name: sort_rule in: query description: '排序规则/Sort order: 1=推荐/Recommended, 2=最近/Most recent' required: false example: 2 schema: type: integer description: '排序规则/Sort order: 1=推荐/Recommended, 2=最近/Most recent' default: 2 title: Sort Rule - name: filter_type in: query description: >- 筛选类型/Filter type: 1=全部/All, 2=含图片或视频/With images or videos, 3=真实购买/Verified purchase required: false example: 1 schema: type: integer description: >- 筛选类型/Filter type: 1=全部/All, 2=含图片或视频/With images or videos, 3=真实购买/Verified purchase default: 1 title: Filter Type - name: filter_value in: query description: >- 筛选值/Filter value: filter_type=1 时 6=全部、5-1=对应星级；filter_type=2 或 3 时固定传1 / For filter_type=1, 6=all and 5-1=star rating; use 1 for filter_type=2 or 3 required: false example: 6 schema: type: integer description: >- 筛选值/Filter value: filter_type=1 时 6=全部、5-1=对应星级；filter_type=2 或 3 时固定传1 / For filter_type=1, 6=all and 5-1=star rating; use 1 for filter_type=2 or 3 default: 6 title: Filter Value - name: region in: query description: >- 地区代码/Region code: US, SG, MY, PH, TH, VN, ID, JP, MX, BR。GB 暂不支持 / GB temporarily unavailable. 不支持的地区返回 HTTP 200，data.region_supported=false，并列出 supported_regions / Unsupported regions return HTTP 200 with data.region_supported=false and supported_regions. required: false example: US schema: type: string description: >- 地区代码/Region code: US, SG, MY, PH, TH, VN, ID, JP, MX, BR。GB 暂不支持 / GB temporarily unavailable. 不支持的地区返回 HTTP 200，data.region_supported=false，并列出 supported_regions / Unsupported regions return HTTP 200 with data.region_supported=false and supported_regions. default: US title: Region responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' headers: {} x-apifox-name: OK '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' headers: {} x-apifox-name: Unprocessable Entity security: - HTTPBearer: [] x-apifox: schemeGroups: - id: 84VM_QHE4JoOHiYrhxf6W schemeIds: - HTTPBearer required: true use: id: 84VM_QHE4JoOHiYrhxf6W scopes: 84VM_QHE4JoOHiYrhxf6W: HTTPBearer: [] x-apifox-folder: TikTok-Shop-Web-API x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-374442928-run components: schemas: ResponseModel: properties: code: type: integer title: Code description: HTTP status code | HTTP状态码 default: 200 request_id: anyOf: - type: string - type: 'null' title: Request Id description: Unique request identifier | 唯一请求标识符 message: type: string title: Message description: Response message (EN-US) | 响应消息 (English) default: Request successful. This request will incur a charge. message_zh: type: string title: Message Zh description: Response message (ZH-CN) | 响应消息 (中文) default: 请求成功，本次请求将被计费。 support: type: string title: Support description: Support message | 支持消息 default: 'Discord: https://discord.gg/aMEAS8Xsvz' time: type: string title: Time description: The time the response was generated | 生成响应的时间 time_stamp: type: integer title: Time Stamp description: The timestamp the response was generated | 生成响应的时间戳 time_zone: type: string title: Time Zone description: The timezone of the response time | 响应时间的时区 default: America/Los_Angeles docs: anyOf: - type: string - type: 'null' title: Docs description: >- Link to the API Swagger documentation for this endpoint | 此端点的 API Swagger 文档链接 cache_message: anyOf: - type: string - type: 'null' title: Cache Message description: Cache message (EN-US) | 缓存消息 (English) default: >- This response is cached and accessible via the URL below for 24 hours at no extra cost. The cache is for request tracing only — it doesn't affect the API's data freshness and won't be returned through the API again. cache_message_zh: anyOf: - type: string - type: 'null' title: Cache Message Zh description: Cache message (ZH-CN) | 缓存消息 (中文) default: >- 本次响应已缓存，可通过下方 URL 直接查看，有效期 24 小时，访问缓存链接无额外费用。缓存仅用于请求溯源，不影响接口数据的时效性，也不会再次通过接口返回。 cache_url: anyOf: - type: string - type: 'null' title: Cache Url description: The URL to access the cached result | 访问缓存结果的 URL router: type: string title: Router description: The endpoint that generated this response | 生成此响应的端点 default: '' params: type: string data: anyOf: - type: string - type: 'null' title: Data description: The response data | 响应数据 type: object title: ResponseModel x-apifox-orders: - code - request_id - message - message_zh - support - time - time_stamp - time_zone - docs - cache_message - cache_message_zh - cache_url - router - params - data x-apifox-ignore-properties: [] x-apifox-folder: '' HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError x-apifox-orders: - detail x-apifox-ignore-properties: [] x-apifox-folder: '' ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError x-apifox-orders: - loc - msg - type x-apifox-ignore-properties: [] x-apifox-folder: '' securitySchemes: HTTPBearer: type: bearer description: > ---- #### API Token Introduction: ##### Method 1: Use API Token in the Request Header (Recommended) - **Header**: `Authorization` - **Format**: `Bearer {token}` - **Example**: `{"Authorization": "Bearer your_token"}` - **Swagger UI**: Click on the `Authorize` button in the upper right corner of the page to enter the API token directly without the `Bearer` keyword. ##### Method 2: Use API Token in the Cookie (Not Recommended, Use Only When Method 1 is Unavailable) - **Cookie**: `Authorization` - **Format**: `Bearer {token}` - **Example**: `Authorization=Bearer your_token` #### Get API Token: 1. Register and log in to your account on the TikHub website. 2. Go to the user center, click on the API token menu, and create an API token. 3. Copy and use the API token in the request header. 4. Keep your API token confidential and use it only in the request header. ---- #### API令牌简介: ##### 方法一：在请求头中使用API令牌（推荐） - **请求头**: `Authorization` - **格式**: `Bearer {token}` - **示例**: `{"Authorization": "Bearer your_token"}` - **Swagger UI**: 点击页面右上角的`Authorize`按钮，直接输入API令牌，不需要`Bearer`关键字。 ##### 方法二：在Cookie中使用API令牌（不推荐，仅在无法使用方法一时使用） - **Cookie**: `Authorization` - **格式**: `Bearer {token}` - **示例**: `Authorization=Bearer your_token` #### 获取API令牌: 1. 在TikHub网站注册并登录账户。 2. 进入用户中心，点击API令牌菜单，创建API令牌。 3. 复制并在请求头中使用API令牌。 4. 保密您的API令牌，仅在请求头中使用。 scheme: bearer servers: - url: https://api.tikhub.io description: Production Environment security: [] ```