v2.follow_prize.add_follow_prize
POST/api/v2/follow_prize/add_follow_prizeVia 360: POST https://partner.quantri360.com/v1/shopee/api/v2/follow_prize/add_follow_prize
Write endpoint — changes data on Shopee. The key must be created with "Allow write API calls" ticked, otherwise you get 403 write_not_allowed. Every call is logged.
Description
Tạo ưu đãi theo dõi gian hàng với mức giảm tiền, phần trăm hoặc hoàn xu.
- Gọi qua /v1/shopee/api/v2/follow_prize/add_follow_prize 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 GHI: thay đổi dữ liệu thật trên Shopee; cần key có quyền ghi (can_write) và gói mở module Khuyến mãi. Thay đổi cấu hình ưu đãi hoặc giá khuyến mãi người mua thấy.
- HTTP 200 vẫn có thể có lỗi nghiệp vụ; kiểm error trước khi dùng kết quả.
- Tối đa 1000 ưu đãi sắp / đang diễn ra; percentage từ 1 đến 99. start_time/end_time không vượt 2037-12-31 23:59:59. Không tạo hoàn xu tại MX; tại TH hoàn xu yêu cầu min_spend >=49.
Request
Endpoint
POST https://partner.quantri360.com/v1/shopee/api/v2/follow_prize/add_follow_prize
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 |
|---|---|---|---|---|---|
| follow_prize_name | body | string | Yes | Ưu đãi minh họa | Tên ưu đãi theo dõi; tối đa 20 ký tự. |
| start_time | body | timestamp | Yes | 1794009600 | Thời điểm bắt đầu, Unix giây; phải sau hiện tại, không trùng khoảng thời gian với ưu đãi theo dõi sắp diễn ra / đang diễn ra. |
| end_time | body | timestamp | Yes | 1794182400 | Thời điểm kết thúc, Unix giây; cách bắt đầu ít nhất 1 ngày, không quá 3 tháng sau bắt đầu, không trùng ưu đãi theo dõi sắp / đang diễn ra. |
| usage_quantity | body | int32 | Yes | 100 | Số lượt sử dụng từ 1 đến 200000. |
| min_spend | body | float | Yes | 100000 | Chi tiêu tối thiểu để sử dụng ưu đãi theo dõi. |
| reward_type | body | int32 | Yes | 1 | Loại ưu đãi: 1 = giảm số tiền cố định, 2 = giảm phần trăm, 3 = hoàn xu. |
| discount_amount | body | float | No | 10000 | Số tiền giảm; chỉ gửi khi reward_type=1 (giảm số tiền cố định). |
| percentage | body | int32 | No | 10 | Tỷ lệ phần trăm; chỉ gửi cho giảm phần trăm (reward_type=2) hoặc hoàn xu (reward_type=3). |
| max_price | body | float | No | 20000 | Giá trị giảm / hoàn xu tối đa; bắt buộc khi giảm phần trăm hoặc hoàn xu, max_price >=1. |
Request examples
curl -s -X POST "https://partner.quantri360.com/v1/shopee/api/v2/follow_prize/add_follow_prize" \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{"follow_prize_name":"Ưu đãi minh họa","start_time":1794009600,"end_time":1794182400,"usage_quantity":100,"min_spend":100000,"reward_type":1,"discount_amount":10000}'
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.post(
"https://partner.quantri360.com/v1/shopee/api/v2/follow_prize/add_follow_prize",
params={},
json={
"follow_prize_name": "Ưu đãi minh họa",
"start_time": 1794009600,
"end_time": 1794182400,
"usage_quantity": 100,
"min_spend": 100000,
"reward_type": 1,
"discount_amount": 10000
},
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/add_follow_prize');
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: 'POST',
headers: { Authorization: `Bearer ${KEY}`, 'Content-Type': 'application/json' },
body: JSON.stringify({"follow_prize_name":"Ưu đãi minh họa","start_time":1794009600,"end_time":1794182400,"usage_quantity":100,"min_spend":100000,"reward_type":1,"discount_amount":10000}),
});
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/add_follow_prize' . '?' . http_build_query([]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key, 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"follow_prize_name":"Ưu đãi minh họa","start_time":1794009600,"end_time":1794182400,"usage_quantity":100,"min_spend":100000,"reward_type":1,"discount_amount":10000}');
$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 minh họa thành công; đọc error/message trước khi dùng kết quả. Mã ưu đãi có thể nằm ở response.campagin_id hoặc response.campaign_id; đọc trường có giá trị và gửi bằng campaign_id khi thao tác tiếp.
| 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ả xử lý. | |
| campagin_id | int64 | 100006 | Mã ưu đãi theo dõi; đọc cả campaign_id nếu có. |
Response sample
{
"request_id": "demo-request",
"error": "",
"message": "",
"response": {
"campagin_id": 100006
}
}
Shopee error codes (22)
Show
| Code | Meaning |
|---|---|
| follow_prize.campaign_num_max_limit | Tối đa 1000 ưu đãi theo dõi đang / sắp diễn ra. |
| follow_prize.campaign_overlap | Khoảng thời gian trùng ưu đãi theo dõi khác; chọn khoảng khác. |
| Follow_prize_min_value_basket_price | Hoàn xu tại TH yêu cầu chi tiêu tối thiểu từ 49. |
| follow_prize.name_length_limit | Tên ưu đãi theo dõi tối đa 20 ký tự. |
| follow_prize.percentage_RANGE | Phần trăm phải từ 1 đến 99. |
| follow_prize.end_time_min_limit | Kết thúc phải sau bắt đầu ít nhất 1 ngày. |
| follow_prize.quota_out_range | Số lượt sử dụng phải từ 1 đến 200000. |
| follow_prize.reward_type_coin_mx | Không tạo hoàn xu tại MX. |
| follow_prize.start_time_min_limit | Bắt đầu phải sau thời điểm hiện tại. |
| follow_prize.time_future_limit | Bắt đầu / kết thúc không vượt 2037-12-31 23:59:59. |
| 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. |
| voucher.voucher_max_discount_low_quality | Cần tăng mức giảm tối đa hoặc giảm chi tiêu tối thiểu để người mua hưởng đúng tỷ lệ giảm; xem message. |
| 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