Search Creator Affiliate Orders — TikTok Shop API

tiktok.affiliate_creator.202410.orders.search

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s -X POST "https://partner.quantri360.com/v1/tiktok/affiliate_creator/202410/orders/search?page_size=20" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.post(
    "https://partner.quantri360.com/v1/tiktok/affiliate_creator/202410/orders/search",
    params={
        "page_size": 20
    },
    json={},
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())

const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok/affiliate_creator/202410/orders/search');
for (const [k, v] of Object.entries({"page_size":20})) 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({}),
});
console.log(r.status, await r.json());

<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok/affiliate_creator/202410/orders/search' . '?' . http_build_query(['page_size' => 20]);
$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, '{}');
$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)

Response sample

{
  "code": 0,
  "message": "Success",
  "request_id": "DEMO_AFFILIATE_REQUEST",
  "data": {
    "orders": [
      {
        "id": "100000000000000101",
        "create_time": 1790812800,
        "delivery_time": 1790812800,
        "status": "UNSPECIFIED",
        "skus": [
          {
            "id": "100000000000000101",
            "campaign_id": "100000000000000101",
            "open_collaboration_id": "100000000000000101",
            "target_collaboration_id": "100000000000000101",
            "product_name": "Minh họa",
            "product_id": "100000000000000101",
            "price": {
              "amount": "10000",
              "currency": "VND"
            },
            "shop_name": "Gian hàng minh họa",
            "content_type": "VIDEO",
            "content_id": "100000000000000101",
            "quantity": 1,
            "commission_rate": 1000,
            "commission_tier_setting": "-",
            "commission_model": "Fixed commission",
            "commission_bonus_rate": 1000,
            "estimated_commission_base": {
              "amount": "10000",
              "currency": "VND"
            },
            "standard_commission_rate": 1000,
            "shop_ads_commission_rate": 1000,
            "estimated_bonus_commission": {
              "amount": "10000",
              "currency": "VND"
            },
            "estimated_standard_commission": {
              "amount": "10000",
              "currency": "VND"
            },
            "estimated_shop_ads_commission": {
              "amount": "10000",
              "currency": "VND"
            },
            "estimated_commission": {
              "amount": "10000",
              "currency": "VND"
            },
            "actual_commission": {
              "amount": "10000",
              "currency": "VND"
            },
            "actual_bonus_commission": {
              "amount": "10000",
              "currency": "VND"
            },
            "actual_commission_base": {
              "amount": "10000",
              "currency": "VND"
            },
            "actual_standard_commission": {
              "amount": "10000",
              "currency": "VND"
            },
            "actual_shop_ads_commission": {
              "amount": "10000",
              "currency": "VND"
            },
            "returned_quantity": 1,
            "refunded_quantity": 1,
            "tag": "Minh họa",
            "creator_commission_reward_rate": 1000,
            "estimated_creator_commission_reward_fee": {
              "amount": "10000",
              "currency": "VND"
            },
            "actual_creator_commission_reward_fee": {
              "amount": "10000",
              "currency": "VND"
            },
            "isr": {
              "amount": "10000",
              "currency": "VND"
            },
            "iva": {
              "amount": "10000",
              "currency": "VND"
            },
            "pit": {
              "amount": "10000",
              "currency": "VND"
            },
            "shared_with_partner": {
              "amount": "10000",
              "currency": "VND"
            },
            "trace_info": {
              "id": "100000000000000101",
              "type": "Minh họa"
            },
            "last_update_time": 1790812800,
            "is_carousel": false
          }
        ]
      }
    ],
    "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