VI | EN
Message us on Messenger
Developer resources

Get Affiliate Partner Campaign List — TikTok Shop API

tiktok.affiliate_partner.202405.campaigns · 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.

tiktok.affiliate_partner.202405.campaigns

GET/affiliate_partner/202405/campaignsVia 360: GET https://partner.quantri360.com/v1/tiktok/affiliate_partner/202405/campaigns
Description

DÀNH CHO ĐỐI TÁC AFFILIATE: Liệt kê chiến dịch affiliate theo loại, tình trạng tham gia và trạng thái chiến dịch.

  • HIỆN CHƯA GỌI ĐƯỢC QUA 360: API này dùng kết nối của creator / đối tác, kết nối gian hàng trả code 36009005. Cần dùng → liên hệ 360.
  • API chỉ đọc; code = 0 mới là thành công.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok/affiliate_partner/202405/campaigns

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_idquerystring100001Gian 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

NameInTypeRequiredSampleDescription
category_asset_cipherquerystringYesCATEGORY_ASSET_DEMOMã tài sản danh mục đã ủy quyền cho đối tác; dùng đúng mã của kết nối đối tác.
page_sizequeryintYes20Số kết quả mỗi trang: 1–100.
page_tokenquerystringNoCon trỏ next_page_token trả về trang trước; bỏ ở trang đầu. Khi sang trang, giữ nguyên các bộ lọc và page_size.
statusquerystringNoREADYTrạng thái chiến dịch: READY, UPCOMING, ONGOING, CLOSED hoặc UNSPECIFIED; cần gửi trường này để lọc trạng thái.
typequerystringNoMY_CAMPAIGNSLoại chiến dịch: MY_CAMPAIGNS (mặc định), GS_SELLING_CAMPAIGNS, SELLER_CAMPAIGNS hoặc EXCLUSIVE_TIKTOK_SHOP.
query_type_filterquerystringNoSELLER_CAMPAIGNSVới SELLER_CAMPAIGNS: bắt buộc MARKETPLACE (chưa tham gia, status = UNSPECIFIED) hoặc JOINED. Với EXCLUSIVE_TIKTOK_SHOP: bắt buộc AVAILABLE hoặc JOINED, status = UNSPECIFIED. Với MY_CAMPAIGNS / GS_SELLING_CAMPAIGNS: bỏ qua hoặc DEFAULT.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok/affiliate_partner/202405/campaigns?category_asset_cipher=CATEGORY_ASSET_DEMO&page_size=20&status=ONGOING&type=MY_CAMPAIGNS" \
  -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/affiliate_partner/202405/campaigns",
    params={
        "category_asset_cipher": "CATEGORY_ASSET_DEMO",
        "page_size": 20,
        "status": "ONGOING",
        "type": "MY_CAMPAIGNS"
    },
    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_partner/202405/campaigns');
for (const [k, v] of Object.entries({"category_asset_cipher":"CATEGORY_ASSET_DEMO","page_size":20,"status":"ONGOING","type":"MY_CAMPAIGNS"})) 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/affiliate_partner/202405/campaigns' . '?' . http_build_query(['category_asset_cipher' => 'CATEGORY_ASSET_DEMO', 'page_size' => 20, 'status' => 'ONGOING', 'type' => 'MY_CAMPAIGNS']);
$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 Shop)

NameTypeSampleDescription
codeint0Mã kết quả; 0 là thành công.
messagestringSuccessThông báo kết quả.
request_idstringDEMO_AFFILIATE_REQUESTMã truy vết yêu cầu.
dataobjectDữ liệu phản hồi.
campaigns[]objectDanh sách chiến dịch.
idstring100000000000000101Mã định danh. Giá trị bổ sung: SUCCEEDED, GET.
namestringChiến dịch minh họaTên.
statusstringREADYTrạng thái. Giá trị: READY, UPCOMING, ONGOING, CLOSED.
registration_start_timeint1893456000Đăng ký bắt đầu thời điểm. Giá trị: READY, UPCOMING. Mốc Unix giây.
registration_end_timeint1893888000Đăng ký kết thúc thời điểm. Giá trị: CLOSED. Mốc Unix giây.
campaign_start_timeint1893456000Chiến dịch bắt đầu thời điểm. Giá trị: READY, UPCOMING. Mốc Unix giây.
campaign_end_timeint1894320000Chiến dịch kết thúc thời điểm. Giá trị: CLOSED. Mốc Unix giây.
next_page_tokenstringCon trỏ trang kế tiếp; rỗng khi hết dữ liệu.
total_countint1Tổng số kết quả.

Response sample

{
  "code": 0,
  "message": "Success",
  "request_id": "DEMO_AFFILIATE_REQUEST",
  "data": {
    "campaigns": [
      {
        "id": "100000000000000101",
        "name": "Chiến dịch minh họa",
        "status": "READY",
        "registration_start_time": 1893456000,
        "registration_end_time": 1893888000,
        "campaign_start_time": 1893456000,
        "campaign_end_time": 1894320000
      }
    ],
    "next_page_token": "",
    "total_count": 1
  }
}

Get started

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