VI | EN
Message us on Messenger
Developer resources

Get catalogs — TikTok Business API

Get catalogs · 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 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

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.
catalog_idquerystringNoCatalog ID. If not specified, all catalogs will be returned.
pagequerynumberNoCurrent number of pages. Default value: 1. Value range: ≥ 1.
page_sizequerynumberNoPage 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)

NameTypeSampleDescription
codenumberReturn code. For the complete list of response codes and descriptions, see Appendix - return codes.
messagestringReturn message. For details, see Appendix-Return codes.
dataobjectReturned data.
listobject[]Catalog list.
catalog_idstringCatalog ID.
catalog_namestringCatalog name.
catalog_typestringCatalog 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_eligiblestringWhether 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_timestringCreation time.
update_timestringUpdate time.
bc_infoobjectInformation about Business Center.
bc_idstringBusiness Center ID.
bc_namestringBusiness Center name.
picture_urlstringURL of the profile image. An empty value is returned if the Business Center doesn't have a profile image.
catalog_confobjectCatalog configuration information.
countrystringThe region code of the primary targeting region. To find out the corresponding region for a region code, refer to Appendix - Location code. Example: `US`.
currencystringCurrency for the primary targeting region. For supported currencies, see the Code column in Budget verification ratio and precision of each currency. Example: `USD`.
channelstringChannel for creating the catalog. Enum values: - `PARTNER`: Partners. - `CLIENT`: Direct advertisers.
additional_config_listobject[]Returned only when `catalog_type` is `MINI_SERIES`. Details of additional targeting regions.
region_codestringThe region code of the additional targeting region. To find out the corresponding region for a region code, refer to Appendix - Location code. Example: `GB`.
currencystringCurrency for the additional targeting region. For supported currencies, see the Code column in Budget verification ratio and precision of each currency. Example: `GBP`.
page_infoobjectPagination information.
pagenumberCurrent page number.
page_sizenumberPage size.
total_numbernumberTotal number of results.
total_pagenumberTotal pages of results.
request_idstringThe 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

  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