淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	描述
poster_phone	String	可选	15267468449	小件员手机号
user_id	Number	可选	4398625947469	小件员id
session_code	String	可选	sessionCode	登录态的session?ode

名称	类型	示例值	描述
data	AoiCabinetStatisticsDTO		结果数据集
aoi_cabinet_info_dto_list AoiCabinetInfoDTOList [] aoiCabinetInfoDTOList cabinet_info_list CabinetInfoList [] cabinetInfoList └ new_flag Boolean true 新柜机标 └ micro Number 1 微小格子 └ small Number 2 小格子 └ middle Number 3 中格子 └ large Number 1 大格子 └ huge Number 2 巨大格子 └ freezer Number 0 冷冻格子 └ cabinet_addr String 欣龙华府公寓中央花坛西侧2号柜地址 └ cabinet_no String CNYZ861100 柜子编码 └ aoi_name String 欣龙华府公寓小区名称 └ gmt_create Date 1528188554802 柜机创建时间 └ rights_small Number 3 权益小格口数目 └ rights_middle Number 2 权益中格口数目 └ rights_large Number 1 权益大格口数目 └ rent_small_grid_count Number 3 已租小格口数目 └ rent_middle_grid_count Number 3 已租中格口数目 └ rent_large_grid_count Number 3 已租大格口数目 └ can_rent Number 1 是否可租 └ can_use_coupon Number 0 是否有券可用 └ aoi_name String 欣龙华府公寓小区名称 └ company_name String 菜鸟柜子公司名称 └ new_cabinet_count Number 2 newCabinetCount └ top_text String 您当前有20个空置的专享格口，请在14:00前投递，逾期将释放顶部提示语 └ coupon_count Number 0 当前可用的优惠券总数 └ max_times_can_use_daily Number 5 免投券每天每柜最大可用数目
status_code	String	1212	错误码
status_message	String	没有登录	错误描述
is_success	Boolean	true	本次调用是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoEndpointCabinetTopPullnewUsedAoiRequest req = new CainiaoEndpointCabinetTopPullnewUsedAoiRequest();
req.setPosterPhone("15267468449");
req.setUserId(4398625947469L);
req.setSessionCode("sessionCode");
CainiaoEndpointCabinetTopPullnewUsedAoiResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoEndpointCabinetTopPullnewUsedAoiRequest req = new CainiaoEndpointCabinetTopPullnewUsedAoiRequest();
req.PosterPhone = "15267468449";
req.UserId = 4398625947469L;
req.SessionCode = "sessionCode";
CainiaoEndpointCabinetTopPullnewUsedAoiResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoEndpointCabinetTopPullnewUsedAoiRequest;
$req->setPosterPhone("15267468449");
$req->setUserId("4398625947469");
$req->setSessionCode("sessionCode");
$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.endpoint.cabinet.top.pullnew.used.aoi' \
-d 'partner_id=apidoc' \
-d 'sign=EBA98AF844098EA9A44C93B91313A381' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+18%3A32%3A11' \
-d 'v=2.0' \
-d 'poster_phone=15267468449' \
-d 'session_code=sessionCode' \
-d 'user_id=4398625947469'

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

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

req.poster_phone="15267468449"
req.user_id=4398625947469
req.session_code="sessionCode"
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.endpoint.cabinet.top.pullnew.used.aoi");
add_param(pRequest,"poster_phone","15267468449");
add_param(pRequest,"user_id","4398625947469");
add_param(pRequest,"session_code","sessionCode");
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.endpoint.cabinet.top.pullnew.used.aoi', {
	'poster_phone':'15267468449',
	'user_id':'4398625947469',
	'session_code':'sessionCode'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_endpoint_cabinet_top_pullnew_used_aoi_response>
    <data>
        <aoi_cabinet_info_dto_list>
            <aoi_cabinet_info_d_t_o_list>
                <cabinet_info_list>
                    <cabinet_info_list>
                        <new_flag>true</new_flag>
                        <micro>1</micro>
                        <small>2</small>
                        <middle>3</middle>
                        <large>1</large>
                        <huge>2</huge>
                        <freezer>0</freezer>
                        <cabinet_addr>欣龙华府公寓中央花坛西侧2号柜</cabinet_addr>
                        <cabinet_no>CNYZ861100</cabinet_no>
                        <aoi_name>欣龙华府公寓</aoi_name>
                        <gmt_create>1528188554802</gmt_create>
                        <rights_small>3</rights_small>
                        <rights_middle>2</rights_middle>
                        <rights_large>1</rights_large>
                        <rent_small_grid_count>3</rent_small_grid_count>
                        <rent_middle_grid_count>3</rent_middle_grid_count>
                        <rent_large_grid_count>3</rent_large_grid_count>
                        <can_rent>1</can_rent>
                        <can_use_coupon>0</can_use_coupon>
                    </cabinet_info_list>
                </cabinet_info_list>
                <aoi_name>欣龙华府公寓</aoi_name>
                <company_name>菜鸟</company_name>
            </aoi_cabinet_info_d_t_o_list>
        </aoi_cabinet_info_dto_list>
        <new_cabinet_count>2</new_cabinet_count>
        <top_text>您当前有20个空置的专享格口，请在14:00前投递，逾期将释放</top_text>
        <coupon_count>0</coupon_count>
        <max_times_can_use_daily>5</max_times_can_use_daily>
    </data>
    <status_code>1212</status_code>
    <status_message>没有登录</status_message>
    <is_success>true</is_success>
</cainiao_endpoint_cabinet_top_pullnew_used_aoi_response>

{
    "cainiao_endpoint_cabinet_top_pullnew_used_aoi_response":{
        "data":{
            "aoi_cabinet_info_dto_list":{
                "aoi_cabinet_info_d_t_o_list":[
                    {
                        "cabinet_info_list":{
                            "cabinet_info_list":[
                                {
                                    "new_flag":true,
                                    "micro":1,
                                    "small":2,
                                    "middle":3,
                                    "large":1,
                                    "huge":2,
                                    "freezer":0,
                                    "cabinet_addr":"欣龙华府公寓中央花坛西侧2号柜",
                                    "cabinet_no":"CNYZ861100",
                                    "aoi_name":"欣龙华府公寓",
                                    "gmt_create":"1528188554802",
                                    "rights_small":3,
                                    "rights_middle":2,
                                    "rights_large":1,
                                    "rent_small_grid_count":3,
                                    "rent_middle_grid_count":3,
                                    "rent_large_grid_count":3,
                                    "can_rent":1,
                                    "can_use_coupon":0
                                }
                            ]
                        },
                        "aoi_name":"欣龙华府公寓",
                        "company_name":"菜鸟"
                    }
                ]
            },
            "new_cabinet_count":2,
            "top_text":"您当前有20个空置的专享格口，请在14:00前投递，逾期将释放",
            "coupon_count":0,
            "max_times_can_use_daily":5
        },
        "status_code":"1212",
        "status_message":"没有登录",
        "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.endpoint.cabinet.top.pullnew.used.aoi (常用小区aoi柜子列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ