Search Promotion Activities — TikTok Shop API

tiktok.promotion.202309.activities.search

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s -X POST "https://partner.quantri360.com/v1/tiktok/promotion/202309/activities/search" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"NOT_START","activity_title":"Minh họa","page_size":10,"page_token":"","activity_type":"FIXED_PRICE"}'

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.post(
    "https://partner.quantri360.com/v1/tiktok/promotion/202309/activities/search",
    params={},
    json={
        "status": "NOT_START",
        "activity_title": "Minh họa",
        "page_size": 10,
        "page_token": "",
        "activity_type": "FIXED_PRICE"
    },
    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/promotion/202309/activities/search');
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({"status":"NOT_START","activity_title":"Minh họa","page_size":10,"page_token":"","activity_type":"FIXED_PRICE"}),
});
console.log(r.status, await r.json());

<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok/promotion/202309/activities/search' . '?' . 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, '{"status":"NOT_START","activity_title":"Minh họa","page_size":10,"page_token":"","activity_type":"FIXED_PRICE"}');
$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_REQUEST_A_01",
  "data": {
    "total_count": 1,
    "next_page_token": "",
    "activities": [
      {
        "id": "100000000000000001",
        "title": "Minh họa",
        "activity_type": "FIXED_PRICE",
        "duration_type": "NORMAL",
        "begin_time": 1793491200,
        "end_time": 1793577600,
        "status": "DRAFT",
        "create_time": 1793491200,
        "update_time": 1793491200,
        "product_level": "PRODUCT",
        "activity_commands": [
          "Minh họa"
        ],
        "participation_limit": [
          {
            "type": "BUYER_NO_LIMIT"
          }
        ],
        "discount": {
          "shipping_discount": {
            "threshold_type": "NO_THRESHOLD",
            "threshold_value": "Minh họa",
            "type": "FREE_SHIPPING",
            "value": "10000",
            "shipping_method": "STANDARD_SHIPPING",
            "inventory_type": "SELF_FULFILLED",
            "area_scope": {
              "type": "WHOLE",
              "specific_areas": [
                "Minh họa"
              ]
            }
          },
          "bmsm_discount": {
            "details": [
              {
                "tier": 1,
                "threshold_type": "NO_THRESHOLD",
                "threshold_value": "Minh họa",
                "type": "PERCENTAGE_OFF",
                "value": "10000"
              }
            ]
          },
          "gift_discount": {
            "gift_receiving_type": "ALL_RECEIVE",
            "gift_infos": [
              {
                "tier": 1,
                "threshold_type": "NO_THRESHOLD",
                "threshold_value": "Minh họa",
                "gift_details": [
                  {
                    "product_id": "100000000000000001",
                    "sku_id": "100000000000000001",
                    "total_claim_limit": "Minh họa"
                  }
                ]
              }
            ]
          },
          "bxgy_discount": {
            "threshold_type": "NO_THRESHOLD",
            "threshold_value": "Minh họa",
            "discount_type": "PERCENTAGE_OFF",
            "discount_value": "Minh họa",
            "benefit_max_applicable_quantity": "Minh họa",
            "benefit_max_applicable_times": "1793491200"
          }
        },
        "auction_support_type": "ALL"
      }
    ]
  }
}

Get started

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