stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.ams.query_affiliate_list
Retrieve affiliate information by affiliate id.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | AMS |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/ams/query_affiliate_list |
| Production URL | https://partner.shopeemobile.com/api/v2/ams/query_affiliate_list |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/ams/query_affiliate_list |
| Permission | Affiliate Marketing Solution Management |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| query_type | int32 | Yes | 1 | Query type: 1: query affiliate information by id list; 2: query affiliate id by name(fuzzy matching), only return affiliate id and affiliate name |
| affiliate_id_list | string | No | 1,2,3 | Query affiliate information by affiliate id list.; Max count of affiliate id is 200. Will return first 200 affiliates' information if length > 200. |
| name | string | No | ddd | Query affiliate information by name use fuzzy matching.; Will return first 200 affiliates' information is match number > 200. |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| error | string | error_auth | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Invalid access_token. | 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 | |||
| response.total_count | int32 | 200 | The total count of affiliates by this query.; Max is 200. | |
| response.affiliate_list | object | Affiliate list by this query.; Not all return fields will have values. | ||
| response.affiliate_list.affiliate_id | int64 | 12345678 | The unique key for the current affiliate. | |
| response.affiliate_list.affiliate_name | string | affiliate a | The name of the affiliate. | |
| response.affiliate_list.user_name | string | ss | The shopee user name or affiliate name for this affiliate. | |
| response.affiliate_list.portrait_url | string | The url of affiliate's portrait | ||
| response.affiliate_list.popular_social_media | object[] | The popular social media of this affiliate. | ||
| response.affiliate_list.popular_social_media.platform | string | meta | The platform of this social media account. | |
| response.affiliate_list.popular_social_media.follower_count | int64 | The follower count of this account. | ||
| response.affiliate_list.social_medias | object[] | Social media account list of this affiliate. | ||
| response.affiliate_list.social_medias.platform | string | shopee live | The platform of this social media account. | |
| response.affiliate_list.social_medias.follower_count | int64 | 1000 | The follower count of this account. | |
| response.affiliate_list.social_medias.social_media_user_name | string | dafffd | Social media name of this account. | |
| response.affiliate_list.total_click | int64 | 10000 | Number of clicks in the last 30 days. | |
| response.affiliate_list.order_range | int64[] | [200,400] | Range number of the orders in the last 30 days. | |
| response.affiliate_list.gmv_range | int64[] | [100000000,500000000] | Range number of the gmv in the last 30 days. | |
| response.affiliate_list.is_orange_tick_kol | boolean | true | Golden tick means affiliates create high quality contents with good sales conversion in Shopee Live or Shopee Video. | |
| response.affiliate_list.is_good_fulfillment | boolean | true | Good 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_ids | int64[] | [100013,100644,100010] | Three promote category ids for this affiliate | |
| response.affiliate_list.top_popular_contents | object[] | Top popular contents of this affiliate. | ||
| response.affiliate_list.top_popular_contents.platform | string | shopee live | The platform of this affiliate's content. | |
| response.affiliate_list.top_popular_contents.comment_count | int64 | 100 | The comment count of this affiliate's content. | |
| response.affiliate_list.top_popular_contents.like_count | int64 | 300 | The like count of this affiliate's content. | |
| response.affiliate_list.top_popular_contents.view_count | int64 | 1000 | The view count of this affiliate's content. | |
| response.affiliate_list.top_popular_contents.cover_url | string | https://123456 | The cover link of this affiliate's content. | |
| response.affiliate_list.top_popular_contents.media_url | string | The media link of this affiliate's content. | ||
| response.affiliate_list.top_selling_products | object[] | Top selling items of the affiliate. | ||
| response.affiliate_list.top_selling_products.item_id | int64 | 12345678 | The item id of this item. |
§5 Common parameters
Common parameters
| Name | Type | Required | 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/query_affiliate_list?access_token=access_token&affiliate_id_list=1%2C2%2C3&name=ddd&partner_id=partner_id&query_type=1&shop_id=shop_id&sign=sign×tamp=timestamp")
.asString();
§8 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ams/query_affiliate_list?access_token=access_token&affiliate_id_list=1%2C2%2C3&name=ddd&partner_id=partner_id&query_type=1&shop_id=shop_id&sign=sign×tamp=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/query_affiliate_list?access_token=access_token&affiliate_id_list=1%2C2%2C3&name=ddd&partner_id=partner_id&query_type=1&shop_id=shop_id&sign=sign×tamp=timestamp'
§10 Python
Python
import requests
url = "https://partner.shopeemobile.com/api/v2/ams/query_affiliate_list?access_token=access_token&affiliate_id_list=1%2C2%2C3&name=ddd&partner_id=partner_id&query_type=1&shop_id=shop_id&sign=sign×tamp=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": 10000,
"order_range": [
200,
400
],
"gmv_range": [
100000000,
500000000
],
"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
| Error | Description | Solution |
|---|---|---|
| error_param | invalid param |
§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 |
