v2.voucher.get_voucher_list

GET /api/v2/voucher/get_voucher_list

Get Voucher List

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/voucher/get_voucher_list

Common Request Parameters

Name	Type	Sample	Description
partner_id	int	1	Partner ID is assigned upon registration is successful. Required for all requests.
timestamp	timestamp	1610000000	This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_id	int	600000	Shopee's unique identifier for a shop. Required param for most APIs.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

Request Parameters

Name	Type	Required	Sample	Description
page_no	int32	False	1	Specifies the page number of data to return in the current call. Default to be 1 and allowed input is from 1 - 5000.
page_size	int32	False	100	Use the 'page_size' filters to control the maximum number of entries to retrieve per page (i.e., per call). Default to be 20 and allowed input is from 1- 100.
status	string	True	all	The status filter for retrieving voucher list. Available value: upcoming/ongoing/expired/all.

Response Parameters

Name	Type	Sample	Description
error	string		Indicate error type if hit error. Empty if no error happened.
message	string		Indicate error details if hit error. Empty if no error happened.
request_id	string	c926b49d489a143f415e7197adc9686b	The identifier of the API request for error tracking.
response	object		Detailed informations you are querying.
more	boolean	true	This is to indicate whether the comment list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of comments.
voucher_list	object[]		The list of voucher.
voucher_id	int64	395841407827968	The unique identifier for a voucher.
voucher_code	string	TESTTEST1	Voucher Code
voucher_name	string	test voucher	Voucher Name
voucher_type	int32	1	The type of the voucher. The available values are: 1: shop voucher, 2: product voucher.
reward_type	int32	1	The reward type of the voucher. The available values are: 1: fix_amount voucher, 2: discount_percentage voucher, 3: coin_cashback voucher.
usage_quantity	int32	11	The number of times for this particular voucher could be used.
current_usage	int32	0	Up till now, how many times has this particular voucher already been used.
start_time	timestamp	1656647700	The timing from when the voucher is valid; so buyer is allowed to claim and to use.
end_time	timestamp	1659243300	The timing until when the voucher is still valid. Any time after this end_time, buyer is not allowed to claim or to use.
is_admin	boolean	false	If the voucher is created by Shopee or not.
voucher_purpose	int32	0	The use case for the voucher. The available values are: 0: normal; 1: welcome, 2: referral; 3: shop_follow; 4:shop_game, 5: free_gift, 6: membership
discount_amount	float	60.0	The discount amount set for this particular voucher. Only when it is a fix amount voucher, api will return a value.
percentage	int32	10	The discount percentage set for this particular voucher. Only when it is a discount percentage voucher or coins cashback voucher, api will return a value.
cmt_voucher_status	int32	1	The voucher status in CMT. The available values are: 1:review, 2: approved, 3:reject. Only when this voucher is attending CMT campaign and not being rejected, api will return a value.
display_start_time	timestamp	1638342000	The timing of when voucher is displayed on shop pages; so buyer is allowed to claim.