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

Retrieve all current targeted campaigns created by the seller — API Shopee AMS

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

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

Danh sách chiến dịch riêng (Targeted Campaign) gian hàng đã tạo cho affiliate chọn lọc: tên, trạng thái, thời gian, số affiliate / sản phẩm, khoảng tỷ lệ hoa hồng. Dùng theo dõi các chiến dịch đặt riêng với KOC.

  • page_size quá lớn (vd 200) → error_param "invalid page_size".
  • Gồm cả chiến dịch đã kết thúc; lọc campaign_status=Ongoing để xem đang chạy (không có → campaign_list rỗng).

Request

Địa chỉ

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

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ả
page_noqueryintCó1Trang, từ 1.
page_sizequeryintCó50Số chiến dịch mỗi trang (đã chạy với 100; 200 bị từ chối).
campaign_statusquerystringKhôngOngoingUpcoming · Ongoing · Ended · Cancelled · Draft · Terminating · Terminated · Paused.
campaign_id_listquerystringKhông10000000012,10000000057Mã chiến dịch cách nhau dấu phẩy, tối đa 50.
campaign_namequerystringKhông20.11Tìm theo tên.
period_start_timequerytimestampKhông1763571600Lọc theo thời gian bắt đầu.
period_end_timequerytimestampKhông32503651199Lọc theo thời gian kết thúc.
item_idqueryintKhông10000000058Chiến dịch có chứa sản phẩm này.
item_namequerystringKhôngĐầmChiến dịch có sản phẩm tên này.

Phân trang

Tăng page_no tới khi đã đủ response.total_count (phản hồi không có has_more).

Ví dụ request

curl -s "https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_targeted_campaign_list?page_no=1&page_size=50" \
  -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_targeted_campaign_list",
    params={
        "page_no": 1,
        "page_size": 50
    },
    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_targeted_campaign_list');
for (const [k, v] of Object.entries({"page_no":1,"page_size":50})) 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_targeted_campaign_list' . '?' . http_build_query(['page_no' => 1, 'page_size' => 50]);
$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_countint14Tổng chiến dịch khớp.
campaign_listobject[]
campaign_idint10000000012Mã chiến dịch.
campaign_namestringChiến dịch mẫu ATên.
campaign_statusstringEndedUpcoming · Ongoing · Ended · Cancelled · Draft · Terminating · Terminated · Paused.
campaign_sourcestringSeller`Seller` (shop tạo) · `ShopeeManaged` (Shopee quản lý — không xem / sửa chi tiết được, báo invalid campaign_id) · `Unknown`.
period_start_timetimestamp1763571600Bắt đầu.
period_end_timetimestamp1764262799Kết thúc; 32503651199 = không thời hạn.
last_editorstringtai-khoan-mauTài khoản sửa gần nhất.
last_edit_timetimestamp1763020754Lần sửa gần nhất.
affiliate_countint1Số affiliate trong chiến dịch.
item_countint8Số sản phẩm.
min_ratefloat10Tỷ lệ hoa hồng thấp nhất (%).
max_ratefloat10Tỷ lệ hoa hồng cao nhất (%).

Mẫu phản hồi

{
  "request_id": "e3e3e7f35ef6d3ae…",
  "error": "",
  "message": "",
  "response": {
    "total_count": 14,
    "campaign_list": [
      {
        "campaign_id": 10000000012,
        "campaign_name": "Chiến dịch mẫu A",
        "period_start_time": 1763571600,
        "period_end_time": 1764262799,
        "campaign_status": "Ended",
        "last_editor": "tai-khoan-mau",
        "last_edit_time": 1763020754,
        "affiliate_count": 1,
        "item_count": 8,
        "min_rate": 10,
        "max_rate": 10,
        "campaign_source": "Seller"
      },
      {
        "campaign_id": 10000000057,
        "campaign_name": "Chiến dịch mẫu B",
        "period_start_time": 1763312400,
        "period_end_time": 1763917259,
        "campaign_status": "Ended",
        "last_editor": "tai-khoan-mau",
        "last_edit_time": 1763019731,
        "affiliate_count": 1,
        "item_count": 8,
        "min_rate": 10,
        "max_rate": 10,
        "campaign_source": "Seller"
      }
    ]
  }
}

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

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_businessKhông thể thực hiện nghiệp vụ Affiliate; kiểm message để biết điều kiện hoặc cài đặt cần xử lý.
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