v2.voucher.get_voucher_list
GET /api/v2/voucher/get_voucher_list
Lấy danh sách voucher
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/voucher/get_voucher_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 trả về trong lần gọi hiện tại. Mặc định là 1, giá trị hợp lệ từ 1 đến 5000. |
| page_size | int32 | False | 100 | Số 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 | all | Bộ lọc trạng thái khi lấy danh sách voucher. Giá trị hợp lệ: upcoming/ongoing/expired/all. |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| error | string | Tên lỗi xảy ra trong yêu cầu. Trống nếu yêu cầu thành công. | |
| message | string | Mô tả chi tiết lỗi. Trống nếu yêu cầu thành công. | |
| request_id | string | c926b49d489a143f415e7197adc9686b | Mã định danh yêu cầu API dùng để theo dõi lỗi. |
| response | object | Thông tin chi tiết bạn đang truy vấn. | |
| more | boolean | true | Cho biết danh sách có nhiều hơn một trang hay không. Nếu true, cần kiểm tra trang tiếp theo. |
| voucher_list | object[] | Danh sách voucher. | |
| voucher_id | int64 | 395841407827968 | Mã định danh duy nhất của voucher. |
| voucher_code | string | TESTTEST1 | Mã voucher |
| voucher_name | string | test voucher | Tên voucher |
| voucher_type | int32 | 1 | Loại voucher. Các giá trị hợp lệ: 1: voucher shop, 2: voucher sản phẩm. |
| reward_type | int32 | 1 | Loại phần thưởng của voucher. Các giá trị hợp lệ: 1: voucher giảm giá cố định, 2: voucher giảm theo phần trăm, 3: voucher hoàn xu. |
| usage_quantity | int32 | 11 | Số lần voucher có thể được sử dụng. |
| current_usage | int32 | 0 | Số lần voucher đã được sử dụng cho đến thời điểm hiện tại. |
| start_time | timestamp | 1656647700 | Thời điểm voucher bắt đầu có hiệu lực; người mua được phép nhận và sử dụng. |
| end_time | timestamp | 1659243300 | Thời điểm voucher hết hiệu lực. Sau thời điểm này, người mua không được nhận hoặc sử dụng voucher. |
| is_admin | boolean | false | Voucher có được tạo bởi Shopee hay không. |
| voucher_purpose | int32 | 0 | Mục đích sử dụng của voucher. Các giá trị hợp lệ: 0: bình thường; 1: chào mừng, 2: giới thiệu; 3: theo dõi shop; 4: game shop, 5: quà tặng miễn phí, 6: thành viên |
| discount_amount | float | 60.0 | Số tiền giảm giá của voucher. Chỉ trả về giá trị khi là voucher giảm giá cố định. |
| percentage | int32 | 10 | Phần trăm giảm giá của voucher. Chỉ trả về giá trị khi là voucher giảm theo phần trăm hoặc hoàn xu. |
| cmt_voucher_status | int32 | 1 | Trạng thái voucher trong CMT. Các giá trị hợp lệ: 1: đang xem xét, 2: đã duyệt, 3: từ chối. Chỉ trả về giá trị khi voucher đang tham gia chiến dịch CMT và chưa bị từ chối. |
| display_start_time | timestamp | 1638342000 | Thời điểm voucher hiển thị trên trang shop; người mua được phép nhận. |