tiktok.affiliate_seller.202603.compass.offline_task
POST/affiliate_seller/202603/compass/offline_taskVia 360: POST https://partner.quantri360.com/v1/tiktok/affiliate_seller/202603/compass/offline_task
Write endpoint — changes data on TikTok Shop. The key must be created with "Allow write API calls" ticked, otherwise you get 403 write_not_allowed. Every call is logged.
Description
Tạo tác vụ xuất dữ liệu Compass bất đồng bộ theo loại dữ liệu, kế hoạch và khoảng thời gian; lấy task_id để tra trạng thái và tải kết quả.
- Gọi qua /v1/tiktok/affiliate_seller/202603/compass/offline_task với Authorization: Bearer <key>; dùng platform_shop_id khi có nhiều shop. 360 tự gắn app_key, shop_cipher, sign và access_token.
- API GHI: thay đổi dữ liệu thật trên TikTok Shop; cần key có quyền ghi (can_write) và gói mở module affiliate. Tạo tác vụ xuất dữ liệu Compass bất đồng bộ theo loại dữ liệu, kế hoạch và khoảng thời gian; lấy task_id để tra trạng thái và tải kết quả.
- HTTP 200 vẫn có thể có lỗi nghiệp vụ; kiểm code trước khi dùng kết quả.
Request
Endpoint
POST https://partner.quantri360.com/v1/tiktok/affiliate_seller/202603/compass/offline_task
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 | 100001 | Gian hàng (lấy ở GET /v1/platforms → shops[].platform_shop_id). BẮT BUỘC khi brand có > 1 gian hàng trên nền tảng; 360 bỏ tham số này trước khi chuyển tiếp. |
Request parameters
| Name | In | Type | Required | Sample | Description |
|---|---|---|---|---|---|
| module_type | body | string | No | CREATOR | Loại dữ liệu Compass xuất: CREATOR danh sách creator; BASE chỉ số hiệu quả chính. |
| window_type | body | string | No | PAST_7_DAYS | Cửa sổ thời gian kết thúc tại end_day: PAST_24H, PAST_7_DAYS hoặc PAST_30_DAYS. |
| end_day | body | int | No | 20261001 | Ngày kết thúc dạng YYYYMMDD theo múi giờ vùng: id/vn/th UTC+7; my/sg/ph UTC+8; sa UTC+3; us UTC-8; mx UTC-6; br UTC-3; jp UTC+9; gb/ie/pt UTC+0; es/de/fr/it/pl/nl/be/cz/at/hu UTC+1; gr UTC+2. |
| plan_type | body | string | No | ALL | Loại kế hoạch: ALL, TARGET, OPEN hoặc PARTNER. |
Request examples
curl -s -X POST "https://partner.quantri360.com/v1/tiktok/affiliate_seller/202603/compass/offline_task" \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{"module_type":"CREATOR","window_type":"PAST_7_DAYS","end_day":20261001,"plan_type":"ALL"}'
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.post(
"https://partner.quantri360.com/v1/tiktok/affiliate_seller/202603/compass/offline_task",
params={},
json={
"module_type": "CREATOR",
"window_type": "PAST_7_DAYS",
"end_day": 20261001,
"plan_type": "ALL"
},
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/affiliate_seller/202603/compass/offline_task');
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({"module_type":"CREATOR","window_type":"PAST_7_DAYS","end_day":20261001,"plan_type":"ALL"}),
});
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/affiliate_seller/202603/compass/offline_task' . '?' . 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, '{"module_type":"CREATOR","window_type":"PAST_7_DAYS","end_day":20261001,"plan_type":"ALL"}');
$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 Shop)
| Name | Type | Sample | Description |
|---|---|---|---|
| code | int | 0 | Mã kết quả; 0 là thành công. |
| message | string | Success | Thông báo kết quả. |
| request_id | string | DEMO_AFFILIATE_REQUEST | Mã truy vết yêu cầu. |
| data | object | Dữ liệu phản hồi. | |
| task | object | Tác vụ. | |
| id | string | 100000000000000101 | Mã định danh. Giá trị bổ sung: SUCCEEDED, GET. |
Response sample
{
"code": 0,
"message": "Success",
"request_id": "DEMO_AFFILIATE_REQUEST",
"data": {
"task": {
"id": "100000000000000101"
}
}
}
Get started
- Sign up for Partner
- Enable a data type of the Affiliate group on the platform page
- Create an API key (tick the TikTok Shop channel)
- Call it as in the examples above