v2.ams.get_managed_affiliate_list

GET /api/v2/ams/get_managed_affiliate_list

Returns affiliates that are saved to managed affiliate list

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/ams/get_managed_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
page_no	int32	True	1	The start index of request. The max managed affiliates of affiliate is 2000. Zero count will returned if offset > 2000 or offset > real managed count.
page_size	int32	True	20	The number of affiliate returned by this request, Max is 100, default is 20. The max managed affiliates of affiliate is 2000.

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		Detail informations you are querying.
total_count	int32	1000	The total count of affiliates that managed by this seller.
affiliate_list	object[]		Affiliate list managed by seller. 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 current commission.
user_name	string	ss	The shopee user name or affiliate name for this affiliate
portrait_url	string		The portrait url of affiliate.
popular_social_media	object		The popular social media of this affiliate.
platform	string	meta	The platform of this social media account.
follower_count	int64	1000	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	aads	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[]	[1000000000000,5000000000000]	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]	Top 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. eg. shopee video/shopee live
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		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.