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

Cài đặt chiến dịch riêng — API Shopee AMS

v2.ams.get_targeted_campaign_settings · 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_settings

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

Cấu hình chi tiết một Chiến dịch riêng (Targeted Campaign): tên, trạng thái, thời gian, ngân sách và đã chi, lời nhắn gửi affiliate, danh sách affiliate được mời và sản phẩm kèm tỷ lệ hoa hồng.

  • Trạng thái nằm ở khóa campaign_status (không phải commission_status).
  • campaign_id không thuộc shop / ShopeeManaged → error_param "invalid campaign_id".

Request

Địa chỉ

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

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ả
campaign_idqueryintCó10000000012Mã chiến dịch (get_targeted_campaign_list). Chiến dịch campaign_source = ShopeeManaged không xem được.

Ví dụ request

curl -s "https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_targeted_campaign_settings?campaign_id=10000000012" \
  -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_settings",
    params={
        "campaign_id": 10000000012
    },
    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_settings');
for (const [k, v] of Object.entries({"campaign_id":10000000012})) 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_settings' . '?' . http_build_query(['campaign_id' => 10000000012]);
$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
campaign_namestringChiến dịch mẫu ATên.
campaign_statusstringEndedUpcoming · Ongoing · Ended · Cancelled · Draft · Terminating · Terminated · Paused.
period_start_timetimestamp1763571600Bắt đầu.
period_end_timetimestamp1764262799Kết thúc; 32503651199 = không thời hạn.
pending_terminated_timetimestamp1763917259Thời điểm dừng đang chờ / đã đặt.
is_set_budgetboolfalseCó đặt ngân sách.
budgetfloat0Ngân sách (VND).
budget_costfloat72272Hoa hồng đã chi (VND) — có giá trị cả khi không đặt ngân sách.
seller_messagestringMong được hợp tác…Lời nhắn hiển thị cho affiliate.
affiliate_listobject[]Affiliate trong chiến dịch: chỉ {affiliate_id} — tra chi tiết bằng query_affiliate_list.
affiliate_idint64Mã affiliate; dùng query_affiliate_list để tra chi tiết.
item_listobject[]
item_idint10000000013Mã sản phẩm.
item_namestringÁo phao nữ dáng lỡ mũ rời Thương hiệu mẫu …Tên.
ratefloat10Tỷ lệ hoa hồng (%) — 10 = 10%.
max_commission_rate_current_dayfloat10Tỷ lệ cao nhất trong ngày (%).
commission_protection_listobject[][]Hoa hồng cũ còn được bảo vệ: {commission_rate, protection_period_end_time}.
commission_ratefloatTỷ lệ hoa hồng (%).
protection_period_end_timetimestampThời điểm kết thúc bảo vệ hoa hồng.
commission_statusstringTrạng thái chiến dịch: Upcoming · Ongoing · Ended · Cancelled · Draft · Terminating · Terminated · Paused.

Mẫu phản hồi

{
  "request_id": "e3e3e7f35ef7b2ba…",
  "error": "",
  "message": "",
  "response": {
    "campaign_name": "Chiến dịch mẫu A",
    "period_start_time": 1763571600,
    "period_end_time": 1764262799,
    "is_set_budget": false,
    "budget": 0,
    "budget_cost": 72272,
    "campaign_status": "Ended",
    "seller_message": "Thương hiệu mẫu … mong được hợp tác thành công với các KOL của Shopee ạ!",
    "affiliate_list": [
      {
        "affiliate_id": 10000000008
      }
    ],
    "item_list": [
      {
        "item_id": 10000000013,
        "rate": 10,
        "item_name": "Áo phao nữ dáng lỡ mũ rời Thương hiệu mẫu … WJKBB2025",
        "commission_protection_list": [],
        "max_commission_rate_current_day": 10
      },
      {
        "item_id": 10000000014,
        "rate": 10,
        "item_name": "Áo Khoác Phao Nữ Dáng Dài Trần Trám Thương hiệu mẫu … WJKBD4015",
        "commission_protection_list": [],
        "max_commission_rate_current_day": 10
      }
    ],
    "pending_terminated_time": 1763917259
  }
}

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

Bấm để xem
MãÝ nghĩa
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_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_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