v2.ams.get_open_campaign_added_product
GET/api/v2/ams/get_open_campaign_added_productGọi qua 360: GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_open_campaign_added_product
Mô tả API
Danh sách sản phẩm ĐANG có trong Chiến dịch mở (Open Campaign) của Tiếp thị liên kết: mã chiến dịch, trạng thái, tỷ lệ hoa hồng, thời gian áp dụng, hoa hồng được bảo vệ. Dùng rà tỷ lệ hoa hồng từng sản phẩm.
- page_size > 100 →
error_param"invalid page_size". - Sản phẩm mới đăng tự vào chiến dịch mở khi bật công tắc (xem get_auto_add_new_product_toggle_status).
Request
Địa chỉ
GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_open_campaign_added_product
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ả |
|---|---|---|---|---|---|
| page_size | query | int | Có | 100 | Số sản phẩm mỗi trang: 1–100. |
| cursor | query | string | Không | Trang đầu để trống; trang sau = response.cursor (dạng "1793260441,295691423"). | |
| sort_by | query | string | Không | -commission_rate | commission_rate (tăng dần) · -commission_rate (giảm dần); bỏ trống = mới cập nhật trước. |
| search_type | query | string | Không | ITEM_ID | ITEM_NAME · ITEM_ID — đi kèm search_content. |
| search_content | query | string | Không | 10000000058,10000000059 | Tên sản phẩm hoặc danh sách item_id cách nhau dấu phẩy (tối đa 50). |
Phân trang
Lặp với cursor = response.cursor khi response.has_more = true.
Ví dụ request
curl -s "https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_open_campaign_added_product?page_size=100&cursor=" \ -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_added_product",
params={
"page_size": 100,
"cursor": ""
},
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_added_product');
for (const [k, v] of Object.entries({"page_size":100,"cursor":""})) 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_added_product' . '?' . http_build_query(['page_size' => 100, 'cursor' => '']); $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 | ||
| total_count | int | 125 | Tổng sản phẩm khớp điều kiện. |
| has_more | bool | true | Còn trang sau. |
| cursor | string | 1793260441,10000000064 | Gửi lại ở lần sau. |
| item_list | object[] | ||
| item_id | int | 10000000058 | Mã sản phẩm. |
| item_name | string | Sản phẩm mẫu | Tên sản phẩm. |
| campaign_id | int | 10000000065 | Mã chiến dịch mở của sản phẩm. |
| campaign_status | string | Ongoing | Upcoming · Ongoing · Terminating. |
| commission_rate | float | 2 | Tỷ lệ hoa hồng (%) — 2 = 2%. |
| max_commission_rate_current_day | float | 2 | Tỷ lệ cao nhất trong ngày (%). |
| period_start_time | timestamp | 1793263686 | Bắt đầu áp dụng. |
| period_end_time | timestamp | 32503651199 | Kết thúc; 32503651199 (31/12/2999) = không thời hạn. |
| pending_terminated_time | timestamp | 0 | Thời điểm dừng đang chờ (0 = không). |
| commission_protection_list | object[] | [] | Hoa hồng cũ còn được bảo vệ sau khi giảm tỷ lệ: {commission_rate, protection_period_end_time}. |
| commission_rate | float | Tỷ lệ hoa hồng (%). | |
| protection_period_end_time | timestamp | Thời điểm kết thúc bảo vệ hoa hồng. |
Mẫu phản hồi
{
"error": "",
"message": "",
"request_id": "e3e3e7f35ef6d2df…",
"response": {
"item_list": [
{
"item_id": 10000000058,
"item_name": "Sản phẩm mẫu",
"campaign_id": 10000000065,
"campaign_status": "Ongoing",
"commission_rate": 2,
"period_start_time": 1793263686,
"period_end_time": 32503651199,
"pending_terminated_time": 0,
"commission_protection_list": [],
"max_commission_rate_current_day": 2
},
{
"item_id": 10000000059,
"item_name": "Sản phẩm mẫu",
"campaign_id": 10000000064,
"campaign_status": "Ongoing",
"commission_rate": 2,
"period_start_time": 1793260441,
"period_end_time": 32503651199,
"pending_terminated_time": 0,
"commission_protection_list": [],
"max_commission_rate_current_day": 2
}
],
"total_count": 125,
"cursor": "1793260441,10000000064",
"has_more": true
}
}
Mã lỗi của Shopee AMS (8)
Bấm để xem
| Mã | Ý nghĩa |
|---|---|
| error_server | Lỗi hệ thống Shopee — thử lại sau ít phút. |
| error_param | Tham số sai / thiếu / sai kiểu — xem `message` để biết tham số nào. |
| error_business | Khô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_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