v2.discount.get_discount

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

Use this api to get one shop discount activity detail

§2 Overview

Overview

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

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
discount_id	int64	Yes	1000029882	Shopee's unique identifier for a discount activity.
page_no	int32	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	int32	Yes	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.

§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.status	string	ongoing	The status of discount promotion
response.discount_name	string	test-upload-keep	Title of the discount.
response.item_list	object[]		The items selected in this discount.
response.item_list.item_id	int64	2800140208	Shopee's unique identifier for an item.
response.item_list.item_name	string	hahahahahah	Name of the item in local language.
response.item_list.normal_stock	int32	10	The current stock quantity of the item.
response.item_list.item_promotion_stock	int32	12	The reserved stock of the item. If the item has no variation, this param is necessary.
response.item_list.item_original_price	float	11.1	The original price before discount of the item. If there is variation, this value is 0.
response.item_list.item_promotion_price	float	1.92	The discount price of the item. If there is variation, this value is 0.
response.item_list.item_inflated_price_of_original_price	float	12.1	The original price after tax of item (Only for taxable Shop).
response.item_list.item_inflated_price_of_promotion_price	float	12.0	The discount price after tax of item (Only for taxable Shop).
response.item_list.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.
response.item_list.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.
response.item_list.item_local_price_inflated	float		The local price after tax of item (Only for taxable Shop).
response.item_list.item_local_promotion_price_inflated	float		The local discount price after tax of item (Only for taxable Shop).
response.item_list.model_list	object[]		The models belong to this item.
response.item_list.model_list.model_id	int64	1755762	Shopee's unique identifier for a variation of an item.
response.item_list.model_list.model_name	string	hahahahah	Name of the variation that belongs to the same item.
response.item_list.model_list.model_normal_stock	int32	2	The current stock quantity of the variation.
response.item_list.model_list.model_promotion_stock	int32	10	The reserved stock of the model.
response.item_list.model_list.model_original_price	float	1.90	The original price before discount of the variation.
response.item_list.model_list.model_promotion_price	float	1.86	The discount price of the variation.
response.item_list.model_list.model_inflated_price_of_original_price	float	2.2	The original price after tax of model (Only for taxable Shop).
response.item_list.model_list.model_inflated_price_of_promotion_price	float	2.1	The discount price after tax of model (Only for taxable Shop).
response.item_list.model_list.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.
response.item_list.model_list.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.
response.item_list.model_list.model_local_price_inflated	float		The local price after tax of model (Only for taxable Shop).
response.item_list.model_list.model_local_promotion_price_inflated	float		The local discount price after tax of model (Only for taxable Shop).
response.item_list.purchase_limit	int32	1	The max number of this product in the promotion price.
response.start_time	timestamp	1604408400	The time when discount activity start.
response.discount_id	int64	1000029882	Shopee's unique identifier for a discount activity.
response.end_time	timestamp	1605276000	The time when discount activity end.
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

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/discount/get_discount?access_token=access_token&discount_id=1000029882&page_no=1&page_size=50&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/discount/get_discount?access_token=access_token&discount_id=1000029882&page_no=1&page_size=50&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

§9 cURL

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/discount/get_discount?access_token=access_token&discount_id=1000029882&page_no=1&page_size=50&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp'

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/discount/get_discount?access_token=access_token&discount_id=1000029882&page_no=1&page_size=50&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload={}
headers = {

}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

§11 Response sample

Response sample

§12 JSON

JSON

{
	"error": "",
	"message": "",
	"request_id": "da6b348a4a5e4162b885ecc73c85297f",
	"response": {
		"status": "ongoing",
		"discount_name": "test-upload-keep",
		"item_list": [
			{
				"item_id": 2800140208,
				"item_name": "hahahahahah",
				"normal_stock": 10,
				"item_promotion_stock": 12,
				"item_original_price": 11.1,
				"item_promotion_price": 1.92,
				"item_inflated_price_of_original_price": 12.1,
				"item_inflated_price_of_promotion_price": 12,
				"item_local_price": 9.99,
				"item_local_promotion_price": 1.72,
				"model_list": [
					{
						"model_id": 1755762,
						"model_name": "hahahahah",
						"model_normal_stock": 2,
						"model_promotion_stock": 10,
						"model_original_price": 1.9,
						"model_promotion_price": 1.86,
						"model_inflated_price_of_original_price": 2.2,
						"model_inflated_price_of_promotion_price": 2.1,
						"model_local_price": 1.71,
						"model_local_promotion_price": 1.67
					}
				],
				"purchase_limit": 1
			}
		],
		"start_time": 1604408400,
		"discount_id": 1000029882,
		"end_time": 1605276000,
		"more": false
	}
}

§13 Error example

Error example

§14 JSON

JSON

{
    "message": "The information you queried is not found.",
    "request_id": "90a35758996957f05d4145a587cd3926",
    "response": {},
    "error": "common.error_not_found"
}

§15 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.
common.error_not_found	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

§16 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.

§17 Update log

Update log

Date	Change
2025-09-08	Add item_local_price_inflated, item_local_promotion_price_inflated, model_local_price_inflated, model_local_promotion_price_inflated
2025-09-08	Add item_local_price, item_local_promotion_price, model_local_price, model_local_promotion_price
2022-07-19	Add Error Example information
2022-06-28	Optimize the Sample information of Request Parameter and Response Parameter
2021-11-03	update the description

这条内容对你有帮助吗？