Developer resources

Create an asynchronous download task for catalog product diagnostic information — TikTok Business API

Create an asynchronous download task for catalog product diagnostic information · 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.

Open in the API index TikTok Business platform page

Create an asynchronous download task for catalog product diagnostic information

POST/diagnostic/catalog/product/task/create/Via 360: POST https://partner.quantri360.com/v1/tiktok_business/diagnostic/catalog/product/task/create/

Write endpoint — changes data on TikTok Business. The key must be created with "Allow write API calls" ticked, otherwise you get 403 write_not_allowed. Every call is logged.

Description

Use this endpoint to create an asynchronous download task for catalog product diagnostic information.

After the task is created, use /diagnostic/catalog/product/task/get/ to download the resulting CSV file. Note that the diagnostic information provided by the asynchronous download task is less detailed than the synchronous catalog diagnostic information provided by the endpoint /diagnostic/catalog/. The asynchronous download task only returns the Product ID (product_id), SKU ID (sku_id / hotel_id / flight_id / destination_id), Item title (title), Issue title (issue_title), Severity (issue_level), and Source (feed name) for each issue.

Request

Endpoint

POST https://partner.quantri360.com/v1/tiktok_business/diagnostic/catalog/product/task/create/

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	Description
catalog_id	body	string	Yes	ID of a catalog that you have permission to access.
bc_id	body	string	Yes	ID of a Business Center that either owns the catalog, or has been granted access to it as an asset.
feed_id	body	string	No	Feed ID. If not specified, the ID of the default feed for the catalog will be used. To retrieve the diagnostics for all feeds for the catalog, set this field to `ALL`. To obtain feed IDs for a catalog, use /catalog/feed/get/.
lang	body	string	No	The language you want to set for the returned catalog diagnostic information. Default value: `en`. To find out the enum values, refer to the Enum values for `lang` section below.
issue_id	body	string	No	The ID of the issue you want to download the diagnostic information for. You need to specify the ID of a downloadable issue, which can be selected from the Downloadable issues section below. If not specified, the diagnostics for all detected issues will be returned.

Request examples

curl -s -X POST "https://partner.quantri360.com/v1/tiktok_business/diagnostic/catalog/product/task/create/" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"catalog_id":"","bc_id":""}'

Python

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.post(
    "https://partner.quantri360.com/v1/tiktok_business/diagnostic/catalog/product/task/create/",
    params={},
    json={
        "catalog_id": "",
        "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/diagnostic/catalog/product/task/create/');
for (const [k, v] of Object.entries({})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
  method: 'POST',
  headers: { Authorization: `Bearer ${KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({"catalog_id":"","bc_id":""}),
});
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/diagnostic/catalog/product/task/create/' . '?' . http_build_query([]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key, 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"catalog_id":"","bc_id":""}');
$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	Description
code	number	Response code. For the complete list of response codes and descriptions, see Appendix-Return Code.
message	string	Response message. For details, see Appendix - Return Codes.
request_id	string	The log ID of a request, which uniquely identifies the request.
data	object	Returned data.
task_id	string	ID of the download task for catalog diagnostic information.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "task_id": "{{task_id}}"
    }
}

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