Get catalogs
GET/catalog/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/catalog/get/
Description
Use this endpoint to get information about a catalog or all catalogs under a Business Center.
Request
Endpoint
GET https://partner.quantri360.com/v1/tiktok_business/catalog/get/
Authentication & shop
| Name | In | Type | Sample | Description |
|---|---|---|---|---|
| Authorization | header | header | Bearer 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_id | query | string | 7000000000000000001 | Tà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
| Name | In | Type | Required | Sample | Description |
|---|---|---|---|---|---|
| bc_id | query | string | Yes | Business Center ID. | |
| catalog_id | query | string | No | Catalog ID. If not specified, all catalogs will be returned. | |
| page | query | number | No | Current number of pages. Default value: 1. Value range: ≥ 1. | |
| page_size | query | number | No | Page size. Default value: 10. Value range: 1-1,000. |
Request examples
curl -s "https://partner.quantri360.com/v1/tiktok_business/catalog/get/?bc_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/get/",
params={
"bc_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/get/');
for (const [k, v] of Object.entries({"bc_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/get/' . '?' . http_build_query(['bc_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)
| Name | Type | Sample | Description |
|---|---|---|---|
| code | number | Return code. For the complete list of response codes and descriptions, see Appendix - return codes. | |
| message | string | Return message. For details, see Appendix-Return codes. | |
| data | object | Returned data. | |
| list | object[] | Catalog list. | |
| catalog_id | string | Catalog ID. | |
| catalog_name | string | Catalog name. | |
| catalog_type | string | Catalog type. Enum values: - `ECOM`: E-commerce catalog. - `HOTEL`: hotel catalog. - `FLIGHT`: flight catalog. - `DESTINATION`: destination catalog. - `ENTERTAINMENT`: entertainment catalog. - `AUTO_VEHICLE`: Auto-Inventory catalog. - `AUTO_MODEL`: Auto-Model catalog. - `MINI_SERIES`: mini series catalog. - `GENERIC`: generic catalog. - `ONLINE_TO_OFFLINE`: online-to-offline catalog. | |
| ad_creation_eligible | string | Whether the catalog can be used in ads when it contains the number of available products required for the ad format. Enum values: - `NOT_AVAILABLE`: The catalog cannot be used in ads. - `AVAILABLE`: The catalog can be used in ads when it contains the number of available products required for the ad format. | |
| create_time | string | Creation time. | |
| update_time | string | Update time. | |
| bc_info | object | Information about Business Center. | |
| bc_id | string | Business Center ID. | |
| bc_name | string | Business Center name. | |
| picture_url | string | URL of the profile image. An empty value is returned if the Business Center doesn't have a profile image. | |
| catalog_conf | object | Catalog configuration information. | |
| country | string | The region code of the primary targeting region. To find out the corresponding region for a region code, refer to Appendix - Location code. Example: `US`. | |
| currency | string | Currency for the primary targeting region. For supported currencies, see the Code column in Budget verification ratio and precision of each currency. Example: `USD`. | |
| channel | string | Channel for creating the catalog. Enum values: - `PARTNER`: Partners. - `CLIENT`: Direct advertisers. | |
| additional_config_list | object[] | Returned only when `catalog_type` is `MINI_SERIES`. Details of additional targeting regions. | |
| region_code | string | The region code of the additional targeting region. To find out the corresponding region for a region code, refer to Appendix - Location code. Example: `GB`. | |
| currency | string | Currency for the additional targeting region. For supported currencies, see the Code column in Budget verification ratio and precision of each currency. Example: `GBP`. | |
| page_info | object | Pagination information. | |
| page | number | Current page number. | |
| page_size | number | Page size. | |
| total_number | number | Total number of results. | |
| total_page | number | Total pages of results. | |
| request_id | string | The log id of a request, which uniquely identifies the request. |
Response sample
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {
"page_info": {
"total_number": 14,
"page": 1,
"page_size": 14,
"total_page": 1
},
"list": [
{
"update_time": "2021-07-23 10:34:36",
"catalog_name": "test",
"create_time": "2021-07-23 10:34:36",
"bc_info": {
"bc_id": "{{bc_id}}",
"picture_url": "example URL",
"bc_name": "BC Demo"
},
"catalog_type": "ECOM",
"catalog_id": "{{catalog_id}}",
"ad_creation_eligible": "AVAILABLE",
"catalog_conf": {
"currency": "USD",
"country": "US",
"channel": "CLIENT"
}
},
...
]
},
"request_id": "{{request_id}}"
}
(/code);
Get started
- Sign up for Partner
- Enable a data type of the Ads (Marketing API) group on the platform page
- Create an API key (tick the TikTok Business channel)
- Call it as in the examples above