# 获取橱窗商品列表/Get Showcase Product List

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/tiktok/creator/get_showcase_product_list:
    post:
      summary: 获取橱窗商品列表/Get Showcase Product List
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取 TikTok Shop 创作者账号橱窗中正在展示的商品列表。

        - 可用于商品管理、数据分析、查看当前推广商品等场景。


        ### 备注:

        - 仅适用于已开通橱窗功能的 TikTok Shop 创作者账号。

        - 支持分页查询，通过 `count` 和 `offset` 控制数据量。


        ### 参数:

        - cookie: 用户 Cookie 字符串（用于身份认证）

        - count: 每页返回商品数量，默认 20

        - offset: 分页偏移量，默认 0

        - proxy: 可选 HTTP 代理地址
            - 示例: `http://username:password@host:port`

        ### 返回内容说明:

        - `products` (List[Dict]): 商品列表，每项包含以下字段：
          - `product_id` (str): 商品ID
          - `title` (str): 商品标题
          - `format_available_price` (str): 商品展示价格（格式化后的字符串，如 `$7.94`）
          - `seller_info` (dict):
            - `seller_id` (str): 卖家ID
            - `shop_name` (str): 店铺名称
          - `cover` (dict): 主图信息
            - `url_list` (List[str]): 主图 URL 列表（300x300）
          - `images` (List[dict]): 图片列表
            - 每张图片包含 `url_list` (原图 URL)
          - `source` (str): 商品来源渠道（如 `Affiliate`）
          - `stock_status` (int): 库存状态（1: 有货）
          - `review_status` (int): 审核状态（1: 通过）
          - `affiliate_info` (dict): 联盟佣金信息
            - `commission_with_currency` (str): 佣金金额（如 `$0.95`）
            - `commission_rate` (int): 佣金比例（如 1200 = 12%）
          - `category_info` (dict): 类目信息
            - `name` (str): 主分类名（如 `Beauty & Personal Care`）

        ### 示例请求体:

        ```json

        {
          "cookie": "your_cookie_string",
          "count": 20,
          "offset": 0
        }

        ```


        ### 示例返回数据片段:

        ```json

        {
          "products": [
            {
              "product_id": "1730905148396180014",
              "title": "Car Paint Care Spray",
              "format_available_price": "$7.94",
              "seller_info": {
                "seller_id": "7496108716782225966",
                "shop_name": "moon moon shop shop"
              },
              "cover": {
                "url_list": [
                  "https://example.com/xxx.jpg"
                ]
              },
              "images": [
                {
                  "url_list": [
                    "https://example.com/xxx.jpg"
                  ]
                }
              ],
              "source": "Affiliate",
              "stock_status": 1,
              "review_status": 1,
              "affiliate_info": {
                "commission_with_currency": "$0.95",
                "commission_rate": 1200
              },
              "category_info": {
                "name": "Beauty & Personal Care"
              }
            }
          ]
        }

        ```


        # [English]

        ### Purpose:

        - Retrieve the list of products currently displayed in a TikTok Shop
        creator's showcase.

        - Useful for product management, analytics, and monitoring promoted
        items.


        ### Notes:

        - Only available for TikTok creator accounts with the showcase feature
        enabled.

        - Supports pagination via `count` and `offset`.


        ### Parameters:

        - cookie: User Cookie string for authentication

        - count: Number of products per page (default 20)

        - offset: Pagination offset (default 0)

        - proxy: Optional HTTP proxy address
            - Example: `http://username:password@host:port`

        ### Return Structure:

        - `products` (List[Dict]): List of showcased products, including:
          - `product_id`, `title`, `format_available_price`, `seller_info`, `cover`, `images`, `source`, `stock_status`, `review_status`, `affiliate_info`, `category_info`.

        ### Example Request:

        ```json

        {
          "cookie": "your_cookie_string",
          "count": 20,
          "offset": 0
        }

        ```


        ### Example Response Snippet:

        ```json

        {
          "products": [
            {
              "product_id": "1730905148396180014",
              "title": "Car Paint Care Spray",
              "format_available_price": "$7.94",
              "seller_info": {
                "seller_id": "7496108716782225966",
                "shop_name": "moon moon shop shop"
              },
              "cover": {
                "url_list": [
                  "https://example.com/xxx.jpg"
                ]
              },
              "images": [...],
              "source": "Affiliate",
              "stock_status": 1,
              "review_status": 1,
              "affiliate_info": {
                "commission_with_currency": "$0.95",
                "commission_rate": 1200
              },
              "category_info": {
                "name": "Beauty & Personal Care"
              }
            }
          ]
        }

        ```
      operationId: >-
        get_showcase_product_list_api_v1_tiktok_creator_get_showcase_product_list_post
      tags:
        - TikTok-Creator-API
        - TikTok-Creator-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetShowcaseProductListRequest'
      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: SjtaQXog3mqsASqXv2gw-
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: SjtaQXog3mqsASqXv2gw-
            scopes:
              SjtaQXog3mqsASqXv2gw-:
                HTTPBearer: []
      x-apifox-folder: TikTok-Creator-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-291555427-run
components:
  schemas:
    GetShowcaseProductListRequest:
      properties:
        cookie:
          type: string
          title: Cookie
          description: 用户 Cookie 字符串/User Cookie String
          default: Your_Cookie_String
        proxy:
          anyOf:
            - type: string
            - type: 'null'
          title: Proxy
          description: 可选 HTTP 代理地址/Optional HTTP Proxy Address
          default: ''
        count:
          type: integer
          title: Count
          description: 每页数量/Page Size
          default: 20
        offset:
          type: integer
          title: Offset
          description: 偏移量/Offset
          default: 0
      type: object
      title: GetShowcaseProductListRequest
      x-apifox-orders:
        - cookie
        - proxy
        - count
        - offset
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    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: []

```