v2.discount.get_discount

GET /api/v2/discount/get_discount

Use this api to get one shop discount activity detail

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/discount/get_discount

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_id	int64	True	1000029882	Shopee's unique identifier for a discount activity.
page_no	int32	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	int32	True	50	Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call), and the "page_no" to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data.

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.
status	string	ongoing	The status of discount promotion
discount_name	string	test-upload-keep	Title of the discount.
item_list	object[]		The items selected in this discount.
item_id	int64	2800140208	Shopee's unique identifier for an item.
item_name	string	hahahahahah	Name of the item in local language.
normal_stock	int32	10	The current stock quantity of the item.
item_promotion_stock	int32	12	The reserved stock of the item. If the item has no variation, this param is necessary.
item_original_price	float	11.1	The original price before discount of the item. If there is variation, this value is 0.
item_promotion_price	float	1.92	The discount price of the item. If there is variation, this value is 0.
item_inflated_price_of_original_price	float	12.1	The original price after tax of item (Only for taxable Shop).
item_inflated_price_of_promotion_price	float	12.0	The discount price after tax of item (Only for taxable Shop).
item_local_price	float	9.99	The local price of item calculated as: Local Price = CB Original Price × Local Adjustment Rate. Reflects the final local price derived from shop-level adjustment rules and is denominated in local currency.
item_local_promotion_price	float	1.72	The local discount price of item calculated as: Local Discount Price = Local Price × Discount Rate. Reflects the final local seller discount price derived from setting a seller discount and is denominated in local currency.
item_local_price_inflated	float		The local price after tax of item (Only for taxable Shop).
item_local_promotion_price_inflated	float		The local discount price after tax of item (Only for taxable Shop).
model_list	object[]		The models belong to this item.
model_id	int64	1755762	Shopee's unique identifier for a variation of an item.
model_name	string	hahahahah	Name of the variation that belongs to the same item.
model_normal_stock	int32	2	The current stock quantity of the variation.
model_promotion_stock	int32	10	The reserved stock of the model.
model_original_price	float	1.90	The original price before discount of the variation.
model_promotion_price	float	1.86	The discount price of the variation.
model_inflated_price_of_original_price	float	2.2	The original price after tax of model (Only for taxable Shop).
model_inflated_price_of_promotion_price	float	2.1	The discount price after tax of model (Only for taxable Shop).
model_local_price	float	1.71	The local price of model calculated as: Local Price = CB Original Price × Local Adjustment Rate. Reflects the final local price derived from shop-level adjustment rules and is denominated in local currency.
model_local_promotion_price	float	1.67	The local discount price of model calculated as: Local Discount Price = Local Price × Discount Rate. Reflects the final local seller discount price derived from setting a seller discount and is denominated in local currency.
model_local_price_inflated	float		The local price after tax of model (Only for taxable Shop).
model_local_promotion_price_inflated	float		The local discount price after tax of model (Only for taxable Shop).
purchase_limit	int32	1	The max number of this product in the promotion price.
start_time	timestamp	1604408400	The time when discount activity start.
discount_id	int64	1000029882	Shopee's unique identifier for a discount activity.
end_time	timestamp	1605276000	The time when discount activity end.
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.