v2.merchant.get_warehouse_eligible_shop_list

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

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

打开官方原文 ↗

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

查看技术与溯源信息

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

资料正文

§1 v2.merchant.get_warehouse_eligible_shop_list

Get eligible shop list by warehouse id

§2 Overview

Overview

Field	Value
Module	Merchant
API type	Merchant
HTTP method	POST
Path	/api/v2/merchant/get_warehouse_eligible_shop_list
Production URL	https://partner.shopeemobile.com/api/v2/merchant/get_warehouse_eligible_shop_list
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/merchant/get_warehouse_eligible_shop_list
Permission	ERP System; Seller In House System; Product Management; Swam ERP

§3 Request parameters

Request parameters

Name	Type	Required	Description
warehouse_id	int	Yes	Warehouse address identifier.
warehouse_type	int	Yes	1 means pickup warehouse; 2 means return warehouse
cursor	object	Yes	// how to use DoubleSidedCursor; // Get data for the first page: Please pass next_id = 0 or nil, page_size = {your page size}.; // Get data for the next page: Please pass the Cursor from the previous response, and set prev_id=nil;; // Get data for the prev page: Please pass the Cursor from the previous response, and set next_id=nil;; // Stop fetching next data: The Cursor.next_id in the previous response is nil.; // Stop fetching prev data: The Cursor.prev_id in the previous response is nil.
cursor.next_id	int	No
cursor.prev_id	int	No
cursor.page_size	int	Yes	The size of one page. Limit is [1,30].

§4 Response parameters

Response parameters

Name	Type	Description
request_id	string	The identifier of the API request for error tracking.
error	string	Indicate error type if hit error. Empty if no error happened.
message	string	Indicate error details if hit error. Empty if no error happened.
response	object
response.shop_list	object[]	Eligible shop list of the warehouse
response.shop_list.shop_id	int	Shopee's unique identifier for a shop.
response.shop_list.shop_name	string	Name of the shop.
response.cursor	object
response.cursor.next_id	int
response.cursor.prev_id	int
response.cursor.page_size	int

§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.
merchant_id	int	1	Shopee’s unique identifier for a merchant. Required for all merchant level requests(CB CNSC user calling global product related APIs).
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp, access_token, merchant_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 Payload

Payload

{
    "warehouse_id": 10001022,
    "warehouse_type": 1,
    "cursor": {
        "next_id": 0,
        "page_size": 4
    }
}

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://open.admin.shopee.io/api/v2/merchant/list_shop_by_warehouse?access_token=access_token&merchant_id=merchant_id&partner_id=partner_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"cursor\": {},
   \"warehouse_id\": 100,
   \"warehouse_type\": 1
}")
.asString();

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://open.admin.shopee.io/api/v2/merchant/list_shop_by_warehouse?access_token=access_token&merchant_id=merchant_id&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 => 'POST',
  CURLOPT_POSTFIELDS => '{
    "cursor": {},
    "warehouse_id": 100,
    "warehouse_type": 1
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

§10 cURL

cURL

curl --location --request POST 'https://open.admin.shopee.io/api/v2/merchant/list_shop_by_warehouse?access_token=access_token&merchant_id=merchant_id&partner_id=partner_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "cursor": {},
   "warehouse_id": 100,
   "warehouse_type": 1
}'

§11 Python

Python

import requests
import json

url = "https://open.admin.shopee.io/api/v2/merchant/list_shop_by_warehouse?access_token=access_token&merchant_id=merchant_id&partner_id=partner_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "cursor": {},
  "warehouse_id": 100,
  "warehouse_type": 1
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

§12 Response sample

Response sample

§13 JSON

JSON

{
    "error": null,
    "message": null,
    "request_id": "94bec7620823b3e78ed50fa6c8ec8381",
    "response": {
        "cursor": {
            "next_id": 222859324,
            "page_size": 4,
            "prev_id": null
        },
        "shop_list": [
            {
                "shop_id": 222859294,
                "shop_name": "test_shop11"
            },
            {
                "shop_id": 222859295,
                "shop_name": "test_shop12"
            },
            {
                "shop_id": 222859296,
                "shop_name": "test_shop13"
            },
            {
                "shop_id": 222859324,
                "shop_name": "test_shop14"
            }
        ]
    }
}

§14 Error example

Error example

§15 JSON

JSON

{
    "error": "error_param",
    "message": "warehouse_type: warehouse_type must be one of the following: 1, 2",
    "request_id": "1b0f12624b5315f449c6d3d6f6372eac",
    "response": null
}

§16 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_param	request not from gateway

§17 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.
merchant_no_linked	Partner and merchant has no linked.
invalid_acceess_token	Invalid access_token, please have a check.
partner_frozen	The Partner has been frozen. Permissions for merchant authorization and API calls have been suspended until permissions are restored.
error_param	There is no merchant_id in query.
error_param	merchant_id is invalid, should be an integer between 0 and 4294967295.

§18 Update log

Update log

Date	Change
2023-12-14	New API

这条内容对你有帮助吗？