v2.payment.get_income_overview
GET/api/v2/payment/get_income_overviewVia 360: GET https://partner.quantri360.com/v1/shopee/api/v2/payment/get_income_overview
Description
Tổng quan tiền của gian hàng tại thời điểm gọi (như khối "Tổng quan" mục Doanh thu trên Kênh Người Bán): tổng tiền đang chờ quyết toán và tổng tiền đã thanh toán. Dùng làm số kiểm tra nhanh / van an toàn khi đồng bộ get_income_detail.
- Không có tham số ngày: luôn là ảnh chụp hiện tại, không lấy được số của quá khứ — muốn theo kỳ thì tự lưu hằng ngày hoặc dùng get_income_detail.
- Truyền income_status chỉ trả trường tương ứng (vd income_status = 1 → chỉ có released_amount).
Request
Endpoint
GET https://partner.quantri360.com/v1/shopee/api/v2/payment/get_income_overview
Authentication & shop
| Name | In | Type | Sample | Description |
|---|---|---|---|---|
| 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. |
Request parameters
| Name | In | Type | Required | Sample | Description |
|---|---|---|---|---|---|
| income_status | query | int | No | 1 | Lọc một loại: 1 = Đã thanh toán · 2 = Đang chờ. Bỏ trống = trả cả hai. |
Request examples
curl -s "https://partner.quantri360.com/v1/shopee/api/v2/payment/get_income_overview" \ -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/api/v2/payment/get_income_overview",
params={},
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/api/v2/payment/get_income_overview');
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
<?php $key = 'q360_live_...'; // khóa API của brand $url = 'https://partner.quantri360.com/v1/shopee/api/v2/payment/get_income_overview' . '?' . 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 Shopee)
| Name | Type | Sample | Description |
|---|---|---|---|
| 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_income | object | ||
| pending_amount | float | 1560000 | Tổng tiền đơn chưa quyết toán (VND) = tổng estimated_escrow_amount của get_income_detail Pending. |
| released_amount | float | 1570000.5 | Tổng tiền đã thanh toán (VND) Shopee hiển thị ở tổng quan — không theo kỳ chọn. |
| latest_payout_date | string | Ngày chi trả gần nhất (YYYY-MM-DD) — chỉ gian hàng xuyên biên giới; gian hàng VN không có. |
Response sample
{
"error": "",
"message": "",
"request_id": "c3da6a2e5ef6cb3b…",
"response": {
"total_income": {
"pending_amount": 1560000,
"released_amount": 1570000.5
}
}
}
Shopee error codes (8)
Show
| Code | Meaning |
|---|---|
| error_param | Tham số sai / thiếu / sai kiểu — xem `message` để biết tham số nào. |
| error_shop | Gian hàng không hợp lệ — kiểm tra platform_shop_id. |
| error_user_refresh_token | Your refresh token is error, please check refresh token or user_id. |
| 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. |
Get started
- Sign up for Partner
- Enable a data type of the Tài chính / đối soát group on the platform page
- Create an API key (tick the Shopee channel)
- Call it as in the examples above