淘宝开放平台 - 文档中心

请求地址：

环境	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_id	String	可选	432234		组id

名称	类型	示例值	描述
data	YmLockerGroup		data
└ group_id String 1 groupId └ locker_count Number 1 lockerCount locker_list YmLocker [] lockerList └ middle Number 1 big └ free_middle Number 1 freeBig └ free_large Number 1 freeLarge └ free_small Number 1 freeSmall └ free_total Number 1 freeTotal └ large Number 1 large └ lat String 1 lat └ lng String 1 lng └ locker_addr String 1 lockerAddr └ locker_code String 1 lockerCode └ locker_name String 1 lockerName └ locker_no String 1 lockerNo └ phone String 1 phone └ small Number 1 small └ total Number 1 total └ phone String 1 phone └ total_free Number 1 totalFree
status_code	String	1	statusCode
status_message	String	1	statusMessage
is_success	Boolean	true	success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaLockerLockergroupDetailRequest req = new CainiaoYimaLockerLockergroupDetailRequest();
req.setGroupId("432234");
CainiaoYimaLockerLockergroupDetailResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoYimaLockerLockergroupDetailRequest req = new CainiaoYimaLockerLockergroupDetailRequest();
req.GroupId = "432234";
CainiaoYimaLockerLockergroupDetailResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoYimaLockerLockergroupDetailRequest;
$req->setGroupId("432234");
$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.lockergroup.detail' \
-d 'partner_id=apidoc' \
-d 'sign=9AA159BDCCFD0FCC7A2E18B9D33F9AA3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+18%3A37%3A52' \
-d 'v=2.0' \
-d 'group_id=432234'

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

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

req.group_id="432234"
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.lockergroup.detail");
add_param(pRequest,"group_id","432234");
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.lockergroup.detail', {
	'group_id':'432234'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_yima_locker_lockergroup_detail_response>
    <data>
        <group_id>1</group_id>
        <locker_count>1</locker_count>
        <locker_list>
            <ym_locker>
                <middle>1</middle>
                <free_middle>1</free_middle>
                <free_large>1</free_large>
                <free_small>1</free_small>
                <free_total>1</free_total>
                <large>1</large>
                <lat>1</lat>
                <lng>1</lng>
                <locker_addr>1</locker_addr>
                <locker_code>1</locker_code>
                <locker_name>1</locker_name>
                <locker_no>1</locker_no>
                <phone>1</phone>
                <small>1</small>
                <total>1</total>
            </ym_locker>
        </locker_list>
        <phone>1</phone>
        <total_free>1</total_free>
    </data>
    <status_code>1</status_code>
    <status_message>1</status_message>
    <is_success>true</is_success>
</cainiao_yima_locker_lockergroup_detail_response>

{
    "cainiao_yima_locker_lockergroup_detail_response":{
        "data":{
            "group_id":"1",
            "locker_count":1,
            "locker_list":{
                "ym_locker":[
                    {
                        "middle":1,
                        "free_middle":1,
                        "free_large":1,
                        "free_small":1,
                        "free_total":1,
                        "large":1,
                        "lat":"1",
                        "lng":"1",
                        "locker_addr":"1",
                        "locker_code":"1",
                        "locker_name":"1",
                        "locker_no":"1",
                        "phone":"1",
                        "small":1,
                        "total":1
                    }
                ]
            },
            "phone":"1",
            "total_free":1
        },
        "status_code":"1",
        "status_message":"1",
        "is_success":true
    }
}

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.lockergroup.detail (查区域自提柜详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ