v2.voucher.add_voucher
POST /api/v2/voucher/add_voucher
Thêm voucher
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/voucher/add_voucher
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ả |
|---|---|---|---|---|
| voucher_name | string | True | testamount | Tên voucher. |
| voucher_code | string | True | test | Mã voucher. |
| start_time | timestamp | True | 1624719600 | 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. Chỉ có thể cập nhật nếu voucher chưa bắt đầu. |
| end_time | timestamp | True | 1624978800 | 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. |
| voucher_type | int32 | True | 1 | Loại voucher. Các giá trị hợp lệ: 1: voucher shop, 2: voucher sản phẩm. |
| reward_type | int32 | True | 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 | True | 20000 | Số lần voucher có thể được sử dụng. |
| min_basket_price | float | True | 12.01 | Giá trị đơn hàng tối thiểu để sử dụng voucher này. |
| discount_amount | float | False | 1.55 | Số tiền giảm giá cho voucher này. Chỉ điền khi tạo voucher giảm giá cố định. |
| percentage | int32 | False | 22 | Phần trăm giảm giá cho voucher này. Chỉ điền khi tạo voucher giảm theo phần trăm hoặc hoàn xu. |
| max_price | float | False | 12.0 | Số tiền giảm/giá trị tối đa người dùng được hưởng khi dùng voucher. Chỉ điền khi tạo voucher giảm theo phần trăm hoặc hoàn xu. Nếu không giới hạn, đặt là 0. |
| display_channel_list | int32[] | False | [1] | Kênh hiển thị voucher trên giao diện. Các giá trị hợp lệ: 1: hiển thị tất cả, 3: feed, 4: livestream, [] (trống - ẩn). |
| item_id_list | int64[] | False | [1223223,1223213] | Danh sách sản phẩm áp dụng voucher. Chỉ điền khi tạo voucher loại sản phẩm. |
| display_start_time | int32 | False | 162078900 | Thời điểm voucher hiển thị trên trang shop; người mua được phép nhận. Để trống nếu display_channel_list trống (khi ẩn voucher), nếu không sẽ báo lỗi. |
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 | 4e5d881ac1bc11ebba0dacde48001122 | 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. | |
| voucher_id | int64 | 123 | Mã định danh duy nhất của voucher vừa tạo. |