stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.shop.get_shop_info
Use this call to get information of shop
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Shop |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/shop/get_shop_info |
| Production URL | https://partner.shopeemobile.com/api/v2/shop/get_shop_info |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/shop/get_shop_info |
| Rate limit | [0, 0, 0] |
| Permission | ERP System; Seller In House System; Product Management; Order Management; Customer Service; Customized APP; Ads Service; Swam ERP; Livestream Management; Ads Facil; Affiliate Marketing Solution Management; Shopee Video Management |
§3 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| shop_name | string | openapi_pshop_1 | Name of the shop. | |
| region | string | TW | Shop's area. | |
| status | string | NORMAL | Applicable status: BANNED, FROZEN, NORMAL. | |
| sip_affi_shops | object[] | SIP affiliate shops info list.If you request for SIP primary shop,this field will be returned, if you request for SIP affiliate shop,this field won't be returned | ||
| sip_affi_shops.affi_shop_id | int64 | Affiliate shop's id. | ||
| sip_affi_shops.region | string | Affiliate Shop's area. | ||
| is_cb | boolean | true | Use this filed to indicate whether the shop is a cross-border shop. | |
| request_id | string | 0b8f39a76e6ada92247b416c768363ee | The identifier for an API request for error tracking. | |
| auth_time | timestamp | 1610533441 | The timestamp when the shop was authorized to the partner. | |
| expire_time | timestamp | 1642069441 | Use this field to indicate the expiration date for shop authorization. | |
| is_sip | boolean | true | This filed will return "true" when SIP primary shop or affiliate shop calls | |
| is_upgraded_cbsc | boolean | true | Use this filed to indicate whether this merchant is upgraded to CBSC, including CNSC and KRSC. | |
| merchant_id | int64 | 1000000400 | Shopee’s unique identifier for a merchant. If the shop won't under any merchant, then the value will be null. | |
| shop_fulfillment_flag | string | PFF - 3PF Shop | Use this field to indicate the fulfillment type of current shop, the applicable values: - Pure - FBS Shop: Single mode, refer to Local/CB shops which only have Shopee official warehouse stock, orders are fulfilled by Shopee from Shopee official warehouse;; - Pure - 3PF Shop: Single mode, refer to CB shops which only have local seller warehouse stock, orders are fulfilled by seller from local seller warehouse via local logistics channels;; - PFF - FBS Shop: 1) Hybird mode, refer to Local shops which have both Shopee official warehouse stock and local seller warehouse stock, orders can be fulfilled by Shopee from Shopee official warehouse and can also fulfilled by seller from local seller warehouse via local logistics channels;; 2) Hybrid mode, refer to CB shops which have both Shopee official warehouse stock and CB seller warehouse stock, orders can be fulfilled by Shopee from Shopee official warehouse and can also fulfilled by seller from CB seller warehouse via CB logistics channels;; - PFF - 3PF Shop: Hybrid mode, refer to CB shops which have both local seller warehouse stock and CB seller warehouse stock, orders can be fulfilled by seller from local seller warehouse via local logistics channels and can also fulfilled by seller from CB seller warehouse via CB logistics channels;; - LFF Hybrid Shop: Hybrid mode, refer to CB shops which have 3 types of stock: FBS stock (Shopee official warehouse stock), 3PF stock (CB seller own stock in the local market) and CB SLS stock (CB seller own stock in CN/HK/KR);; - Others; - Unknown: Returned when obtaining shop_fulfillment_flag information fails | |
| is_main_shop | boolean | true | Identifies if the current shop is a Local Shop linked to Cross Border Direct Shop. | |
| is_direct_shop | boolean | false | Identifies if the current shop is a Cross Border Direct Shop. | |
| linked_main_shop_id | int64 | 0 | Returns the Shop ID of the Local Shop linked to the Cross Border Direct Shop. | |
| linked_direct_shop_list | object[] | Returns the list of Cross Border Direct Shops linked to the Local Shop. | ||
| linked_direct_shop_list.direct_shop_id | int64 | 223009454 | Shop ID of the Cross Border Direct Shop. | |
| linked_direct_shop_list.direct_shop_region | string | SG | Shop Region of the Cross Border Direct Shop. | |
| is_one_awb | boolean | true | Use this filed to indicate if the shop is in 1-AWB whitelist.; If is_one_awb return true, please use new AWB size (10cm x 15cm thermal paper) to print AWB. For more details, please refer to: https://open.shopee.com/announcements/1138?category=3&is_top=false | |
| is_mart_shop | boolean | false | Indicates whether the current shop is a Mart Shop. | |
| is_outlet_shop | boolean | false | Indicates whether the current shop is an Outlet Shop. | |
| mart_shop_id | int64 | 1234567890 | (Only returned when requesting an Outlet Shop) Refers to the Mart Shop ID this Outlet belongs to. | |
| outlet_shop_info_list | object[] | (Only returned when requesting a Mart Shop) List of Outlet Shop IDs under this Mart Shop. | ||
| outlet_shop_info_list.outlet_shop_id | int64 | 1234567890 | Shop ID of the Outlet Shop. | |
| mart_outlet_structure_type | string | warehouse_mart_shop | (Only returned when requesting a Mart or Outlet Shop); Indicates the structure type of the Mart or Outlet shop. Applicable values are: normal_mart_shop, warehouse_mart_shop, normal_outlet_shop, warehouse_outlet_shop |
§4 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. | |
| 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 |
§5 Request samples
Request samples
§6 Java
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/shop/get_shop_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp")
.asString();
§7 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/shop/get_shop_info?access_token=access_token&partner_id=partner_id&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;
§8 cURL
cURL
curl --location --request GET 'https://partner.shopeemobile.com/api/v2/shop/get_shop_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp'
§9 Python
Python
import requests
url = "https://partner.shopeemobile.com/api/v2/shop/get_shop_info?access_token=access_token&partner_id=partner_id&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)
§10 Response sample
Response sample
§11 JSON
JSON
{
"error": "",
"message": "",
"request_id": "e3e3e7f3314a5c09fbf56b4649990b01",
"auth_time": 1741944925,
"expire_time": 1773503999,
"shop_name": "mysipuat",
"region": "MY",
"status": "NORMAL",
"shop_fulfillment_flag": "Others",
"is_cb": false,
"is_upgraded_cbsc": false,
"merchant_id": null,
"is_sip": true,
"sip_affi_shops": [
],
"is_main_shop": true,
"is_direct_shop": false,
"linked_direct_shop_list": [
{
"direct_shop_id": 223009454,
"direct_shop_region": "SG"
}
],
"linked_main_shop_id": 0
}
§12 Error example
Error example
§13 JSON
JSON
{
"request_id": "11d5faea741d928705bfa903a21e166c",
"error": "error_auth",
"message": "Invalid partner_id or shopid."
}
§14 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_shop | shopid is invalid | |
| error_not_exists | The user does not exist. | |
| error_param | request not from gateway | |
| error_param | The shop id you provided is not found. Please check your shop id. |
§15 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. | |
| error_param | There is no access_token in query. | |
| error_auth | Invalid access_token. | |
| error_auth | Invalid partner_id or shopid. | |
| shop_no_linked | Partner and shop has no linked. | |
| shop_banned | The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| partner_shop_no_link | Invalid partner_id or shop_id, please have a check. | |
| error_ashop_api_permission | The shop is Affiliate shop has no permission to call this API. | |
| error_kyc_auth | No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API. | |
| error_auth | System error, please try again later. | |
| error_param | There is no shop_id in query. | |
| error_param | shop_id is invalid, should be an integer between 0 and 4294967295. |
§16 Update log
Update log
| Date | Change |
|---|---|
| 2026-05-19 | support mart_outlet_structure_type in response |
| 2025-08-25 | support mart/outlet shop type in response |
| 2025-05-15 | add new field "is_one_awb" |
| 2025-03-27 | Add new fields to enable determination if a shop is operating under the Cross Border Direct Selling model |
| 2024-10-25 | add "LFF Hybrid Shop" option for "shop_fulfillment_flag" response parameter |
