v2.follow_prize.get_follow_prize_list
GET/api/v2/follow_prize/get_follow_prize_listVia 360: GET https://partner.quantri360.com/v1/shopee/api/v2/follow_prize/get_follow_prize_list
Description
Liệt kê chương trình quà tặng/ưu đãi cho người theo dõi shop. Dùng campaign_id trong danh sách để đọc chi tiết.
- Gọi qua /v1/shopee/api/v2/follow_prize/get_follow_prize_list 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/follow_prize/get_follow_prize_list
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 |
|---|---|---|---|---|---|
| page_no | query | int32 | No | 1 | Trang cần lấy, bắt đầu từ 1. |
| page_size | query | int32 | No | 20 | Số mục mỗi trang; chọn 20 cho lần đầu. |
| status | query | string | Yes | all | all, ongoing, upcoming hoặc expired: tất cả, đang chạy, sắp chạy, đã hết hạn. |
Pagination
Bắt đầu page_no=1; tăng từng trang, dừng khi more=false hoặc đã lấy đủ total_count nếu phản hồi có trường này.
Request examples
curl -s "https://partner.quantri360.com/v1/shopee/api/v2/follow_prize/get_follow_prize_list?status=all" \ -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/follow_prize/get_follow_prize_list",
params={
"status": "all"
},
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/follow_prize/get_follow_prize_list');
for (const [k, v] of Object.entries({"status":"all"})) 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/follow_prize/get_follow_prize_list' . '?' . http_build_query(['status' => 'all']); $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ụ. | |
| more | boolean | Còn trang kế hay không. | |
| follow_prize_list | object | Các chương trình ưu đãi theo dõi; dùng campaign_id để xem chi tiết. |
Response sample
{
"response": {
"more": false,
"follow_prize_list": [
{
"campaign_id": 27,
"campaign_status": "upcoming",
"follow_prize_name": "shop_follow_prize3",
"start_time": 1655341211,
"end_time": 1657760411,
"usage_quantity": 2000,
"claimed": 0
}
]
},
"request_id": "57a48cf80bec43c7891909bd9acaedb6",
"error": "",
"message": ""
}
Shopee error codes (11)
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. |
| common.error_not_found | Không tìm thấy thông tin. |
| common.error_param | Tham số không hợp lệ — xem `message`. |
| 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 Khuyến mãi (Marketing) group on the platform page
- Create an API key (tick the Shopee channel)
- Call it as in the examples above