VI | EN
Message us on Messenger
Developer resources

Get trending catalog products — TikTok Business API

Get trending catalog products · call it through Quantri360 with one API key for your own accounts / assets that you connected and authorized — 360 handles request signing and refreshing the authorization you granted.

Get trending catalog products

GET/catalog/insight/product/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/catalog/insight/product/get/
Description

Use this endpoint to retrieve up to top 50 trending products based on user engagement on TikTok within an E-commerce catalog.

>Note

>

  • Catalog Product Insights become available 24 hours after you have uploaded a minimum of 20 products to your E-commerce catalog.
  • The insights are refreshed daily at around 4:00 AM UTC time.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/catalog/insight/product/get/

Authentication & shop

NameInTypeSampleDescription
AuthorizationheaderheaderBearer q360_live_ab12cd34_…Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand.
platform_shop_idquerystring7000000000000000001Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản.

Request parameters

NameInTypeRequiredSampleDescription
bc_idquerystringYesBusiness Center ID. To obtain the list of Business Centers that you have access to, use /bc/get/.
catalog_idquerystringYesCatalog ID. The catalog needs to be an E-commerce catalog that contains at least 20 products. To obtain the list of E-commerce catalogs within a Business Center, use /catalog/get/ and retrieve catalog_id values with catalog_type as ECOM. To verify that the catalog contains at least 20 products, use /catalog/overview/ and check whether the sum of the values of the returned approved, rejected, and processing fields is equal to or greater than 20.
filteringqueryobjectNoFiltering conditions.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/catalog/insight/product/get/?bc_id=&catalog_id=" \
  -H "Authorization: Bearer $KEY"
Python
import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/tiktok_business/catalog/insight/product/get/",
    params={
        "bc_id": "",
        "catalog_id": ""
    },
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())
Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/catalog/insight/product/get/');
for (const [k, v] of Object.entries({"bc_id":"","catalog_id":""})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
  method: 'GET',
  headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());
PHP
<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/catalog/insight/product/get/' . '?' . http_build_query(['bc_id' => '', 'catalog_id' => '']);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]);
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;

Response

Response fields (as returned by TikTok Business)

NameTypeSampleDescription
codenumberResponse code. For the complete list of response codes and descriptions, see Appendix-Return Code.
messagestringResponse message. For details, see Appendix - Return Codes.
request_idstringThe log ID of a request, which uniquely identifies the request.
dataobjectReturned data.
product_insightsobject[]The list of up to 50 trending products within the E-commerce catalog, sorted in descending order by popularity. For instance, the first item in the list is ranked 1st, indicating the most popular product, and the second item is ranked 2nd, indicating the second most popular product.
product_idstringThe system-generated product ID.
image_urlstringThe URL for the product image.
titlestringThe title of the product.
descriptionstringA short description of the product.
sku_idstringAdvertiser-defined unique SKU ID for the Product.
category_infoobjectInformation about the TikTok product category assigned to the product.
category_idstringThe TikTok product category ID assigned to the product, consisting of three levels separated by the number sign (#), in the format of `"level_id_1#level_id_2#level_id_3"`. Example: `601152#842248#601302`.
level_infoobjectDetails of the levels that the category belongs to.
level_id_1stringThe ID of the level-1 TikTok product category.
level_name_1stringThe name of the level-1 TikTok product category.
level_id_2stringThe ID of the level-2 TikTok product category.
level_name_2stringThe name of the level-2 TikTok product category.
level_id_3stringThe ID of the level-3 TikTok product category.
level_name_3stringThe name of the level-3 TikTok product category.
brandstringBrand name for the product.
priceobjectPrice information.
pricefloatThe base price of the product.
currencystringUnit of currency.  If this field is not specified, the unit of currency for the catalog's target country will be used by default.
sale_pricefloatThe discounted price of the product if it's on sale.
sale_price_effective_datestring[]The start and end date and time of sale.
availabilitystringThe current availability of the product in your store. Enum values: - `IN_STOCK`: in stock. - `AVAILABLE_FOR_ORDER`: available for order. - `PREORDER`: available for pre-order. - `OUT_OF_STOCK`: out of stock. - `DISCONTINUED`: discontinued.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "product_insights": [
            {
                "availability": "OUT_OF_STOCK",
                "brand": "{{brand}}",
                "category_info": {
                    "category_id": "605248#905224#906248",
                    "level_info": {
                        "level_id_1": "605248",
                        "level_id_2": "905224",
                        "level_id_3": "906248",
                        "level_name_1": "Fashion Accessories",
                        "level_name_2": "Clothes Accessories",
                        "level_name_3": "Headwear"
                    }
                },
                "description": "{{description}}",
                "image_url": "{{image_url}}",
                "price": {
                    "currency": "USD",
                    "price": 22.99,
                    "sale_price": 17.99,
                    "sale_price_effective_date": null
                },
                "product_id": "{{product_id}}",
                "sku_id": "{{sku_id}}",
                "title": "{{title}}"
            },
            {
                "availability": "OUT_OF_STOCK",
                "brand": "{{brand}}",
                "category_info": {
                    "category_id": "601152#842376#601276",
                    "level_info": {
                        "level_id_1": "601152",
                        "level_id_2": "842376",
                        "level_id_3": "601276",
                        "level_name_1": "Womenswear & Underwear",
                        "level_name_2": "Women's Bottoms",
                        "level_name_3": "Jeans"
                    }
                },
                "description": "{{description}}",
                "image_url": "{{image_url}}",
                "price": {
                    "currency": "USD",
                    "price": 57.99,
                    "sale_price": 49.99,
                    "sale_price_effective_date": null
                },
                "product_id": "{{product_id}}",
                "sku_id": "{{sku_id}}",
                "title": "{{title}}"
            }
        ]
    }
}

Get started

  1. Sign up for Partner
  2. Enable a data type of the Ads (Marketing API) group on the platform page
  3. Create an API key (tick the TikTok Business channel)
  4. Call it as in the examples above