v2.voucher.get_voucher

GET /api/v2/voucher/get_voucher

Lấy thông tin chi tiết voucher

Đường dẫn Endpoint

URL: https://partner.shopeemobile.com/api/v2/voucher/get_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_id	int64	True	123	Mã định danh duy nhất của voucher dùng để truy vấn thông tin chi tiết.

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	6737e37ec1b411ebb7fbacde48001122	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 được trả về.
voucher_code	string	MKTSRWE	Mã voucher
voucher_name	string	test	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	1	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	1622198847	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	1622807247	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, 7: Quảng cáo
display_channel_list	int32[]	[1,2]	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ả, 2: trang đơn hàng, 3: feed, 4: livestream, [] (trống - ẩn).
min_basket_price	float	10.1	Giá trị đơn hàng tối thiểu để sử dụng voucher này.
percentage	int32	22	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.
max_price	float	11.1	Số tiền giảm/giá trị tối đa người dùng được hưởng. Chỉ trả về giá trị khi là voucher giảm theo phần trăm hoặc hoàn xu.
discount_amount	float	11.0	Số tiền giảm giá của voucher. Chỉ trả về giá trị khi là voucher giảm giá cố định.
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.
item_id_list	int64[]	[123422,122311]	Danh sách sản phẩm áp dụng voucher. Chỉ trả về giá trị khi là voucher loại sản phẩm.
display_start_time	timestamp	162078900	Thời điểm voucher hiển thị trên trang shop; người mua được phép nhận.
target_voucher	int32		Trường đánh dấu voucher người dùng mới / người mua lại: 1: voucher người dùng mới 2: voucher người mua lại: với 1 đơn hàng 3: voucher người mua lại: với 2 đơn hàng
usecase	int32		Chỉ định kịch bản kinh doanh cụ thể mà voucher được tạo và sử dụng: voucher shop:1 voucher sản phẩm:2 voucher người mua mới:3 voucher người mua lại:4 voucher riêng tư:5 voucher live:6 voucher video:7 voucher chiến dịch:8 voucher quà theo dõi:9 voucher thành viên:10 voucher quà game:11 voucher mẫu:12