v2.follow_prize.add_follow_prize
POST /api/v2/follow_prize/add_follow_prize
Thêm Chương Trình Quà Theo Dõi
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/follow_prize/add_follow_prize
Tham số chung
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| partner_id | int | 1 | Mã đối tác được cấp khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu. |
| timestamp | timestamp | 1610000000 | Dấu thời gian của yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token dùng để truy cập API, xác định quyền truy cập của bạn. Có thể dùng nhiều lần, hết hạn sau 4 giờ. |
| shop_id | int | 600000 | Mã định danh duy nhất của shop trên Shopee. Bắt buộc cho hầu hết các API. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Chữ ký được tạo từ partner_id, đường dẫn API, timestamp, access_token, shop_id và partner_key thông qua thuật toán HMAC-SHA256. Chi tiết: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Tham số Request
| Tên | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|
| follow_prize_name | string | True | shop_follow_prize_one | Tên chương trình quà theo dõi, độ dài tối đa 20 ký tự. |
| start_time | timestamp | True | 1621844677 | Thời gian bắt đầu chương trình quà theo dõi, phải sau thời gian hiện tại. Nếu thời gian bắt đầu và kết thúc trùng với hoạt động sắp diễn ra/đang diễn ra khác, sẽ hiện thông báo "Đã có voucher Quà Theo Dõi trong khoảng thời gian này, vui lòng chọn khoảng thời gian khác." |
| end_time | timestamp | True | 1621944677 | Thời gian kết thúc chương trình quà theo dõi, phải lớn hơn thời gian bắt đầu ít nhất 1 ngày và không vượt quá 3 tháng sau thời gian bắt đầu. Nếu trùng với hoạt động khác, sẽ hiện thông báo "Đã có voucher Quà Theo Dõi trong khoảng thời gian này." |
| usage_quantity | int32 | True | 2000 | Vui lòng nhập giá trị từ 1 đến 200000. |
| min_spend | float | True | 200.0 | Số tiền mua tối thiểu cần đạt để sử dụng quà theo dõi. |
| reward_type | int32 | True | 1 | Loại phần thưởng của chương trình quà theo dõi. Các giá trị: 1: giảm giá cố định, 2: giảm giá theo %, 3: hoàn xu. |
| discount_amount | float | False | 50.0 | Số tiền giảm giá cho chương trình quà theo dõi này. Chỉ nhập khi tạo quà theo dõi với giảm giá cố định. |
| percentage | int32 | False | 2 | Phần trăm giảm giá cho chương trình quà theo dõi này. Chỉ nhập khi tạo quà theo dõi theo % hoặc hoàn xu. Phần trăm giảm giá (reward_type ==2) hoặc Phần trăm hoàn xu (reward_type==3). |
| max_price | float | False | 300.0 | Số tiền giảm tối đa người dùng có thể nhận được. Bắt buộc khi tạo quà theo dõi theo % hoặc hoàn xu. max_price >=1 |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| error | string | Cho biết loại lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. | |
| message | string | Cho biết chi tiết lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. | |
| response | object | Thông tin chi tiết bạn đang truy vấn. | |
| campagin_id | int32 | 2365452 | Mã định danh duy nhất của chương trình quà theo dõi đã tạo. |
| request_id | string | 70ef2c3c6e461cd4258f9962409634d5 | Mã định danh yêu cầu API dùng để theo dõi lỗi. |