v2.follow_prize.get_follow_prize_list
GET /api/v2/follow_prize/get_follow_prize_list
Lấy Danh Sách Chương Trình Quà Theo Dõi
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/follow_prize/get_follow_prize_list
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ả |
|---|---|---|---|---|
| page_no | int32 | False | 1 | Chỉ định số trang dữ liệu cần trả về. Mặc định là 1. |
| page_size | int32 | False | 100 | Số lượng mục tối đa trả về mỗi trang. Mặc định là 20, giá trị hợp lệ từ 1 đến 100. |
| status | string | True | upcoming | Bộ lọc trạng thái để lấy danh sách quà theo dõi. Giá trị hợp lệ: upcoming/ongoing/expired/all. |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| response | object | Thông tin chi tiết bạn đang truy vấn. | |
| more | boolean | false | Cho biết danh sách có nhiều hơn một trang hay không. Nếu là true, cần kiểm tra trang tiếp theo. |
| follow_prize_list | object | Danh sách chương trình quà theo dõi. | |
| campaign_id | int32 | 27 | Mã định danh duy nhất của chương trình quà theo dõi đã tạo. |
| campaign_status | string | upcoming | Trạng thái của chương trình quà theo dõi: sắp diễn ra/đang diễn ra/đã hết hạn. |
| follow_prize_name | string | shop_follow_prize3 | Tên chương trình quà theo dõi, độ dài tối đa 20 ký tự. |
| start_time | timestamp | 1655341211 | Thời gian bắt đầu chương trình quà theo dõi. |
| end_time | timestamp | 1657760411 | Thời gian kết thúc chương trình quà theo dõi. |
| usage_quantity | int32 | 2000 | Vui lòng nhập giá trị từ 1 đến 200000. |
| claimed | int32 | 0 | Số lượng voucher đã được nhận. |
| 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 loại lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. | |
| request_id | string | 57a48cf80bec43c7891909bd9acaedb6 | Mã định danh yêu cầu API dùng để theo dõi lỗi. |