v2.product.get_item_promotion

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

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

打开官方原文 ↗

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

查看技术与溯源信息

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

资料正文

§1 v2.product.get_item_promotion

Get item promotion info.

§2 Overview

Overview

Field	Value
Module	Product
API type	Shop
HTTP method	GET
Path	/api/v2/product/get_item_promotion
Production URL	https://partner.shopeemobile.com/api/v2/product/get_item_promotion
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/product/get_item_promotion
Rate limit	[0, 0, 0]
Permission	ERP System; Seller In House System; Product Management; Order Management; Accounting And Finance; Marketing; Customized APP; Ads Service; Swam ERP; Livestream Management; Ads Facil; Affiliate Marketing Solution Management; Shopee Video Management

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
item_id_list	int64[]	Yes	13233406680,17924576533	Item ID list, can send 1 to 50 items.

§4 Response parameters

Response parameters

Name	Type	Sample	Description
error	string	product.error_param	Indicate error type if hit error. Empty if no error happened.
message	string		Indicate error details if hit error. Empty if no error happened.
warning	string		Waring message.
request_id	string		The identifier for an API request for error tracking.
response	object
response.success_list	object[]		Success item promotion info.
response.success_list.item_id	int		The identity of product item.
response.success_list.promotion	object[]		Item promotion info list
response.success_list.promotion.promotion_type	string	Campaign	Promotion type, Applicable values: See Data Definition- PromotionType.
response.success_list.promotion.promotion_id	uint64		The identity of item promotion.
response.success_list.promotion.model_id	int64		The identity of product model.
response.success_list.promotion.start_time	timestamp		Promotion start tiem.
response.success_list.promotion.end_time	timestamp		Promotion end item.
response.success_list.promotion.promotion_price_info	object[]		Promotion price info.
response.success_list.promotion.promotion_price_info.promotion_price	float		Promotion price.
response.success_list.promotion.promotion_staging	string		Could be ongoing/upcoming
response.success_list.promotion.promotion_stock_info_v2	object		new promotion stock
response.success_list.promotion.promotion_stock_info_v2.summary_info	object		stock summary info
response.success_list.promotion.promotion_stock_info_v2.total_reserved_stock	int32	10	Total Stock reserved for promotion
response.failure_list	object[]		Fail item promotion info.
response.failure_list.item_id	int64		The identity of item.
response.failure_list.failed_reason	string		Fail reason.

§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/product/get_item_promotion?access_token=access_token&item_id_list= 13233406680,17924576533&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/product/get_item_promotion?access_token=access_token&item_id_list= 13233406680,17924576533&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/product/get_item_promotion?access_token=access_token&item_id_list= 13233406680,17924576533&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp'

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/product/get_item_promotion?access_token=access_token&item_id_list= 13233406680,17924576533&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload={}
headers = {

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

print(response.text)

§11 Response sample

Response sample

§12 JSON

JSON

{
    "error": "",
    "message": "",
    "warning": "",
    "request_id": "c878e05df6313b180d40ba67cac74caf",
    "response": {
        "success_list": [
            {
                "item_id": 800188562,
                "promotion": [
                    {
                        "promotion_type": "Discount Promotions",
                        "promotion_id": 649305216139969,
                        "model_id": 9184960,
                        "start_time": 1650609000,
                        "end_time": 1650616200,
                        "promotion_price_info": [
                            {
                                "promotion_price": 160
                            }
                        ],
                        "promotion_staging": "upcoming",
                        "promotion_stock_info_v2": {
                            "summary_info": {
                                "total_reserved_stock": 0
                            }
                        }
                    },
                    {
                        "promotion_type": "Discount Promotions",
                        "promotion_id": 649305216139969,
                        "model_id": 9182545,
                        "start_time": 1650609000,
                        "end_time": 1650616200,
                        "promotion_price_info": [
                            {
                                "promotion_price": 160
                            }
                        ],
                        "promotion_staging": "upcoming",
                        "promotion_stock_info_v2": {
                            "summary_info": {
                                "total_reserved_stock": 20
                            }
                        }
                    },
                    {
                        "promotion_type": "Discount Promotions",
                        "promotion_id": 649305216139969,
                        "model_id": 9182546,
                        "start_time": 1650609000,
                        "end_time": 1650616200,
                        "promotion_price_info": [
                            {
                                "promotion_price": 160
                            }
                        ],
                        "promotion_staging": "upcoming",
                        "promotion_stock_info_v2": {
                            "summary_info": {
                                "total_reserved_stock": 20
                            }
                        }
                    }
                ]
            }
        ]
    }
}

§13 Error example

Error example

§14 JSON

JSON

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

§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.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.
error_shop	shopid is invalid
error_param	request not from gateway
error_param	Model_id and item_id not match.
error_param	Repeat item_id.
error_get_shop_fail	Get shop failed. please try later.
error_inner	Our system is taking some time to respond, please try later.
error_inner	System error, please try again later or contact the OpenAPI support team.
error_item_not_found	Product not found
error_inner	Update item failed {{.error_info}}
error_inner	Update item failed {{.error_info}}
error_inner	System error, please try again later or contact the OpenAPI support team.
error_inner	System error, please try again later or contact the OpenAPI support team.
error_auth	The location_id input is not matched the shop's location_id(more/wrong). Please double check.
error_auth	Lack of location_id, please double check.
error_auth	Please wait for the holiday mode set then to edit item. Please try later.
error_auth	Total stock must be more than reserved stock.
error_param	{{.error_info}}
error_auth	Your shop can not use model level dts
error_auth	You do not have right to use seller location_id, please only fill seller_stock filed.
error.param	Can not update item with stock less than reserved stock
error_param	Can not update item with different stock structure. Can only update seller stock with location id when existing seller stock have location id. Can only update seller stock without location id when existing seller stock without location id.
error_param	Can not update item with stock less than reserve stock
error_auth	Stock should be larger than reserved stock.
error_system_busy	Our system is taking some time to respond, please try later.
error_param	Can not update item with different stock structure. Can only update seller stock with location id when existing seller stock have location id. Can only update seller stock without location id when existing seller stock without location id.

§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
2026-07-31	promotion_id type change to uint64
2024-10-23	sunset the reserved_stock_info
2022-06-13	add reminder "Please use the promotion_stock_info_v2 field instead, we will deprecate this field in the future."
2021-08-16	update promotion_staging description and example

这条内容对你有帮助吗？