v2.ams.get_shop_performance
GET/api/v2/ams/get_shop_performanceGọi qua 360: GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_shop_performance
Mô tả API
Chỉ số tổng của Tiếp thị liên kết cho cả gian hàng trong một kỳ: doanh thu, số đơn, sản phẩm bán, lượt nhấp, hoa hồng ước tính, ROI, người mua (mới). Lọc theo kênh (mạng xã hội / Shopee Video / Live). Dùng cho thẻ KPI affiliate.
- Ngày dạng "2026-10-27" →
error_param"invalid time range, detail:parsing time …". Phải là "20261027". - Kiểm thật: Week với start_date không phải Chủ nhật → "start_date must be Sunday for Week period type"; Day với end_date ≠ start_date → "end_date must equal start_date for Day period type"; Day quá 3 tháng → "start_date must be within past three calendar months".
- Last7d / Last30d / Month KHÔNG báo lỗi khi ngày lệch mà tự dời (vd Last7d gửi 20261001–20261028 → fetched_date_range "20261022-20261028"; Month tháng hiện tại gửi end 20261031 → kẹp về last_report_date).
- channel sai →
error_param"invalid channel". - Tiền là CHUỖI — ép số trước khi cộng.
Request
Địa chỉ
GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_shop_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. |
| start_date | query | string | Có | 20260929 | YYYYMMDD (KHÔNG gạch nối). Day: một ngày trong 3 tháng dương lịch gần nhất · Week: Chủ nhật · Month: ngày 1 · Last7d: last_report_date − 6 ngày · Last30d: last_report_date − 29 ngày. |
| end_date | query | string | Có | 20261028 | YYYYMMDD. Day: bằng start_date · Week: thứ Bảy · Month: ngày cuối tháng (tháng hiện tại: last_report_date) · Last7d / Last30d: last_report_date. |
| order_type | query | string | Có | ConfirmedOrder | PlacedOrder (mọi đơn đã đặt, kể cả chưa thanh toán) · ConfirmedOrder (đơn đã thanh toán, hoặc COD đã xác nhận giao — thường ~30 phút sau khi đặt). |
| channel | query | string | Có | AllChannel | AllChannel · SocialMedia · ShopeeVideo · LiveStreaming. |
Ví dụ request
curl -s "https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_shop_performance?period_type=Last30d&start_date=20260929&end_date=20261028&order_type=ConfirmedOrder&channel=AllChannel" \ -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_shop_performance",
params={
"period_type": "Last30d",
"start_date": "20260929",
"end_date": "20261028",
"order_type": "ConfirmedOrder",
"channel": "AllChannel"
},
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_shop_performance');
for (const [k, v] of Object.entries({"period_type":"Last30d","start_date":"20260929","end_date":"20261028","order_type":"ConfirmedOrder","channel":"AllChannel"})) 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_shop_performance' . '?' . http_build_query(['period_type' => 'Last30d', 'start_date' => '20260929', 'end_date' => '20261028', 'order_type' => 'ConfirmedOrder', 'channel' => 'AllChannel']); $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 | ||
| sales | string | 1660000 | Doanh thu đơn affiliate (VND, CHUỖI). |
| orders | int | 523 | Số đơn. |
| gross_item_sold | int | 791 | Số sản phẩm bán. |
| clicks | int | 21726 | Lượt nhấp link sản phẩm. |
| est_commission | string | 2344750.52 | Hoa hồng ước tính phải trả (VND, chuỗi, có phần lẻ). |
| roi | string | 76.4 | ROI = sales ÷ est_commission (chuỗi; "--" khi không tính được). |
| total_buyers | int | 459 | Số người mua. |
| new_buyers | int | 198 | Người mua mới của shop. |
| fetched_date_range | string | 20260929-20261028 | Khoảng ngày THỰC SỰ được tính — đọc lại trường này vì ngày gửi sai có thể bị tự dời. |
Mẫu phản hồi
{
"error": "",
"message": "",
"request_id": "e3e3e7f35ef7a13a…",
"response": {
"sales": "1660000",
"gross_item_sold": 791,
"orders": 523,
"clicks": 21726,
"est_commission": "2344750.52",
"roi": "76.4",
"total_buyers": 459,
"new_buyers": 198,
"fetched_date_range": "20260929-20261028"
}
}
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