The data metrics of shop performance. — Shopee API

v2.account_health.get_shop_performance

GET/api/v2/account_health/get_shop_performanceVia 360: GET https://partner.quantri360.com/v1/shopee/api/v2/account_health/get_shop_performance

Description

Đọc tổng quan sức khỏe gian hàng và danh sách chỉ số vận hành để theo dõi nguy cơ vi phạm.

Gọi qua /v1/shopee/api/v2/account_health/get_shop_performance với Authorization: Bearer <key>; dùng platform_shop_id khi có nhiều shop. 360 tự gắn partner_id, shop_id, sign và access_token.
API chỉ đọc; error rỗng mới là thành công. HTTP 200 vẫn có thể chứa lỗi nghiệp vụ trong error/message.

Request

Endpoint

GET https://partner.quantri360.com/v1/shopee/api/v2/account_health/get_shop_performance

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

No specific parameters (besides the common ones).

Request examples

curl -s "https://partner.quantri360.com/v1/shopee/api/v2/account_health/get_shop_performance" \
  -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/account_health/get_shop_performance",
    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/account_health/get_shop_performance');
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/account_health/get_shop_performance' . '?' . 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)

Phản hồi giữ nguyên cấu trúc của API. Xem error/message trước khi dùng response; ví dụ tham số là dữ liệu minh họa.

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		Kết quả nghiệp vụ.
overall_performance	object		Đánh giá tổng thể sức khỏe shop.
metric_list	object[]		Các chỉ số vận hành cùng mã chỉ số và giá trị.

Response sample

{
    "error": "",
    "message": "",
    "request_id": "086b7ce7cece47d2217cb4ffa0bd9f41",
    "response": {
        "metric_list": [
            {
                "current_period": null,
                "last_period": null,
                "metric_id": 3,
                "metric_name": "non_fulfillment_rate",
                "metric_type": 1,
                "parent_metric_id": 0,
                "target": {
                    "comparator": "<",
                    "value": 10
                },
                "unit": 2
            },
            {
                "current_period": null,
                "last_period": null,
                "metric_id": 42,
                "metric_name": "cancellation_rate",
                "metric_type": 1,
                "parent_metric_id": 3,
                "target": {
                    "comparator": "<",
                    "value": 5
                },
                "unit": 2
            },
            {
                "current_period": null,
                "last_period": null,
                "metric_id": 43,
                "metric_name": "return_refund_rate",
                "metric_type": 1,
                "parent_metric_id": 3,
                "target": {
                    "comparator": "<",
                    "value": 5
                },
                "unit": 2
            },
            {
                "current_period": null,
                "last_period": null,
                "metric_id": 1,
                "metric_name": "late_shipment_rate",
                "metric_type": 1,
                "parent_metric_id": 0,
                "target": {
                    "comparator": "<",
                    "value": 10
                },
                "unit": 2
            },
            {
                "current_period": null,
                "last_period": null,
                "metric_id": 4,
                "metric_name": "preparation_time",
                "metric_type": 1,
                "parent_metric_id": 0,
                "target": {
                    "comparator": "<",
                    "value": 2
                },
                "unit": 4
            },
            {
                "current_period": null,
                "last_period": null,
                "metric_id": 25,
                "metric_name": "same_day_handover_rate",
                "metric_type": 1,
                "parent_metric_id": 0,
                "target": {
                    "comparator": ">=",
                    "value": 60
                },
                "unit": 2
            },
            {
                "current_period": 0,
                "last_period": 0,
                "metric_id": 52,
                "metric_name": "severe_listing_violations",
                "metric_type": 2,
                "parent_metric_id": 0,
                "target": {
                    "comparator": "<=",
                    "value": 0
                },
                "unit": 1
            },
            {
                "current_period": 0,
                "last_period": 0,
                "metric_id": 56,
                "metric_name": "spam_listings",
                "metric_type": 2,
                "parent_metric_id": 52,
                "target": {
                    "comparator": "<=",
                    "value": 0
                },
                "unit": 1
            },
            {
                "current_period": 0,
                "last_period": 0,
                "metric_id": 55,
                "metric_name": "counterfeit_ip_infringement",
                "metric_type": 2,
                "parent_metric_id": 52,
                "target": {
                    "comparator": "<=",
                    "value": 0
                },
                "unit": 1
            },
            {
                "current_period": 0,
                "last_period": 0,
                "metric_id": 54,
                "metric_name": "prohibited_listings",
                "metric_type": 2,
                "parent_metric_id": 52,
                "target": {
                    "comparator": "<=",
                    "value": 0
                },
                "unit": 1
            },
            {
                "current_period": 0,
                "last_period": 0,
                "metric_id": 12,
                "metric_name": "pre_order_listing_rate",
                "metric_type": 2,
                "parent_metric_id": 0,
                "target": {
                    "comparator": "<=",
                    "value": 5
                },
                "unit": 2
            },
            {
                "current_period": 0,
                "last_period": 0,
                "metric_id": 15,
                "metric_name": "the_amount_of_pre_order_listing",
                "metric_type": 2,
                "parent_metric_id": 12,
                "target": {
                    "comparator": "<",
                    "value": 6
                },
                "unit": 1
            },
            {
                "current_period": 0,
                "last_period": 0,
                "metric_id": 53,
                "metric_name": "other_listing_violations",
                "metric_type": 2,
                "parent_metric_id": 0,
                "target": {
                    "comparator": "<=",
                    "value": 0
                },
                "unit": 1
            },
            {
                "current_period": 57,
                "last_period": 57,
                "metric_id": 11,
                "metric_name": "response_rate",
                "metric_type": 3,
                "parent_metric_id": 0,
                "target": {
                    "comparator": ">=",
                    "value": 70
                },
                "unit": 2
            },
            {
                "current_period": null,
                "last_period": null,
                "metric_id": 21,
                "metric_name"

Shopee error codes (9)

Show

Code	Meaning
error_data	Dữ liệu không tồn tại hoặc không hợp lệ cho thao tác (vd mã không có, loại yêu cầu không cho phép).
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_shop	Gian hàng không hợp lệ — kiểm tra platform_shop_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 Basic group on the platform page
Create an API key (tick the Shopee channel)
Call it as in the examples above