v2.discount.get_discount_list

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

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

打开官方原文 ↗

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

查看技术与溯源信息

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

资料正文

§1 v2.discount.get_discount_list

Use this api to get shop discount activity list

§2 Overview

Overview

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

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
discount_status	string	Yes	ongoing	The status filter for retriveing discount list. Available value: upcoming/ongoing/expired/all.
page_no	int	Yes	1	Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call.
page_size	int	Yes	100	If many items are available to retrieve, you may need to call GetDiscountsList multiple times to retrieve all the data. Each result set is returned as a page of entries. Use the Pagination filters to control the maximum number of entries (<= 100) to retrieve per page (i.e., per call), the offset number to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data.
update_time_from	timestamp	No	1643860467	The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the discount update time). The maximum date range that may be specified with the update_time_from and update_time_to fields is 30 days.
update_time_to	timestamp	No	1646020467	The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the discount update time). The maximum date range that may be specified with the update_time_from and update_time_to fields is 30 days.

§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	da6b348a4a5e4162b885ecc73c85297f	The identifier of the API request for error tracking.
response	object		Detail informations you are querying.
response.discount_list	object[]		The discounts created in this shop.
response.discount_list.status	string	ongoing	The status of discount.
response.discount_list.discount_name	string	testqwert001	Title of the discount.
response.discount_list.start_time	timestamp	1644910200	The time when discount activity start.
response.discount_list.end_time	timestamp	1645864200	The time when discount activity end.
response.discount_list.discount_id	int	665270257590299	Shopee's unique identifier for a discount activity.
response.discount_list.source	int	0	Source of the discount. 7: live stream, 1: admin, 0: others
response.more	boolean	false	This is to indicate whether the item 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 items.

§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

{
    "discount_status": "ongoing",
    "page_no": 1,
    "page_size": 100
}

§8 Response sample

Response sample

§9 JSON

JSON

{
    "message": "",
    "request_id": "2e922c7e07fd8c9f6c8481b3b8d3d2fe",
    "response": {
        "discount_list": [
            {
                "status": "ongoing",
                "discount_name": "testqwert001",
                "start_time": 1644910200,
                "discount_id": 1000021581,
                "source": 0,
                "end_time": 1645864200
            },
            {
                "status": "ongoing",
                "discount_name": "testqwerty002",
                "start_time": 1644910200,
                "discount_id": 1000021582,
                "source": 0,
                "end_time": 1646037000
            },
            {
                "status": "ongoing",
                "discount_name": "testasdfgxcvyt003",
                "start_time": 1644909420,
                "discount_id": 1000021583,
                "source": 0,
                "end_time": 1645173000
            }
        ],
        "more": false
    },
    "error": ""
}

§10 Error example

Error example

§11 JSON

JSON

{
    "request_id": "b2bad5c3b4d1a463e52f12c512b2b83b",
    "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 wrong. Please try later.
error_shop	shopid is invalid
common.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
2022-07-19	Add Error Example information
2022-06-28	add the Request Example
2022-02-24	Response parameter add source field information
2022-02-15	Request parameter add update_time_from and update_time_to fields

这条内容对你有帮助吗？