快工助手跨境电商知识与商机助手

v2.ads.get_recommended_item_list

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

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

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§2 Overview

Overview

FieldValue
ModuleAds
API typeShop
HTTP methodGET
Path/api/v2/ads/get_recommended_item_list
Production URLhttps://partner.shopeemobile.com/api/v2/ads/get_recommended_item_list
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/ads/get_recommended_item_list
PermissionSeller In House System; Marketing; Ads Service; Ads Service App ; Ads Facil
#

§3 Response parameters

Response parameters

NameTypeRequiredSampleDescription
errorstringError code, empty when no error returned
messagestringerror description
warningstringIf some data cannot respond normally, set the warning
request_idstring6f235f4a343e4feb8a9ed74c439f6663request id is unique for each request
responseobject[]response body
response.item_idint321234Recommended SKU's item id
response.item_status_liststring[]["blocked"]This is param to indicate the status of items, so sellers can know whether an item is eligible for ads or not.
response.sku_tag_liststring[]["best selling"]The corresponding tag (or tags) that belong to item_id, sequences follow as best selling>best ROI>top search
response.ongoing_ad_type_liststring[]["search ads", "discovery ads"]Current status of the ad on this item. For example- no ongoing promotion, search ads, discovery ads, boost ads
#

§4 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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
#

§5 Request samples

Request samples

#

§6 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://open.admin.uat.shopee.io/api/v2/ads/get_rcmd_item_list?access_token=access_token&partner_id=partner_id&shop_id=12312&sign=sign&timestamp=timestamp")
.asString();
#

§7 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://open.admin.uat.shopee.io/api/v2/ads/get_rcmd_item_list?access_token=access_token&partner_id=partner_id&shop_id=12312&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;
#

§8 cURL

cURL

curl --location --request GET 'https://open.admin.uat.shopee.io/api/v2/ads/get_rcmd_item_list?access_token=access_token&partner_id=partner_id&shop_id=12312&sign=sign&timestamp=timestamp' 
#

§9 Python

Python

import requests

url = "https://open.admin.uat.shopee.io/api/v2/ads/get_rcmd_item_list?access_token=access_token&partner_id=partner_id&shop_id=12312&sign=sign&timestamp=timestamp"

payload={}
headers = {

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

print(response.text)
#

§10 Response sample

Response sample

#

§11 JSON

JSON

{
	"request_id": "6f235f4a343e4feb8a9ed74c439f6663",
	"response": [
		{
			"item_id": 1234,
			"item_status_list": [
				"blocked"
			],
			"sku_tag_list": [
				"best selling"
			],
			"ongoing_ad_type_list": [
				"search ads",
				"discovery ads"
			]
		}
	]
}
#

§12 Errors

Errors

ErrorDescriptionSolution
error_not_foundThe information you queried is not found.
error_paramWrong parameters.
error_serverSomething wrong. Please try later.
ads.api.http_method_not_allowedOnly the supported HTTP method for the API is allowed.
ads.rate_limit.exceed_partner_apiToo many requests, please reduce the request rate and try again later.
ads.rate_limit.exceed_shop_apiToo many requests for the shop at the moment, please try again later.
ads.rate_limit.exceed_apiToo many requests at the moment, please try again later.
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
error_shopshopid is invalid
error_paramrequest not from gateway
#

§13 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp 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_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe 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_suspendedThe API is offline. Please call v2 API instead.
error_limitThe 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_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour 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_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#

§14 Update log

Update log

DateChange
2025-09-08select type for some parameters
2023-08-16New API
#