# 【已弃用】获取热卖商品列表/[Deprecated] Get hot selling products list

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/tiktok/shop/web/fetch_hot_selling_products_list:
    get:
      summary: 【已弃用】获取热卖商品列表/[Deprecated] Get hot selling products list
      deprecated: true
      description: >-
        # [中文]

        ### ⚠️ 本接口已弃用:

        - 如需按类目或关键词取商品，请改用 `fetch_products_by_category_id` 或
        `fetch_search_products_list`

        ### 用途:

        - 获取TikTok Shop的热卖商品列表

        - 返回当前最受欢迎的商品

        ### 参数:

        - region: 地区代码 (US/SG/MY/PH/TH/VN/ID/JP/MX/BR)

        - count: 返回商品数量，默认20 (可选)。数值越大响应越慢

        - exclude_product_ids: 已获取过的商品ID，逗号分隔 (可选)，用于翻页

        ### 翻页方式:

        - 本接口没有页码或偏移量参数

        - 要取下一批，把已经拿到的商品ID用英文逗号拼接后传入 `exclude_product_ids`，
          接口会跳过它们并返回新的商品
        - 响应中的 `data.hasMore` 为 `true` 表示还有更多商品，为 `false` 表示已取完

        ### 返回数据结构:

        ```json

        {
            "code": 0,
            "message": "success",
            "data": {
                "hasMore": true,              // 是否还有更多商品
                "productList": [              // 热卖商品列表
                    {
                        "product_id": "1731128793906516409",
                        "title": "商品标题"
                        // 其余字段随上游返回，原样透传
                    }
                ]
            }
        }

        ```


        # [English]

        ### ⚠️ This API is deprecated:

        - To fetch products by category or keyword, use
        `fetch_products_by_category_id` or `fetch_search_products_list`

        ### Purpose:

        - Get TikTok Shop hot selling products list

        - Returns currently most popular products

        ### Parameters:

        - region: Region code (US/SG/MY/PH/TH/VN/ID/JP/MX/BR)

        - count: Number of products to return, default 20 (optional). Larger
        values are slower

        - exclude_product_ids: Comma-separated product IDs you already have
        (optional), used for paging

        ### Pagination:

        - This endpoint has no page or offset parameter

        - To fetch the next batch, pass the product IDs you already have as a
        comma-separated
          list in `exclude_product_ids`; the endpoint skips them and returns new products
        - `data.hasMore` is `true` when more products are available, `false`
        when exhausted

        ### Response Structure:

        ```json

        {
            "code": 0,
            "message": "success",
            "data": {
                "hasMore": true,              // Whether more products are available
                "productList": [              // Hot selling products
                    {
                        "product_id": "1731128793906516409",
                        "title": "Product title"
                        // Remaining fields are passed through as returned upstream
                    }
                ]
            }
        }

        ```


        # [示例/Example]

        region = "US"

        count = 20

        exclude_product_ids = ""          # 第二页传上一页拿到的 product_id，逗号分隔
      operationId: >-
        fetch_hot_selling_products_list_api_v1_tiktok_shop_web_fetch_hot_selling_products_list_get
      tags:
        - TikTok-Shop-Web-API
        - TikTok-Shop-Web-API
      parameters:
        - 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
        - name: count
          in: query
          description: 返回商品数量，默认20/Number of products to return, default 20
          required: false
          example: 20
          schema:
            type: integer
            description: 返回商品数量，默认20/Number of products to return, default 20
            default: 20
            title: Count
        - name: exclude_product_ids
          in: query
          description: >-
            已获取过的商品ID，逗号分隔，用于翻页/Comma-separated product IDs you already have,
            used for paging
          required: false
          example: 1731128793906516409,1732305963897557680
          schema:
            type: string
            description: >-
              已获取过的商品ID，逗号分隔，用于翻页/Comma-separated product IDs you already have,
              used for paging
            default: ''
            title: Exclude Product Ids
      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: T0YQsx3UiBzLit1qkxAw0
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: T0YQsx3UiBzLit1qkxAw0
            scopes:
              T0YQsx3UiBzLit1qkxAw0:
                HTTPBearer: []
      x-apifox-folder: TikTok-Shop-Web-API
      x-apifox-status: deprecated
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-347819644-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: []

```
