淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	描述
group_name	String	可选	测试小区	五级地址名字
lng	BigDecimal	可选	120.00904	经度
lat	BigDecimal	可选	30.27993	纬度
user_id	Number	可选	12333	小件员id

名称	类型	示例值	描述
status_message	String	成功	errorDesc
status_code	String	200	errorCode
is_success	Boolean	success	success
data	CourierAoiProposalGuiStation	courierAoiProposalGuiStation	推荐柜子信息
gui_station_groups Guistationgroups [] 小区列表小区列表 station_list Stationlist [] stationList stationList └ free_huge Number 5 超大格空闲数 └ gui_name_r String 菜鸟总部（乐佳国际大厦）MOCK 柜子名字 └ gui_addr_r String 菜鸟总部（乐佳国际大厦）1号楼南面柜子地址 └ id Number 1 柜子stationid └ default_appointment_unit_num Number 2 默认周期数量 └ default_appointment_unit String hour 默认周期单位(hour,day,week) appointment_cells_info AppointmentCellsInfo 已预约的格口信息已预约的格口信息 └ micro Number 0 已预微格数 └ small Number 1 已预小格数 └ middle Number 1 已预中格数 └ large Number 1 已预大格数 └ huge Number 0 已预超大格数 gui_cell_fee GuiCellFee 格口费用信息格口费用信息 appoint_fee GuiCellAppointFeeDto 约柜费用，单位是分约柜费用，单位是分 └ micro_fee_per_hour Number 10 微格时费 └ small_fee_per_hour Number 20 小格时费 └ middle_fee_per_hour Number 30 中格时费 └ large_fee_per_hour Number 40 大格时费 └ huge_fee_per_hour Number 50 超大格时费 └ free_micro Number 6 微格空闲数 └ free_small Number 6 小格空闲数 └ free_middle Number 4 中格空闲数 └ free_large Number 4 大格空闲数 company Company 柜子公司柜子公司 └ company_name String 速递易柜子公司名字 └ already_appoint_desc String 已预约2格待投递已预约文案 └ gui_brand String 速递易翠苑一区柜子品牌 └ recent_online Boolean true 是否是最近上线柜机 └ gui_no_r String CNYZ250000 柜子编码 current_grid_rent_map Currentgridrentmap 已租格口数目 └ small Number 10 已租小格口数目 └ middle Number 10 已租中格口数目 └ large Number 10 已租大格口数目 └ can_rent Boolean true 该柜机是否可租 └ total Number 5 柜子总数 └ group_id String 1 小区id └ group_name String 翠玉一区小区名字(aoiName) └ total Number 3 总的小区数 └ authoriz_support_official_doc String 目前仅支持速递易自提柜扫码页的展示文案 └ recent_online_total Number 10 最近上线总柜机数

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaLockerGuistationGroupQueryRequest req = new CainiaoYimaLockerGuistationGroupQueryRequest();
req.setGroupName("测试小区");
req.setLng("120.00904");
req.setLat("30.27993");
req.setUserId(12333L);
CainiaoYimaLockerGuistationGroupQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoYimaLockerGuistationGroupQueryRequest req = new CainiaoYimaLockerGuistationGroupQueryRequest();
req.GroupName = "测试小区";
req.Lng = "120.00904";
req.Lat = "30.27993";
req.UserId = 12333L;
CainiaoYimaLockerGuistationGroupQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoYimaLockerGuistationGroupQueryRequest;
$req->setGroupName("测试小区");
$req->setLng("120.00904");
$req->setLat("30.27993");
$req->setUserId("12333");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=cainiao.yima.locker.guistation.group.query' \
-d 'partner_id=apidoc' \
-d 'sign=55C3F03C1360CB9054D1955EDF0F5CFC' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-12+10%3A52%3A09' \
-d 'v=2.0' \
-d 'group_name=%E6%B5%8B%E8%AF%95%E5%B0%8F%E5%8C%BA' \
-d 'lat=30.27993' \
-d 'lng=120.00904' \
-d 'user_id=12333'

# -*- coding: utf-8 -*-
import top.api

req=top.api.CainiaoYimaLockerGuistationGroupQueryRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.group_name="测试小区"
req.lng="120.00904"
req.lat="30.27993"
req.user_id=12333
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"cainiao.yima.locker.guistation.group.query");
add_param(pRequest,"group_name","测试小区");
add_param(pRequest,"lng","120.00904");
add_param(pRequest,"lat","30.27993");
add_param(pRequest,"user_id","12333");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('cainiao.yima.locker.guistation.group.query', {
	'group_name':'测试小区',
	'lng':'120.00904',
	'lat':'30.27993',
	'user_id':'12333'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_yima_locker_guistation_group_query_response>
    <status_message>成功</status_message>
    <status_code>200</status_code>
    <is_success>success</is_success>
    <data>
        <gui_station_groups>
            <guistationgroups>
                <station_list>
                    <stationlist>
                        <free_huge>5</free_huge>
                        <gui_name_r>菜鸟总部（乐佳国际大厦）MOCK</gui_name_r>
                        <gui_addr_r>菜鸟总部（乐佳国际大厦）1号楼南面</gui_addr_r>
                        <id>1</id>
                        <default_appointment_unit_num>2</default_appointment_unit_num>
                        <default_appointment_unit>hour</default_appointment_unit>
                        <appointment_cells_info>
                            <micro>0</micro>
                            <small>1</small>
                            <middle>1</middle>
                            <large>1</large>
                            <huge>0</huge>
                        </appointment_cells_info>
                        <gui_cell_fee>
                            <appoint_fee>
                                <micro_fee_per_hour>10</micro_fee_per_hour>
                                <small_fee_per_hour>20</small_fee_per_hour>
                                <middle_fee_per_hour>30</middle_fee_per_hour>
                                <large_fee_per_hour>40</large_fee_per_hour>
                                <huge_fee_per_hour>50</huge_fee_per_hour>
                            </appoint_fee>
                        </gui_cell_fee>
                        <free_micro>6</free_micro>
                        <free_small>6</free_small>
                        <free_middle>4</free_middle>
                        <free_large>4</free_large>
                        <company>
                            <company_name>速递易</company_name>
                        </company>
                        <already_appoint_desc>已预约2格待投递</already_appoint_desc>
                        <gui_brand>速递易翠苑一区</gui_brand>
                        <recent_online>true</recent_online>
                        <gui_no_r>CNYZ250000</gui_no_r>
                        <current_grid_rent_map>
                            <small>10</small>
                            <middle>10</middle>
                            <large>10</large>
                        </current_grid_rent_map>
                        <can_rent>true</can_rent>
                    </stationlist>
                </station_list>
                <total>5</total>
                <group_id>1</group_id>
                <group_name>翠玉一区</group_name>
            </guistationgroups>
        </gui_station_groups>
        <total>3</total>
        <authoriz_support_official_doc>目前仅支持速递易自提柜</authoriz_support_official_doc>
        <recent_online_total>10</recent_online_total>
    </data>
</cainiao_yima_locker_guistation_group_query_response>

{
    "cainiao_yima_locker_guistation_group_query_response":{
        "status_message":"成功",
        "status_code":"200",
        "is_success":success,
        "data":{
            "gui_station_groups":{
                "guistationgroups":[
                    {
                        "station_list":{
                            "stationlist":[
                                {
                                    "free_huge":5,
                                    "gui_name_r":"菜鸟总部（乐佳国际大厦）MOCK",
                                    "gui_addr_r":"菜鸟总部（乐佳国际大厦）1号楼南面",
                                    "id":1,
                                    "default_appointment_unit_num":2,
                                    "default_appointment_unit":"hour",
                                    "appointment_cells_info":{
                                        "micro":0,
                                        "small":1,
                                        "middle":1,
                                        "large":1,
                                        "huge":0
                                    },
                                    "gui_cell_fee":{
                                        "appoint_fee":{
                                            "micro_fee_per_hour":10,
                                            "small_fee_per_hour":20,
                                            "middle_fee_per_hour":30,
                                            "large_fee_per_hour":40,
                                            "huge_fee_per_hour":50
                                        }
                                    },
                                    "free_micro":6,
                                    "free_small":6,
                                    "free_middle":4,
                                    "free_large":4,
                                    "company":{
                                        "company_name":"速递易"
                                    },
                                    "already_appoint_desc":"已预约2格待投递",
                                    "gui_brand":"速递易翠苑一区",
                                    "recent_online":true,
                                    "gui_no_r":"CNYZ250000",
                                    "current_grid_rent_map":{
                                        "small":10,
                                        "middle":10,
                                        "large":10
                                    },
                                    "can_rent":true
                                }
                            ]
                        },
                        "total":5,
                        "group_id":"1",
                        "group_name":"翠玉一区"
                    }
                ]
            },
            "total":3,
            "authoriz_support_official_doc":"目前仅支持速递易自提柜",
            "recent_online_total":10
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

驿马前台api

cainiao.yima.locker.guistation.group.query (查询附近的的五级地址集和柜子集)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ