Get Coupon — TikTok Shop API

tiktok.promotion.202406.coupons.coupon_id

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok/promotion/202406/coupons/100000000000000001" \
  -H "Authorization: Bearer $KEY"

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/tiktok/promotion/202406/coupons/100000000000000001",
    params={},
    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/100000000000000001');
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: 'GET',
  headers: { Authorization: `Bearer ${KEY}` },
});
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/100000000000000001' . '?' . http_build_query([]);
$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)

Response sample

{
  "code": 0,
  "message": "Success",
  "request_id": "DEMO_REQUEST_A_01",
  "data": {
    "coupon": {
      "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
      },
      "display_channels": [
        {}
      ],
      "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
      },
      "usage_stats": {
        "claimed_count": 1,
        "redeemed_count": 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",
      "product_ids": [
        "100000000000000001"
      ],
      "seller_tnc": "Minh họa",
      "creation_source": "Minh họa",
      "live_tasks": [
        {
          "type": "NONE",
          "min_watch_time": "1793491200"
        }
      ]
    }
  }
}

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