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

Hiệu quả chiến dịch mở theo sản phẩm — API Shopee AMS

v2.ams.get_open_campaign_performance · 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.get_open_campaign_performance

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

Hiệu quả TỪNG SẢN PHẨM trong Chiến dịch mở theo kỳ: số affiliate quảng bá, doanh thu, số bán, hoa hồng ước tính. Dùng tìm sản phẩm affiliate kéo đơn tốt.

  • page_size > 20 (vd 50) → error_param "invalid page_size".
  • Mảng nằm ở khóa list.

Request

Địa chỉ

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

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ả
period_typequerystringCóLast30dDay · Week · Month · Last7d · Last30d — quy tắc ngày như get_shop_performance.
start_datequerystringCó20260929YYYYMMDD.
end_datequerystringCó20261028YYYYMMDD.
page_noqueryintCó1Trang, từ 1.
page_sizequeryintCó20Tối đa 20.
item_idqueryintKhông10000000005Chỉ xem một sản phẩm.

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_open_campaign_performance?period_type=Last30d&start_date=20260929&end_date=20261028&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_open_campaign_performance",
    params={
        "period_type": "Last30d",
        "start_date": "20260929",
        "end_date": "20261028",
        "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_open_campaign_performance');
for (const [k, v] of Object.entries({"period_type":"Last30d","start_date":"20260929","end_date":"20261028","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_open_campaign_performance' . '?' . http_build_query(['period_type' => 'Last30d', 'start_date' => '20260929', 'end_date' => '20261028', '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ê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_countint410Tổng sản phẩm có số liệu.
has_morebooltrueCòn trang sau.
listobject[]Sắp theo doanh thu giảm dần.
item_idint10000000028Mã sản phẩm.
item_namestringÁo khoác phao 3 lớp dáng lỡ Thương hiệu mẫu …Tên.
affiliatesint4Số affiliate có đơn.
salesstring4472770Doanh thu (VND, chuỗi).
item_soldint4Số bán.
est_commissionstring68771.1Hoa hồng ước tính (VND, chuỗi).
fetched_date_rangestring20260929-20261028Khoảng ngày thực tính.

Mẫu phản hồi

{
  "error": "",
  "message": "",
  "request_id": "e3e3e7f35ef7a449…",
  "response": {
    "has_more": true,
    "list": [
      {
        "item_id": 10000000028,
        "item_name": "Áo khoác phao 3 lớp dáng lỡ Thương hiệu mẫu … WJKBE2091",
        "affiliates": 4,
        "sales": "4472770",
        "item_sold": 4,
        "est_commission": "68771.1"
      },
      {
        "item_id": 10000000005,
        "item_name": "Áo khoác phao nữ trần ngang 3 lớp … Thương hiệu mẫu WJKBE2056",
        "affiliates": 3,
        "sales": "3885978",
        "item_sold": 4,
        "est_commission": "59154.51"
      }
    ],
    "total_count": 410,
    "fetched_date_range": "20260929-20261028"
  }
}

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

Bấm để xem
MãÝ nghĩa
error_paramTham số sai / thiếu / sai kiểu — xem `message` để biết tham số nào.
error_serverLỗ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_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