Search live products and retrieve the product information needed by a compliance vendor to prepare a compliance testing report. The selection behavior is:
- If
product_idsis non-empty, the operation retrieves those known products. This branch takes precedence; seller, product-title, category, and brand filters and pagination are not used to select products. - Otherwise, the operation performs a shop search and requires
seller_id,seller_name, or both. When both shop identifiers are provided, their matching sellers are combined. You can further filter this search by product title, category IDs, and brand IDs and paginate the results.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”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
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 The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API.
The opaque token used to retrieve the next page. Omit this parameter or pass an empty string for the first page. For subsequent pages, pass the next_page_token returned by the previous response.
The number of results to be returned per page. Valid range: [1-50]
Request Body
Section titled “Request Body”object
The product title. Title length:
- DE, ES, FR, IE, IT, JP, UK, US: [1, 255]
- BR, MX: [1, 300]
- Other regions: [25, 255]
The product ID generated by TikTok Shop. Max is 20
The Shop identity ID.
Filter shop-search results by TikTok Shop category IDs.
Filter shop-search results by TikTok Shop brand IDs.
The name of the shop which product belongs to.
Example
{ "product_title": "mike noritama cute calico cat", "product_ids": [ "123123", "1235677", "456756" ], "seller_id": "1733337095719126364", "category_ids": [ "602118" ], "brand_ids": [ "602118" ], "seller_name": "shopname1"}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
The opaque token returned for a subsequent page. When this value is non-empty, pass it in the next request’s page_token.
The total number of products selected by the active mode. For direct product-ID lookup, this is the number of product IDs used for the lookup. For shop search, this is the total number of products matching the seller, product-title, category, and brand filters.
Product information
object
The product ID generated by TikTok Shop.
The product title. Title length:
- DE, ES, FR, IE, IT, JP, UK, US: [1, 255]
- BR, MX: [1, 300]
- Other regions: [25, 255]
The regions where the product is sold. Possible values:
- BR: Brazil
- DE: Germany
- ES: Spain
- FR: France
- GB: United Kingdom
- ID: Indonesia
- IE: Ireland
- IT: Italy
- JP: Japan
- MX: Mexico
- MY: Malaysia
- PH: Philippines
- SG: Singapore
- TH: Thailand
- US: United States
- VN: Vietnam
The product description in HTML format.
A list of Stock Keeping Units (SKUs) used to identify distinct variants of the product.
object
The SKU ID generated by TikTok Shop.
The product detail page URL of the product.
The name of the shop which product belongs to.
The Shop identity ID.
The URLs to view the images.
The ID of the brand of this product.
The brand name.
The category hierarchy of the product.
object
The ID of the category of this product.
The name of the category in the country where the shop operates.
The level of the category in the country where the shop operates.
The parent category ID. For the root category, the parent ID is 0
A flag to indicate if the category is a leaf category.
Note: You can only create or edit products that belong to a leaf category.
Example
{ "code": 0, "data": { "next_page_token": "[\\\"1733419489460520284\\\"]", "total_count": 454, "products": [ { "id": "1729592969712207008", "title": "mike noritama cute calico cat", "country": "FR", "description": "<p>Please compare above detailed size with your measurement before purchase.</p>\n<ul> \n <li>M-Size</li>\n <li>XL-Size</li>\n</ul> \n<img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/181595ea7d26489284b5667488d708c1~tplv-o3syd03w52-origin-jpeg.jpeg?from=1432613627\" />\n", "variants": [ { "id": "11111" } ], "listing_url": "https://shop.tiktok.com/view/product/1733990243784295749?region=FR", "seller_name": "Essential Shop", "seller_id": "11111", "main_image_urls": [ "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/6c8519a3663a4d728c4e3c131dc914b4~tplv-o3syd03w52-resize-jpeg:300:300.jpeg?from=522366036" ], "brand_id": "1111", "brand_name": "Labor", "categories": [ { "id": "1111", "name": "Kostum", "level": 1, "parent_id": "1111", "is_leaf": false } ] } ] }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}