v2.ams.query_affiliate_list

GET /api/v2/ams/query_affiliate_list

Retrieve affiliate information by affiliate id.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/ams/query_affiliate_list

Common Request 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

Request Parameters

Name	Type	Required	Sample	Description
query_type	int32	True	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	False	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	False	ddd	Query affiliate information by name use fuzzy matching. Will return first 200 affiliates' information is match number > 200.

Response Parameters

Name	Type	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
total_count	int32	200	The total count of affiliates by this query. Max is 200.
affiliate_list	object		Affiliate list by this query. Not all return fields will have values.
affiliate_id	int64	12345678	The unique key for the current affiliate.
affiliate_name	string	affiliate a	The name of the affiliate.
user_name	string	ss	The shopee user name or affiliate name for this affiliate.
portrait_url	string		The url of affiliate's portrait
popular_social_media	object[]		The popular social media of this affiliate.
platform	string	meta	The platform of this social media account.
follower_count	int64		The follower count of this account.
social_medias	object[]		Social media account list of this affiliate.
platform	string	shopee live	The platform of this social media account.
follower_count	int64	1000	The follower count of this account.
social_media_user_name	string	dafffd	Social media name of this account.
total_click	int64	10000	Number of clicks in the last 30 days.
order_range	int64[]	[200,400]	Range number of the orders in the last 30 days.
gmv_range	int64[]	[100000000,500000000]	Range number of the gmv in the last 30 days.
is_orange_tick_kol	boolean	true	Golden tick means affiliates create high quality contents with good sales conversion in Shopee Live or Shopee Video.
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
promote_category_ids	int64[]	[100013,100644,100010]	Three promote category ids for this affiliate
top_popular_contents	object[]		Top popular contents of this affiliate.
platform	string	shopee live	The platform of this affiliate's content.
comment_count	int64	100	The comment count of this affiliate's content.
like_count	int64	300	The like count of this affiliate's content.
view_count	int64	1000	The view count of this affiliate's content.
cover_url	string	https://123456	The cover link of this affiliate's content.
media_url	string		The media link of this affiliate's content.
top_selling_products	object[]		Top selling items of the affiliate.
item_id	int64	12345678	The item id of this item.