VI | EN
Nhắn Messenger
Dành cho developer

Tra cứu affiliate theo mã / tên — API Shopee AMS

v2.ams.query_affiliate_list · gọi qua Quantri360 bằng một API key cho chính tài khoản / tài sản bạn đã kết nối và ủy quyền — 360 lo việc ký request và làm mới phiên đăng nhập bạn đã cấp.

v2.ams.query_affiliate_list

GET/api/v2/ams/query_affiliate_listGọi qua 360: GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/query_affiliate_list
Mô tả API

Tra thông tin affiliate: theo danh sách affiliate_id (hồ sơ đầy đủ — mạng xã hội, lượt theo dõi, lượt nhấp, khoảng đơn / doanh thu 30 ngày, nội dung nổi bật) hoặc tìm theo tên (chỉ trả mã + tên).

  • Dùng tra affiliate_id lấy từ get_affiliate_performance / get_conversion_report / get_targeted_campaign_settings. Mã 0 ("Affiliate Network") không tra được.
  • Tìm theo tên khớp cả user_name (tìm "shopback" ra 9 tài khoản tên khác nhau).

Request

Địa chỉ

GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/query_affiliate_list

Xác thực & gian hàng

TênVị tríKiểuMẫuMô tả
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.

Tham số request

TênVị tríKiểuBắt buộcMẫuMô tả
query_typequeryintCó11 = theo affiliate_id_list · 2 = tìm theo tên (gần đúng), chỉ trả affiliate_id, affiliate_name, user_name.
affiliate_id_listquerystringKhông10000000007,10000000008Khi query_type = 1: mã cách nhau dấu phẩy, tối đa 200 (dư thì lấy 200 mã đầu).
namequerystringKhôngshopbackKhi query_type = 2: tên cần tìm; trả tối đa 200 kết quả.

Ví dụ request

curl -s "https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/query_affiliate_list?query_type=1&affiliate_id_list=10000000007%2C10000000008" \
  -H "Authorization: Bearer $KEY"
Python
import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/query_affiliate_list",
    params={
        "query_type": 1,
        "affiliate_id_list": "10000000007,10000000008"
    },
    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/shopee_ams/api/v2/ams/query_affiliate_list');
for (const [k, v] of Object.entries({"query_type":1,"affiliate_id_list":"10000000007,10000000008"})) 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/shopee_ams/api/v2/ams/query_affiliate_list' . '?' . http_build_query(['query_type' => 1, 'affiliate_id_list' => '10000000007,10000000008']);
$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

Tham số phản hồi (nguyên của Shopee AMS)

TênKiểuMẫuMô tả
request_idstringd52ca43b277a4f9292fb8be658bfd33dMã request của Shopee để tra lỗi.
errorstringMã lỗi Shopee; rỗng = thành công.
messagestringMô tả lỗi.
responseobject
total_countint2Số affiliate trả về (tối đa 200).
affiliate_listobject[]Không phải trường nào cũng có giá trị; query_type = 2 chỉ có 3 trường đầu.
affiliate_idint10000000008Mã affiliate.
affiliate_namestringkoc_mauTên hiển thị.
user_namestringkoc_mauTài khoản Shopee.
portrait_urlstringvn-10000000009-…Mã ảnh đại diện (không phải link đầy đủ).
popular_social_mediaobjectKênh nổi bật nhất: {platform, follower_count} — là OBJECT, không phải mảng.
platformstringNền tảng của tài khoản hoặc nội dung.
follower_countint64Số người theo dõi.
social_mediasobject[]{platform (tiktok / shopee_video / shopee_livestreaming / facebook…), follower_count, social_media_user_name}.
platformstringNền tảng của tài khoản hoặc nội dung.
follower_countint64Số người theo dõi.
social_media_user_namestringTên tài khoản mạng xã hội.
total_clickint299000Lượt nhấp 30 ngày.
order_rangeint[][1000,5000]Khoảng số đơn 30 ngày [từ, đến]; đầu mút −1 = không giới hạn trên (vd [10000,-1]).
gmv_rangeint[][50000,0]Khoảng doanh thu 30 ngày; đầu mút 0 = không giới hạn trên.
is_orange_tick_kolboolfalseCó tích cam.
is_good_fulfillmentboolfalseThực hiện tốt hàng mẫu miễn phí (180 ngày).
promote_category_idsint[][100630,100017]Ngành hàng quảng bá nhiều nhất.
top_popular_contentsobject[]{platform, view_count, like_count, comment_count, cover_url, media_url} — có thể là [{}].
platformstringNền tảng của tài khoản hoặc nội dung.
comment_countint64Số bình luận.
like_countint64Số lượt thích.
view_countint64Số lượt xem.
cover_urlstringĐường dẫn ảnh bìa.
media_urlstringĐường dẫn nội dung.
top_selling_productsobject[]{item_id}.
item_idint64Mã sản phẩm.

Mẫu phản hồi

{
  "request_id": "e3e3e7f35ef7b5fc…",
  "error": "",
  "message": "",
  "response": {
    "total_count": 2,
    "affiliate_list": [
      {
        "affiliate_id": 10000000007,
        "affiliate_name": "koc_mau",
        "user_name": "koc_mau",
        "portrait_url": "e4fd3e93b4648763…",
        "popular_social_media": {
          "platform": "shopee_video",
          "follower_count": 6
        },
        "social_medias": [
          {
            "platform": "shopee_video",
            "follower_count": 6,
            "social_media_user_name": "koc_mau"
          }
        ],
        "total_click": 3554000,
        "order_range": [
          10000,
          -1
        ],
        "gmv_range": [
          50000,
          0
        ],
        "is_orange_tick_kol": false,
        "is_good_fulfillment": false,
        "promote_category_ids": [
          100636,
          100630,
          100629,
          100017,
          100632
        ],
        "top_popular_contents": [
          {}
        ],
        "top_selling_products": [
          {
            "item_id": 10000000010
          }
        ]
      },
      {
        "affiliate_id": 10000000008,
        "affiliate_name": "koc_live",
        "user_name": "koc_live",
        "portrait_url": "vn-10000000009-…",
        "popular_social_media": {
          "platform": "shopee_livestreaming",
          "follower_count": 385769
        },
        "social_medias": [
          {
            "platform": "tiktok",
            "follower_count": 108500,
            "social_media_user_name": "koc_live_tt"
          },
          {
            "platform": "shopee_livestreaming",
            "follower_count": 385769,
            "social_media_user_name": "koc_live"
          }
        ],
        "total_click": 299000,
        "order_range": [
          1000,
          5000
        ],
        "gmv_range": [
          50000,
          0
        ],
        "is_orange_tick_kol": false,
        "is_good_fulfillment": false,
        "promote_category_ids": [
          100630,
          100017,
          100636,
          100629,
          100011
        ],
        "top_popular_contents": [
          {
            "platform": "shopee_livestreaming",
            "comment_count": 4197,
            "like_count": 364854,
            "view_count": 1626778,
            "cover_url": "…",
            "media_url": "…"
          }
        ],
        "top_selling_products": [
          {
            "item_id": 10000000011
          }
        ]
      }
    ]
  }
}

Mã lỗi của Shopee AMS (6)

Bấm để xem
MãÝ nghĩa
error_paramTham số sai / thiếu / sai kiểu — xem `message` để biết tham số nào.
error_authỦy quyền gian hàng cho 360 đã hết hạn hoặc bị thu hồi (360 đã tự làm mới token một lần) — chủ gian hàng kết nối lại Shopee trong Partner.
error_limitChạm hạn mức gọi Shopee trong ngày của kết nối — 360 trả kèm thời điểm thử lại; giảm tần suất gọi.
error_rate_limitGọi quá nhanh — chờ vài giây rồi gọi lại (360 cũng giới hạn theo key: 429 + Retry-After).
shop_bannedGian hàng đang bị Shopee khóa — mọi API tạm ngưng tới khi gỡ khóa.
error_kyc_authGian hàng chưa hoàn tất đăng ký người bán trên Kênh Người Bán.

Bắt đầu dùng

  1. Đăng ký tài khoản Partner
  2. Mở loại dữ liệu thuộc nhóm Affiliate ở trang nền tảng
  3. Tạo API key (tick kênh Shopee AMS)
  4. Gọi theo ví dụ ở trên