Search Coupon List — TikTok Shop API

tiktok.promotion.202406.coupons.search

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s -X POST "https://partner.quantri360.com/v1/tiktok/promotion/202406/coupons/search?page_token=&page_size=10" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":["NOT_START"],"title_keyword":"Minh họa","display_type":["Minh họa"]}'

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.post(
    "https://partner.quantri360.com/v1/tiktok/promotion/202406/coupons/search",
    params={
        "page_token": "",
        "page_size": 10
    },
    json={
        "status": [
            "NOT_START"
        ],
        "title_keyword": "Minh họa",
        "display_type": [
            "Minh họa"
        ]
    },
    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/202406/coupons/search');
for (const [k, v] of Object.entries({"page_token":"","page_size":10})) 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"],"title_keyword":"Minh họa","display_type":["Minh họa"]}),
});
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/202406/coupons/search' . '?' . http_build_query(['page_token' => '', 'page_size' => 10]);
$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"],"title_keyword":"Minh họa","display_type":["Minh họa"]}');
$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": "",
    "coupons": [
      {
        "id": "100000000000000001",
        "title": "Minh họa",
        "display_type": "Minh họa",
        "status": "NOT_START",
        "create_time": 1793491200,
        "update_time": 1793491200,
        "claim_duration": {
          "start_time": 1793491200,
          "end_time": 1793577600
        },
        "redemption_duration": {
          "type": "ABSOLUTE",
          "start_time": 1793491200,
          "end_time": 1793577600,
          "relative_time": 1793491200
        },
        "promo_code": "Minh họa",
        "target_buyer_segment": "Minh họa",
        "usage_limits": {
          "single_buyer_claim_limit": 1,
          "total_claim_limit": 1,
          "redemption_limit": 1
        },
        "discount": {
          "type": "AMOUNT_OFF",
          "reduction_amount": {
            "amount": "10000",
            "currency": "VND"
          },
          "percentage": "0.1",
          "max_discount": {
            "amount": "10000",
            "currency": "VND"
          }
        },
        "threshold": {
          "type": "NONE",
          "min_spend": {
            "amount": "10000",
            "currency": "VND"
          }
        },
        "product_scope": "Minh họa",
        "creation_source": "Minh họa"
      }
    ]
  }
}

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