v2.discount.get_discount_list

GET /api/v2/discount/get_discount_list

Use this api to get shop discount activity list

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/discount/get_discount_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
discount_status	string	True	ongoing	The status filter for retriveing discount list. Available value: upcoming/ongoing/expired/all.
page_no	int	True	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	True	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	False	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	False	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.

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.
discount_list	object[]		The discounts created in this shop.
status	string	ongoing	The status of discount.
discount_name	string	testqwert001	Title of the discount.
start_time	timestamp	1644910200	The time when discount activity start.
end_time	timestamp	1645864200	The time when discount activity end.
discount_id	int	665270257590299	Shopee's unique identifier for a discount activity.
source	int	0	Source of the discount. 7: live stream, 1: admin, 0: others
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.