v2.shop.get_warehouse_detail

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

来自 Shopee 官方资料快照 · 2026-09-06 12:15:21

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.shop.get_warehouse_detail

For given shop id and region, return warehouse info including warehouse id, address id and location id, return all warehouse with once call.

§2 Overview

Overview

Field	Value
Module	Shop
API type	Shop
HTTP method	GET
Path	/api/v2/shop/get_warehouse_detail
Production URL	https://partner.shopeemobile.com/api/v2/shop/get_warehouse_detail
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/shop/get_warehouse_detail
Permission	ERP System; Seller In House System; Product Management; Order Management; Swam ERP

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
warehouse_type	int32	No	1	Type of warehouse. Applicable values: - 1: Pickup Warehouse; - 2: Return Warehouse; Default value is 1 (Pickup Warehouse)

§4 Response parameters

Response parameters

Name	Type	Sample	Description
error	string	warehouse.error_not_in_whitelist	The error key if there's error.
message	string	Your shop is not in multi-warehouse whitelist.	Messages about the error and it's cause if there're errors. It will be just return the updated information if there's no error.
request_id	string	16488d76e337c606s5504f26	The identifier for an API request for error tracking.
response	object[]
response.warehouse_id	int64	6	Warehouse address identifier. It should be unique for every warehouse address
response.warehouse_name	string	warehouse1	The warehouse name filled in when creating the warehouse address
response.warehouse_type	int32	1	Type of warehouse. Applicable values: - 1: Pickup Warehouse; - 2: Return Warehouse
response.location_id	string	IDZ	Location identifier for stocks. Different location_ids represent that your addresses are in different item stocks
response.address_id	int64	118454205	Identity of address
response.region	string	ID	Region of your warehouse address
response.state	string	ACEH	State of your warehouse address
response.city	string	KAB. ACEH UTARA	City of your warehouse address
response.address	string	Parque Sagrada Família	Detail address of your warehouse address
response.zipcode	string	24379	Zipcode of your warehouse address
response.district	string	Mato Grosso	Distinct of your warehouse address
response.town	string	Av Maria H A dos Santos	Town of your warehouse address
response.state_code	string	12345	State code of your warehouse address
response.holiday_mode_state	int32	0	The holiday mode state of your address. 0: not in holiday mode; 1: holiday mode active; 2: holiday mode is turning of; 3: holiday mode is turning on

§5 Common parameters

Common 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

§6 Request samples

Request samples

§7 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/shop/get_warehouse_detail?shop_id=shop_id&partner_id=partner_id&access_token=access_token&timestamp=timestamp&region=ID&sign=sign")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/shop/get_warehouse_detail?access_token=access_token&partner_id=partner_id&region=ID&shop_id=shop_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/shop/get_warehouse_detail?access_token=access_token&timestamp=timestamp&region=ID&sign=sign&shop_id=shop_id&partner_id=partner_id'

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/shop/get_warehouse_detail?access_token=access_token&partner_id=partner_id&region=ID&shop_id=shop_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

{
	"request_id": "16488d76e337c606s5504f26",
	"error": "warehouse.error_not_in_whitelist",
	"message": "Your shop is not in multi-warehouse whitelist.",
	"response": [
		{
			"warehouse_id": 6,
			"warehouse_name": "warehouse1",
                        "warehouse_type": 1,
			"location_id": "IDZ",
                        "address_id": 118454205,
			"region": "ID",
			"state": "ACEH",
			"city": "KAB. ACEH UTARA",
			"district": "Mato Grosso",
			"town": "Av Maria H A dos Santos",
			"address": "Parque Sagrada Família",
			"zipcode": "24379",
			"state_code": "12345",
			"holiday_mode_state": 0
		}
	]
}

§13 Error example

Error example

§14 JSON

JSON

{
    "request_id": "16488a76f483ed60655sc0426",
    "error": "warehouse.error_not_in_whitelist",
    "message": "Your shop is not in multi-warehouse whitelist.",
    "response": null
}

§15 Errors

Errors

Error	Description	Solution
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_param	request not from gateway
warehouse.error_can_not_find_warehouse	This error will show if there is no legal warehouse address for given shop id
warehouse.error_not_in_whitelist	This error will show if your shop has no permission to access multi-warehouse
warehouse.error_region_can_not_blank	This error will show if region is missing.
warehouse.error_region_not_valid	This error will show if region is not in ID, PH, VN, SG, TW, MX
warehouse.error_shop_id_can_not_blank	This error will show if shop id is missing.

§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.
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.

§17 Update log

Update log

Date	Change
2025-01-13	add warehouse_type request & response parameter
2024-01-09	add address_id response parameter
2023-05-26	update the parameter name from country to region
2022-06-10	remove region request parametre
2022-05-19	New API

这条内容对你有帮助吗？