v2.voucher.get_voucher_list

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 · 2026-09-06 12:15:50

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.voucher.get_voucher_list

Get Voucher List

§2 Overview

Overview

Field	Value
Module	Voucher
API type	Shop
HTTP method	GET
Path	/api/v2/voucher/get_voucher_list
Production URL	https://partner.shopeemobile.com/api/v2/voucher/get_voucher_list
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/voucher/get_voucher_list
Rate limit	[0, 0, 0]
Permission	ERP System; Seller In House System; Marketing; Customer Service; Customized APP; Swam ERP

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
page_no	int32	No	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	No	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	Yes	all	The status filter for retrieving voucher list. Available value: upcoming/ongoing/expired/all.

§4 Response parameters

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.
response.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.
response.voucher_list	object[]		The list of voucher.
response.voucher_list.voucher_id	int64	395841407827968	The unique identifier for a voucher.
response.voucher_list.voucher_code	string	TESTTEST1	Voucher Code
response.voucher_list.voucher_name	string	test voucher	Voucher Name
response.voucher_list.voucher_type	int32	1	The type of the voucher. The available values are: 1: shop voucher, 2: product voucher.
response.voucher_list.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.
response.voucher_list.usage_quantity	int32	11	The number of times for this particular voucher could be used.
response.voucher_list.current_usage	int32	0	Up till now, how many times has this particular voucher already been used.
response.voucher_list.start_time	timestamp	1656647700	The timing from when the voucher is valid; so buyer is allowed to claim and to use.
response.voucher_list.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.
response.voucher_list.is_admin	boolean	false	If the voucher is created by Shopee or not.
response.voucher_list.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
response.voucher_list.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.
response.voucher_list.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.
response.voucher_list.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.
response.voucher_list.display_start_time	timestamp	1638342000	The timing of when voucher is displayed on shop pages; so buyer is allowed to claim.

§5 Common parameters

Common 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

§6 Request samples

Request samples

§7 Java

Java

{
    "status": "all",
    "page_no": 1,
    "page_size": 100
}

§8 Response sample

Response sample

§9 JSON

JSON

{
    "response": {
        "more": true,
        "voucher_list": [
            {
                "voucher_id": 395841407827968,
                "voucher_code": "TESTTEST1",
                "voucher_name": "test voucher",
                "voucher_type": 1,
                "reward_type": 1,
                "usage_quantity": 11,
                "current_usage": 0,
                "start_time": 1656647700,
                "end_time": 1659243300,
                "is_admin": false,
                "voucher_purpose": 0,
                "discount_amount": 60,
                "target_voucher": 0,
                "display_start_time": 0
            },
            {
                "voucher_id": 136496996696064,
                "voucher_code": "SFP-136496996696064",
                "voucher_name": "67657",
                "voucher_type": 1,
                "reward_type": 3,
                "usage_quantity": 4,
                "current_usage": 0,
                "start_time": 1626249840,
                "end_time": 1627027500,
                "is_admin": false,
                "voucher_purpose": 3,
                "percentage": 5,
                "target_voucher": 0,
                "display_start_time": 0
            }
        ]
    },
    "request_id": "c926b49d489a143f415e7197adc9686b",
    "error": "",
    "message": ""
}

§10 Error example

Error example

§11 JSON

JSON

{
    "request_id": "23095bfd3755d941a30bad4d1ad31ab4",
    "error": "error_auth",
    "message": "Invalid partner_id or shopid."
}

§12 Errors

Errors

Error	Description	Solution
error_network	Inner http call failed
error_data	parse data failed
error_data	data not exist
error_param	parameter invalid
error_param	The information you queried is not found.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.
common.error_server	Something is wrong. Please try later.
common.error_shop	Shopid is invalid.
error_shop	shopid is invalid
error_param	request not from gateway

§13 Common errors

Common errors

Error	Description	Solution
error_auth	partner_id is invalid
error_auth	The App is deleted, and you'll be unable to make any API call.
error_auth	App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_param	There is no partner_id in query.
error_param	Invalid partner_id.
error_param	no timestamp
error_param	Invalid timestamp
error_param	There is no sign in query.
error_sign	Wrong sign.
invalid_partner_id	Invalid partner_id, please have a check.
error_auth	No permission to current api.
error_api_call_restricted	The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspended	The API is offline. Please call v2 API instead.
error_limit	The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limit	Too many requests. You have reached the rate limit. Please try again later.
source_ip_undeclared	Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_param	Permission denied. This API is currently offline or the request path is incorrect.
error_param	Partner_id is invalid, should be an integer between 0 and 4294967295.
error_param	no timestamp.
error_param	Timestamp is invalid, should be an integer between 0 and 4294967295.
error_param	Timestamp is expired.
error_partner_key_expired	Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permission	This app type has no permission to this API.
error_param	There is no access_token in query.
error_auth	Invalid access_token.
error_auth	Invalid partner_id or shopid.
shop_no_linked	Partner and shop has no linked.
shop_banned	The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_token	Invalid access_token, please have a check.
partner_shop_no_link	Invalid partner_id or shop_id, please have a check.
error_ashop_api_permission	The shop is Affiliate shop has no permission to call this API.
error_kyc_auth	No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_auth	System error, please try again later.
error_param	There is no shop_id in query.
error_param	shop_id is invalid, should be an integer between 0 and 4294967295.

§14 Update log

Update log

Date	Change
2025-09-08	select type for some parameters
2022-07-27	Add Error Example information
2022-07-01	Optimize the Sample information of Request Parameter and Response Parameter
2021-12-15	Response Parameter add new field display_start_time
2021-06-24	New API

这条内容对你有帮助吗？