VI | EN
Message us on Messenger
Developer resources

add Follow Prize — Shopee API

v2.follow_prize.add_follow_prize · call it through Quantri360 with one API key for your own accounts / assets that you connected and authorized — 360 handles request signing and refreshing the authorization you granted.

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

NameInTypeSampleDescription
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.

Request parameters

NameInTypeRequiredSampleDescription
follow_prize_namebodystringYesƯu đãi minh họaTên ưu đãi theo dõi; tối đa 20 ký tự.
start_timebodytimestampYes1794009600Thờ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_timebodytimestampYes1794182400Thờ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_quantitybodyint32Yes100Số lượt sử dụng từ 1 đến 200000.
min_spendbodyfloatYes100000Chi tiêu tối thiểu để sử dụng ưu đãi theo dõi.
reward_typebodyint32Yes1Loại ưu đãi: 1 = giảm số tiền cố định, 2 = giảm phần trăm, 3 = hoàn xu.
discount_amountbodyfloatNo10000Số tiền giảm; chỉ gửi khi reward_type=1 (giảm số tiền cố định).
percentagebodyint32No10Tỷ 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_pricebodyfloatNo20000Giá 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.

NameTypeSampleDescription
request_idstringd52ca43b277a4f9292fb8be658bfd33dMã request của Shopee để tra lỗi.
errorstringMã lỗi Shopee; rỗng = thành công.
messagestringMô tả lỗi.
responseobjectKết quả xử lý.
campagin_idint64100006Mã ư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
CodeMeaning
follow_prize.campaign_num_max_limitTối đa 1000 ưu đãi theo dõi đang / sắp diễn ra.
follow_prize.campaign_overlapKhoảng thời gian trùng ưu đãi theo dõi khác; chọn khoảng khác.
Follow_prize_min_value_basket_priceHoàn xu tại TH yêu cầu chi tiêu tối thiểu từ 49.
follow_prize.name_length_limitTên ưu đãi theo dõi tối đa 20 ký tự.
follow_prize.percentage_RANGEPhần trăm phải từ 1 đến 99.
follow_prize.end_time_min_limitKết thúc phải sau bắt đầu ít nhất 1 ngày.
follow_prize.quota_out_rangeSố lượt sử dụng phải từ 1 đến 200000.
follow_prize.reward_type_coin_mxKhông tạo hoàn xu tại MX.
follow_prize.start_time_min_limitBắt đầu phải sau thời điểm hiện tại.
follow_prize.time_future_limitBắt đầu / kết thúc không vượt 2037-12-31 23:59:59.
error_dataDữ 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_paramTham số sai / thiếu / sai kiểu — xem `message` để biết tham số nào.
common.error_not_foundKhông tìm thấy thông tin.
common.error_paramTham số không hợp lệ — xem `message`.
error_serverLỗi hệ thống Shopee — thử lại sau ít phút.
error_shopGian hàng không hợp lệ — kiểm tra platform_shop_id.
voucher.voucher_max_discount_low_qualityCầ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_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.

Get started

  1. Sign up for Partner
  2. Enable a data type of the Khuyến mãi (Marketing) group on the platform page
  3. Create an API key (tick the Shopee channel)
  4. Call it as in the examples above