快工助手跨境电商知识与商机助手

v2.public.get_shops_by_partner

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.public.get_shops_by_partner

get basic info of shops which have authorized to the partner.

#

§2 Overview

Overview

FieldValue
ModulePublic
API typePublic
HTTP methodGET
Path/api/v2/public/get_shops_by_partner
Production URLhttps://partner.shopeemobile.com/api/v2/public/get_shops_by_partner
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/public/get_shops_by_partner
Rate limit[0, 0, 0]
PermissionERP 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

NameTypeRequiredSampleDescription
page_sizeintNo1Each 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_nointNo1Specifies 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

NameTypeRequiredSampleDescription
authed_shop_listobject[]A list of shops authorized to the partner.
authed_shop_list.regionstringSGShop's area
authed_shop_list.shop_idint123Shop id
authed_shop_list.auth_timetimestamp1610533441The timestamp when the shop was authorized to the partner.
authed_shop_list.expire_timetimestamp1642069441Use this field to indicate the expiration date for shop authorization.
authed_shop_list.sip_affi_shop_listobject[]SIP affiliate shops info list
authed_shop_list.sip_affi_shop_list.regionstringSGAffiliate Shop's area
authed_shop_list.sip_affi_shop_list.affi_shop_idint261377Affiliate shop's id
request_idstring0b8f39a76e6ada92247b416c768363eeThe identifier for an API request for error tracking.
morebooleantrueThis 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

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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&timestamp=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&timestamp=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&timestamp=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&timestamp=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

ErrorDescriptionSolution
error_networkInner http call failed
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
error_paramrequest not from gateway
error_servererror server
#

§16 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp 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_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe 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_suspendedThe API is offline. Please call v2 API instead.
error_limitThe 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_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour 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_permissionThis app type has no permission to this API.
#