stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.public.get_shops_by_partner
get basic info of shops which have authorized to the partner.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Public |
| API type | Public |
| HTTP method | GET |
| Path | /api/v2/public/get_shops_by_partner |
| Production URL | https://partner.shopeemobile.com/api/v2/public/get_shops_by_partner |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/public/get_shops_by_partner |
| Rate limit | [0, 0, 0] |
| Permission | ERP System; Seller In House System; Product Management; Order Management; Accounting And Finance; Marketing; Customer Service; Brand Membership; Ads Service; Consignment Service System; Custom APP; Swam ERP; Livestream Management; Ads Facil; Affiliate Marketing Solution Management; Shopee Video Management; Brand Portal Service |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| page_size | int | No | 1 | Each 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), and the "page_no" to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data. |
| page_no | int | No | 1 | Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call. |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| authed_shop_list | object[] | A list of shops authorized to the partner. | ||
| authed_shop_list.region | string | SG | Shop's area | |
| authed_shop_list.shop_id | int | 123 | Shop id | |
| authed_shop_list.auth_time | timestamp | 1610533441 | The timestamp when the shop was authorized to the partner. | |
| authed_shop_list.expire_time | timestamp | 1642069441 | Use this field to indicate the expiration date for shop authorization. | |
| authed_shop_list.sip_affi_shop_list | object[] | SIP affiliate shops info list | ||
| authed_shop_list.sip_affi_shop_list.region | string | SG | Affiliate Shop's area | |
| authed_shop_list.sip_affi_shop_list.affi_shop_id | int | 261377 | Affiliate shop's id | |
| request_id | string | 0b8f39a76e6ada92247b416c768363ee | The identifier for an API request for error tracking. | |
| more | boolean | true | This is to indicate whether the list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of datas. |
§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. | |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp 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/public/get_shops_by_partner?page_no=1&page_size=1&partner_id=partner_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/public/get_shops_by_partner?page_no=1&page_size=1&partner_id=partner_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/public/get_shops_by_partner?page_no=1&page_size=1&partner_id=partner_id&sign=sign×tamp=timestamp'
§10 Python
Python
import requests
url = "https://partner.shopeemobile.com/api/v2/public/get_shops_by_partner?page_no=1&page_size=1&partner_id=partner_id&sign=sign×tamp=timestamp"
payload={}
headers = {
}
response = requests.request("GET",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
§11 Response sample
Response sample
§12 JSON
JSON
{"authed_shop_list":[{"shop_id":123,"region":"TW","sip_affi_shops":[{"affi_shop_id":261373,"region":"MY"},{"affi_shop_id":261374,"region":"ID"},{"affi_shop_id":261375,"region":"TH"},{"affi_shop_id":261376,"region":"PH"},{"affi_shop_id":261377,"region":"SG"},{"affi_shop_id":261378,"region":"VN"}],"auth_time":1610533441,"expire_time":1642069441}],"request_id":"0b8f39a76e6ada92247b416c768363ee","more":false}
§13 Error example
Error example
§14 JSON
JSON
{
"request_id": "f4bf242b281348c524cd17cefb7ef72a",
"error": "error_auth",
"message": "Invalid partner_id or shopid."
}
§15 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| error_network | Inner http call failed | |
| error_data | parse data failed | |
| error_data | data not exist | |
| error_param | parameter invalid | |
| error_param | The information you queried is not found. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. | |
| error_param | request not from gateway | |
| error_server | error server |
§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. |
