TikTok modelsapi generation api

tiktok/shop-web/products-by-category-id

Get product list by category ID Can be used to build category browsing feature

Input
Idle

Example output — click Run to generate your own

API README

Get products by category ID

Purpose:

  • Get product list by category ID
  • Can be used to build category browsing feature Parameters:
  • category_id: Category ID (required, from fetch_products_category_list API)
  • offset: Offset for pagination (default 0)
    • Default 20 products per page, increase by 20 for each request. If hasMore in response is true, can request next page, otherwise reached last page.
    • Example: Page 1 offset=0, Page 2 offset=20, Page 3 offset=40, and so on.
  • region: Region code (US/GB/SG/MY/PH/TH/VN/ID) Important Notice:
  • Due to API rate limiting, please set request timeout to 30 seconds
  • If you encounter error code 400, please retry the request 3 times Response Structure:
{
    "code": 0,
    "message": "success",
    "data": {
        "products": [                // Product list (up to 20)
            {
                "product_id": "xxx",
                "title": "Product title",
                "image": "Product image",
                "price": {},              // Price info
                "rating": {},             // Rating info
                "sales": {}               // Sales info
            }
        ]
    }
}

[Example]

category_id = 963976 region = "US"

Imported from a validated TikHub OpenAPI document. Pricing must be reviewed before enabling.

Related Models