v2.ams.get_targeted_campaign_addable_product_list

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

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

打开官方原文 ↗

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

查看技术与溯源信息

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

资料正文

§1 v2.ams.get_targeted_campaign_addable_product_list

Returns a list of products that can be added to a targeted campaign

§2 Overview

Overview

Field	Value
Module	AMS
API type	Shop
HTTP method	GET
Path	/api/v2/ams/get_targeted_campaign_addable_product_list
Production URL	https://partner.shopeemobile.com/api/v2/ams/get_targeted_campaign_addable_product_list
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/ams/get_targeted_campaign_addable_product_list
Permission	Affiliate Marketing Solution Management

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
page_size	int32	Yes	20	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). This integer value is used to specify the maximum number of entries to return in a single "page" of data. The limit of page_size if between 1 and 100.
cursor	string	No	abcd	Specifies the starting entry of data to return in the current call. Default is "" or not passed. If data is more than one page, the cursor can be some entry to start next call.
sort_by	string	No	-sales	Use this field to specify which field to use to sort the returned item list. Available values: -sales: Sort by sales in descending order (default value) sales: Sort by sales in ascending order -stock: Sort by inventory in descending order stock: Sort by inventory in ascending order -price: Sort by price in descending order price: Sort by price in ascending order
search_type	string	No	ITEM_ID	Search type: ITEM_NAME or ITEM_ID, used with search_content.
search_content	string	No	101,102	Search by item name or item ID, item_id should be split by comma and at most 50 items.; Please specify search_type for it to be effective, otherwise search_content will be ignored.

§4 Response parameters

Response parameters

Name	Type	Sample	Description
error	string	error_business	Indicate error type if hit error. Empty if no error happened.
message	string	Please agree to the AMS T&C in Seller Center - Affiliate Marketing Solutions first before using Open API.	Indicate error details if hit error. Empty if no error happened.
request_id	string	b937c04e554847789cbf3fe33a0ad5f1	The identifier for an API request for error tracking.
response	object		Detail informations you are querying.
response.item_list	object[]		Item list.
response.item_list.item_id	int64	101	The unique key for item.
response.item_list.item_name	string	item a	The name of the current item.
response.item_list.sales	int64	1554	The sold of the current item.
response.item_list.display_price	string	95250	The display_price of the current item.
response.item_list.stock	int64	20	The stock of the current item.
response.item_list.is_in_blacklist	boolean	false	Is the current item in the blacklist.
response.total_count	int32	20	The total count of items that meet the query criteria.
response.cursor	string	abcd	Pass the content in the next request as cursor to get the next page data.

§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/ams/get_targeted_campaign_addable_product_list?access_token=access_token&cursor=abcd&page_size=20&partner_id=partner_id&search_content=101%2C102&search_type=ITEM_ID&shop_id=shop_id&sign=sign&sort_by=-sales&timestamp=timestamp")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ams/get_targeted_campaign_addable_product_list?access_token=access_token&cursor=abcd&page_size=20&partner_id=partner_id&search_content=101%2C102&search_type=ITEM_ID&shop_id=shop_id&sign=sign&sort_by=-sales&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/ams/get_targeted_campaign_addable_product_list?access_token=access_token&cursor=abcd&page_size=20&partner_id=partner_id&search_content=101%2C102&search_type=ITEM_ID&shop_id=shop_id&sign=sign&sort_by=-sales&timestamp=timestamp'

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/ams/get_targeted_campaign_addable_product_list?access_token=access_token&cursor=abcd&page_size=20&partner_id=partner_id&search_content=101%2C102&search_type=ITEM_ID&shop_id=shop_id&sign=sign&sort_by=-sales&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": "b937c04e554847789cbf3fe33a0ad5f1",
	"response": {
		"item_list": [
			{
				"item_id": 101,
				"item_name": "item a",
				"sales": 1554,
				"display_price": "95250",
				"stock": 20,
				"is_in_blacklist": false
			}
		],
		"total_count": 20,
		"cursor": "abcd"
	}
}

§13 Error example

Error example

§14 JSON

JSON

{
	"error": "error_business",
	"message": "Please agree to the AMS T&C in Seller Center - Affiliate Marketing Solutions first before using Open API.",
	"request_id": "b937c04e554847789cbf3fe33a0ad5f1"
}

§15 Errors

Errors

Error	Description	Solution
error_param	invalid limit
error_param	invalid param
error_param	invalid search_content
error_param	invalid search_type
error_param	invalid sort_by type
error_server	Something wrong. Please try later.
error_business	Sorry you don't have access to AMS features.
error_business	Please agree to the AMS T&C in Seller Center - Affiliate Marketing Solutions first before using Open API.
error_business	The seller commission operation is frozen.

§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-10-15	New API

这条内容对你有帮助吗？