v2.ams.get_affiliate_performance
GET/api/v2/ams/get_affiliate_performanceGọi qua 360: GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_affiliate_performance
Mô tả API
Hiệu quả TỪNG AFFILIATE (KOC / đối tác tiếp thị liên kết) theo kỳ: doanh thu, đơn, sản phẩm bán, lượt nhấp, hoa hồng ước tính, ROI, người mua (mới). Dùng xếp hạng KOC mang đơn về.
- Dòng affiliate_id = 0 ("Affiliate Network") là gộp đơn từ mạng đối tác — không tra được bằng query_affiliate_list.
- Tra chi tiết affiliate (mạng xã hội, lượt theo dõi) bằng query_affiliate_list với affiliate_id.
- page_size tối đa 20.
Request
Địa chỉ
GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_affiliate_performance
Xác thực & gian hàng
| Tên | Vị trí | Kiểu | Mẫu | Mô tả |
|---|---|---|---|---|
| Authorization | header | header | Bearer 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_id | query | string | 100001 | Gian 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ên | Vị trí | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|---|
| period_type | query | string | Có | Last30d | Day · Week · Month · Last7d · Last30d — quy tắc ngày như get_shop_performance. |
| start_date | query | string | Có | 20260929 | YYYYMMDD. |
| end_date | query | string | Có | 20261028 | YYYYMMDD. |
| order_type | query | string | Có | ConfirmedOrder | PlacedOrder · ConfirmedOrder. |
| channel | query | string | Có | AllChannel | AllChannel · SocialMedia · ShopeeVideo · LiveStreaming. |
| page_no | query | int | Có | 1 | Trang, từ 1. |
| page_size | query | int | Có | 20 | Tối đa 20. |
| affiliate_id | query | int | Không | 10000000007 | Chỉ xem một affiliate. |
Phân trang
Tăng page_no khi response.has_more = true.
Ví dụ request
curl -s "https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_affiliate_performance?period_type=Last30d&start_date=20260929&end_date=20261028&order_type=ConfirmedOrder&channel=AllChannel&page_no=1&page_size=20" \ -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/get_affiliate_performance",
params={
"period_type": "Last30d",
"start_date": "20260929",
"end_date": "20261028",
"order_type": "ConfirmedOrder",
"channel": "AllChannel",
"page_no": 1,
"page_size": 20
},
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/get_affiliate_performance');
for (const [k, v] of Object.entries({"period_type":"Last30d","start_date":"20260929","end_date":"20261028","order_type":"ConfirmedOrder","channel":"AllChannel","page_no":1,"page_size":20})) 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/get_affiliate_performance' . '?' . http_build_query(['period_type' => 'Last30d', 'start_date' => '20260929', 'end_date' => '20261028', 'order_type' => 'ConfirmedOrder', 'channel' => 'AllChannel', 'page_no' => 1, 'page_size' => 20]); $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ên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| request_id | string | d52ca43b277a4f9292fb8be658bfd33d | Mã request của Shopee để tra lỗi. |
| error | string | Mã lỗi Shopee; rỗng = thành công. | |
| message | string | Mô tả lỗi. | |
| response | object | ||
| total_count | int | 312 | Tổng affiliate có số liệu. |
| has_more | bool | true | |
| list | object[] | Sắp theo doanh thu giảm dần. | |
| affiliate_id | int | 10000000007 | Mã affiliate (0 = gộp "Affiliate Network" — đơn từ mạng đối tác, không tách từng người). |
| affiliate_name | string | koc_mau | Tên hiển thị. |
| affiliate_username | string | koc_mau | Tên tài khoản Shopee. |
| sales | string | 8820092 | Doanh thu (VND, chuỗi). |
| orders | int | 26 | Số đơn. |
| items_sold | int | 38 | Sản phẩm bán. |
| clicks | int | 92 | Lượt nhấp. |
| est_commission | string | 166691.05 | Hoa hồng ước tính (VND, chuỗi). |
| roi | string | 52.9 | sales ÷ est_commission ("--" nếu không tính được). |
| total_buyers | int | 21 | Người mua. |
| new_buyers | int | 13 | Người mua mới. |
| fetched_date_range | string | 20260929-20261028 | Khoảng ngày thực tính. |
Mẫu phản hồi
{
"error": "",
"message": "",
"request_id": "e3e3e7f35ef7a6a7…",
"response": {
"has_more": true,
"list": [
{
"affiliate_id": 0,
"affiliate_name": "Affiliate Network",
"affiliate_username": "Affiliate Network",
"sales": "1680000",
"items_sold": 74,
"orders": 50,
"clicks": 1081,
"est_commission": "193206.24",
"roi": "91.0",
"total_buyers": 48,
"new_buyers": 13
},
{
"affiliate_id": 10000000032,
"affiliate_name": "koc_mau",
"affiliate_username": "koc_mau",
"sales": "6368944",
"items_sold": 26,
"orders": 14,
"clicks": 727,
"est_commission": "127378.88",
"roi": "50.0",
"total_buyers": 13,
"new_buyers": 10
}
],
"fetched_date_range": "20260929-20261028",
"total_count": 312
}
}
Mã lỗi của Shopee AMS (7)
Bấm để xem
| Mã | Ý nghĩa |
|---|---|
| error_param | Tham số sai / thiếu / sai kiểu — xem `message` để biết tham số nào. |
| error_server | Lỗi hệ thống Shopee — thử lại sau ít phút. |
| 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_limit | Chạ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_limit | Gọ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_banned | Gian hàng đang bị Shopee khóa — mọi API tạm ngưng tới khi gỡ khóa. |
| error_kyc_auth | Gian 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
- Đăng ký tài khoản Partner
- Mở loại dữ liệu thuộc nhóm Affiliate ở trang nền tảng
- Tạo API key (tick kênh Shopee AMS)
- Gọi theo ví dụ ở trên