v2.ams.query_affiliate_list
GET /api/v2/ams/query_affiliate_list
Retrieve affiliate information by ID đơn vị liên kết.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/ams/query_affiliate_list
Tham số chung
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| partner_id | int | 1 | Partner ID được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu. |
| timestamp | timestamp | 1610000000 | Dùng để chỉ định thời gian của yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token truy cập API, dùng để xác định quyền của bạn đối với API. Có thể sử dụng nhiều lần và hết hạn sau 4 giờ. |
| shop_id | int | 600000 | Mã định danh duy nhất của Shopee cho một cửa hàng. Tham số bắt buộc cho hầu hết các API. |
| 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 |
Tham số Request
| Tên | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|
| query_type | int32 | True | 1 | Query type: 1: query affiliate information by id list 2: query ID đơn vị liên kết by name(fuzzy matching), only return ID đơn vị liên kết and tên đơn vị liên kết |
| affiliate_id_list | string | False | 1,2,3 | Query affiliate information by ID đơn vị liên kết list. Max count of ID đơn vị liên kết 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. |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| error | string | error_auth | Loại lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. |
| message | string | Invalid access_token. | Chi tiết lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. |
| request_id | string | b937c04e554847789cbf3fe33a0ad5f1 | Mã định danh của yêu cầu API dùng để theo dõi lỗi. |
| response | object | ||
| total_count | int32 | 200 | Tổng số affiliates by this query. Max is 200. |
| affiliate_list | object | Danh sách đơn vị liên kết 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 | Tên của the affiliate. |
| user_name | string | ss | The shopee user name or tên đơn vị liên kết 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 danh sách 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 | Số lượt nhấp 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 ID danh mụcs 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 số lượt bình luận of this affiliate's content. |
| like_count | int64 | 300 | The số lượt thích of this affiliate's content. |
| view_count | int64 | 1000 | The số lượt xem 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 ID sản phẩm of this item. |
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();<?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; 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' 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)
], "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 } ] } } }