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

v2.ams.get_recommended_affiliate_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
ModuleAMS
API typeShop
HTTP methodGET
Path/api/v2/ams/get_recommended_affiliate_list
Production URLhttps://partner.shopeemobile.com/api/v2/ams/get_recommended_affiliate_list
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/ams/get_recommended_affiliate_list
PermissionAffiliate Marketing Solution Management
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
page_sizeint32Yes50Each 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.; Note: The response size will up to 200.
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
errorstringerror_authIndicate error type if hit error. Empty if no error happened.
messagestringInvalid access_token.Indicate error details if hit error. Empty if no error happened.
request_idstringb937c04e554847789cbf3fe33a0ad5f1The identifier for an API request for error tracking.
responseobjectDetail informations you are querying.
response.total_countint32200The total count of affiliates that recommended for shop id.
response.affiliate_listobject[]Recommended Affiliate list. Not all return fields will have values.
response.affiliate_list.affiliate_idint6412345678The unique key for the current affiliate.
response.affiliate_list.affiliate_namestringaffiliate aThe name of the affiliate.
response.affiliate_list.user_namestringssThe shopee user name or affiliate name for this affiliate.
response.affiliate_list.portrait_urlstringThe portrait url of affiliate.
response.affiliate_list.popular_social_mediaobjectThe popular social media of this affiliate.
response.affiliate_list.popular_social_media.platformstringmetaThe platform of this social media account.
response.affiliate_list.popular_social_media.follower_countint64The follower count of this account.
response.affiliate_list.social_mediasobject[]Social media account list of this affiliate.
response.affiliate_list.social_medias.platformstringshopee liveThe platform of this social media account.
response.affiliate_list.social_medias.follower_countint641000The follower count of this account.
response.affiliate_list.social_medias.social_media_user_namestringdafffdSocial media name of this account.
response.affiliate_list.total_clickint6412000Number of clicks in the last 30 days.
response.affiliate_list.order_rangeint64[][200,400]Range number of the orders in the last 30 days.
response.affiliate_list.gmv_rangeint64[][1000000000000,5000000000000]Range number of the GMV in the last 30 days.
response.affiliate_list.is_orange_tick_kolbooleantrueGolden tick means affiliates create high quality contents with good sales conversion in Shopee Live or Shopee Video.
response.affiliate_list.is_good_fulfillmentbooleantrueGood sample fulfillment means that affiliates demonstrate better in free sample fulfillment compared to the majority of affiliates in recent180 days
response.affiliate_list.promote_category_idsint64[][100013,100644,100010]Three promote category ids for this affiliate.
response.affiliate_list.top_popular_contentsobject[]Top popular contents of this affiliate.
response.affiliate_list.top_popular_contents.platformstringshopee liveThe platform of this affiliate's content. eg. shopee video/shopee live
response.affiliate_list.top_popular_contents.comment_countint64100The comment count of this affiliate's content.
response.affiliate_list.top_popular_contents.like_countint64300The like count of this affiliate's content.
response.affiliate_list.top_popular_contents.view_countint641000The view count of this affiliate's content.
response.affiliate_list.top_popular_contents.cover_urlstringhttps://123456The cover link of this affiliate's content.
response.affiliate_list.top_popular_contents.media_urlstringThe media link of this affiliate's content.
response.affiliate_list.top_selling_productsobject[]Top selling items of the affiliate.
response.affiliate_list.top_selling_products.item_idint6412345678The item id of this item.
#

§5 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
#

§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_recommended_affiliate_list?access_token=access_token&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/ams/get_recommended_affiliate_list?access_token=access_token&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/ams/get_recommended_affiliate_list?access_token=access_token&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/ams/get_recommended_affiliate_list?access_token=access_token&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": "b937c04e554847789cbf3fe33a0ad5f1",
	"response": {
		"total_count": 200,
		"affiliate_list": [
			{
				"affiliate_id": 12345678,
				"affiliate_name": "affiliate a",
				"user_name": "ss",
				"portrait_url": "-",
				"popular_social_media": {
					"platform": "meta",
					"follower_count": 0
				},
				"social_medias": [
					{
						"platform": "shopee live",
						"follower_count": 1000,
						"social_media_user_name": "dafffd"
					}
				],
				"total_click": 12000,
				"order_range": [
					200,
					400
				],
				"gmv_range": [
					1000000000000,
					5000000000000
				],
				"is_orange_tick_kol": true,
				"is_good_fulfillment": true,
				"promote_category_ids": [
					100013,
					100644,
					100010
				],
				"top_popular_contents": [
					{
						"platform": "shopee live",
						"comment_count": 100,
						"like_count": 300,
						"view_count": 1000,
						"cover_url": "https://123456",
						"media_url": "-"
					}
				],
				"top_selling_products": [
					{
						"item_id": 12345678
					}
				]
			}
		]
	}
}
#

§13 Error example

Error example

#

§14 JSON

JSON

{
	"error": "error_auth",
	"message": "Invalid access_token.",
	"request_id": "b937c04e554847789cbf3fe33a0ad5f1"
}
#

§15 Errors

Errors

ErrorDescriptionSolution
error_paraminvalid page_no
error_paraminvalid page_size
error_paraminvalid param
error_serverSomething wrong. Please try later.
#

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

§17 Update log

Update log

DateChange
2025-10-15New API
#