淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
user_id	Number	必须	4398046996756	账户ID
search_text	String	必须	4342	搜索的文本
session_code	String	必须	adfads	sessionCode

名称	类型	示例值	描述
data	PostListQueryResultDto		返回值
collections_not_take CollectionsNotTakeList 待取件列表 cabinet_post_list CabinetPostList [] cabinetPostDTOList collection_post_list CollectionPostList [] collectionPostDTOList └ mail_no String 920298384342 运单号 └ guest_phone String 15868861909 收件人手机号 └ gui_order_id Number 780012 订单id └ take_time String 1497002174000 取件时间 └ take_role Number 3 取件人角色 └ post_time String 1497002163000 投递时间 └ guest_address String 万家花城10-2-111 取件地址 └ exceeded_hours Number 72 超时时间 └ lg_order_code String 123421 物流单号 └ gui_id String sss12RF3Rdfggt guiId柜子唯一标识 └ company_code String cabinet.cainiao.com 公司编码 └ station_id Number 114425 柜子stationId └ gui_company_name String 速递易快递公司部 └ total_collection_num Number 1 包裹总数 └ fifth_address String [速递易] 填充快递公司名 └ cabinet_detail_address String 临江花园23幢自行车库速递易柜子地址 └ delivery_status_enum String ALREADY_TAKE 枚举值 └ total_collection_num Number 1 总数 collections_already_take CollectionsAlreadyTakeList 已取件包裹列表 cabinet_post_list CabinetPostList [] cabinetPostDTOList collection_post_list CollectionPostList [] collectionPostDTOList └ mail_no String 920298384342 运单号 └ guest_phone String 15868861909 收件人手机号 └ gui_order_id Number 780012 订单OrderId └ take_time String 1497002174000 取件时间 └ take_role Number 3 取件角色 └ post_time String 1497002163000 投递时间 └ lg_order_code String 123123 物流单号 └ guest_address String 万家花城取件地址 └ exceeded_hours Number 72 超时时间 └ gui_id String sss12RF3Rdfggt guiId柜子唯一标识 └ company_code String cabinet.cainiao.com companyCode公司编码 └ station_id Number 114425 柜子stationId └ gui_company_name String 速递易柜子公司名称 └ total_collection_num Number 1 包裹总数 └ fifth_address String [速递易] 填充快递公司名 └ cabinet_detail_address String 临江花园23幢自行车库速递易柜子地址 └ delivery_status_enum String ALREADY_TAKE 枚举值 └ total_collection_num Number 1 总数 collections_over_time CollectionOverTimeList 滞留件列表 cabinet_post_list CabinetPostList [] cabinetPostDTOList collection_post_list CollectionPostList [] collectionPostDTOList └ mail_no String 9202983284342 运单号 └ exceeded_hours Number 72 超时时间 └ guest_phone String 13475180712 取件人手机号 └ gui_order_id Number 780013 订单OrderId └ post_time String 1497004296000 投递时间 └ lg_order_code String 12313 物流订单号 └ take_role Number 2 takeRole 2快递员 3用户 4管理员 └ take_time String 1231241231 取件时间 └ guest_address String 万家花城取件地址 └ gui_id String sss12RF3Rdfggt guiId柜子唯一标识 └ company_code String cabinet.cainiao.com companyCode公司编码 └ station_id Number 114425 柜子stationId └ gui_company_name String 速递易柜子公司名称 └ total_collection_num Number 1 包裹总数 └ fifth_address String [速递易] 填充快递公司名 └ cabinet_detail_address String 临江花园23幢自行车库速递易柜子地址 └ delivery_status_enum String OVETTIME 枚举值 └ total_collection_num Number 1 包裹总数 └ logistics_flag Boolean true 是否为物流详情，true是 package_trace_detail_list PackageTraceDetailList [] 物流详情list └ buyer_nick String 昵称昵称 └ city String 杭州城市 └ receiver_contact String 12348888 收件人电话 └ tp_name String 圆通快递快递名称 └ city_code String 330011 城市编号 └ standerd_desc String xxx 快件已签收标准描述 └ gmt_create String 2018-01-03 11:22:33 创建时间 └ operator String 李三操作人 └ mail_no String 122aswqwww222 运单号 └ tp_code String YTO 快递公司编码 └ operator_contact String 1212xxxx3334 操作人联系方式 └ district String 西湖区区 └ sender_contact String 153xxxx3321 送件人电话 └ action String TMS_SIGN 动作 └ order_code String LP22200011 lpcode淘系订单 └ time Number 111110000 时间 └ desc String xxx 已签收描述
is_success	Boolean	true	成功与否标志
status_code	String	error	错误编码
status_message	String	error	错误描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoEndpointLockerTopPostSearchRequest req = new CainiaoEndpointLockerTopPostSearchRequest();
req.setUserId(4398046996756L);
req.setSearchText("4342");
req.setSessionCode("adfads");
CainiaoEndpointLockerTopPostSearchResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoEndpointLockerTopPostSearchRequest req = new CainiaoEndpointLockerTopPostSearchRequest();
req.UserId = 4398046996756L;
req.SearchText = "4342";
req.SessionCode = "adfads";
CainiaoEndpointLockerTopPostSearchResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoEndpointLockerTopPostSearchRequest;
$req->setUserId("4398046996756");
$req->setSearchText("4342");
$req->setSessionCode("adfads");
$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.locker.top.post.search' \
-d 'partner_id=apidoc' \
-d 'sign=32F61ED29AA1DADF12EB0372026042C9' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-03+23%3A02%3A41' \
-d 'v=2.0' \
-d 'search_text=4342' \
-d 'session_code=adfads' \
-d 'user_id=4398046996756'

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

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

req.user_id=4398046996756
req.search_text="4342"
req.session_code="adfads"
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.locker.top.post.search");
add_param(pRequest,"user_id","4398046996756");
add_param(pRequest,"search_text","4342");
add_param(pRequest,"session_code","adfads");
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.locker.top.post.search', {
	'user_id':'4398046996756',
	'search_text':'4342',
	'session_code':'adfads'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_endpoint_locker_top_post_search_response>
    <data>
        <collections_not_take>
            <cabinet_post_list>
                <cabinet_post_list>
                    <collection_post_list>
                        <collection_post_list>
                            <mail_no>920298384342</mail_no>
                            <guest_phone>15868861909</guest_phone>
                            <gui_order_id>780012</gui_order_id>
                            <take_time>1497002174000</take_time>
                            <take_role>3</take_role>
                            <post_time>1497002163000</post_time>
                            <guest_address>万家花城10-2-111</guest_address>
                            <exceeded_hours>72</exceeded_hours>
                            <lg_order_code>123421</lg_order_code>
                            <gui_id>sss12RF3Rdfggt</gui_id>
                            <company_code>cabinet.cainiao.com</company_code>
                        </collection_post_list>
                    </collection_post_list>
                    <station_id>114425</station_id>
                    <gui_company_name>速递易</gui_company_name>
                    <total_collection_num>1</total_collection_num>
                    <fifth_address>[速递易]</fifth_address>
                    <cabinet_detail_address>临江花园23幢自行车库速递易</cabinet_detail_address>
                </cabinet_post_list>
            </cabinet_post_list>
            <delivery_status_enum>ALREADY_TAKE</delivery_status_enum>
            <total_collection_num>1</total_collection_num>
        </collections_not_take>
        <collections_already_take>
            <cabinet_post_list>
                <cabinet_post_list>
                    <collection_post_list>
                        <collection_post_list>
                            <mail_no>920298384342</mail_no>
                            <guest_phone>15868861909</guest_phone>
                            <gui_order_id>780012</gui_order_id>
                            <take_time>1497002174000</take_time>
                            <take_role>3</take_role>
                            <post_time>1497002163000</post_time>
                            <lg_order_code>123123</lg_order_code>
                            <guest_address>万家花城</guest_address>
                            <exceeded_hours>72</exceeded_hours>
                            <gui_id>sss12RF3Rdfggt</gui_id>
                            <company_code>cabinet.cainiao.com</company_code>
                        </collection_post_list>
                    </collection_post_list>
                    <station_id>114425</station_id>
                    <gui_company_name>速递易</gui_company_name>
                    <total_collection_num>1</total_collection_num>
                    <fifth_address>[速递易]</fifth_address>
                    <cabinet_detail_address>临江花园23幢自行车库速递易</cabinet_detail_address>
                </cabinet_post_list>
            </cabinet_post_list>
            <delivery_status_enum>ALREADY_TAKE</delivery_status_enum>
            <total_collection_num>1</total_collection_num>
        </collections_already_take>
        <collections_over_time>
            <cabinet_post_list>
                <cabinet_post_list>
                    <collection_post_list>
                        <collection_post_list>
                            <mail_no>9202983284342</mail_no>
                            <exceeded_hours>72</exceeded_hours>
                            <guest_phone>13475180712</guest_phone>
                            <gui_order_id>780013</gui_order_id>
                            <post_time>1497004296000</post_time>
                            <lg_order_code>12313</lg_order_code>
                            <take_role>2</take_role>
                            <take_time>1231241231</take_time>
                            <guest_address>万家花城</guest_address>
                            <gui_id>sss12RF3Rdfggt</gui_id>
                            <company_code>cabinet.cainiao.com</company_code>
                        </collection_post_list>
                    </collection_post_list>
                    <station_id>114425</station_id>
                    <gui_company_name>速递易</gui_company_name>
                    <total_collection_num>1</total_collection_num>
                    <fifth_address>[速递易]</fifth_address>
                    <cabinet_detail_address>临江花园23幢自行车库速递易</cabinet_detail_address>
                </cabinet_post_list>
            </cabinet_post_list>
            <delivery_status_enum>OVETTIME</delivery_status_enum>
            <total_collection_num>1</total_collection_num>
        </collections_over_time>
        <logistics_flag>true</logistics_flag>
        <package_trace_detail_list>
            <package_trace_detail_list>
                <buyer_nick>昵称</buyer_nick>
                <city>杭州</city>
                <receiver_contact>12348888</receiver_contact>
                <tp_name>圆通快递</tp_name>
                <city_code>330011</city_code>
                <standerd_desc>xxx 快件已签收</standerd_desc>
                <gmt_create>2018-01-03 11:22:33</gmt_create>
                <operator>李三</operator>
                <mail_no>122aswqwww222</mail_no>
                <tp_code>YTO</tp_code>
                <operator_contact>1212xxxx3334</operator_contact>
                <district>西湖区</district>
                <sender_contact>153xxxx3321</sender_contact>
                <action>TMS_SIGN</action>
                <order_code>LP22200011</order_code>
                <time>111110000</time>
                <desc>xxx 已签收</desc>
            </package_trace_detail_list>
        </package_trace_detail_list>
    </data>
    <is_success>true</is_success>
    <status_code>error</status_code>
    <status_message>error</status_message>
</cainiao_endpoint_locker_top_post_search_response>

{
    "cainiao_endpoint_locker_top_post_search_response":{
        "data":{
            "collections_not_take":{
                "cabinet_post_list":{
                    "cabinet_post_list":[
                        {
                            "collection_post_list":{
                                "collection_post_list":[
                                    {
                                        "mail_no":"920298384342",
                                        "guest_phone":"15868861909",
                                        "gui_order_id":780012,
                                        "take_time":"1497002174000",
                                        "take_role":3,
                                        "post_time":"1497002163000",
                                        "guest_address":"万家花城10-2-111",
                                        "exceeded_hours":72,
                                        "lg_order_code":"123421",
                                        "gui_id":"sss12RF3Rdfggt",
                                        "company_code":"cabinet.cainiao.com"
                                    }
                                ]
                            },
                            "station_id":114425,
                            "gui_company_name":"速递易",
                            "total_collection_num":1,
                            "fifth_address":"[速递易]",
                            "cabinet_detail_address":"临江花园23幢自行车库速递易"
                        }
                    ]
                },
                "delivery_status_enum":"ALREADY_TAKE",
                "total_collection_num":1
            },
            "collections_already_take":{
                "cabinet_post_list":{
                    "cabinet_post_list":[
                        {
                            "collection_post_list":{
                                "collection_post_list":[
                                    {
                                        "mail_no":"920298384342",
                                        "guest_phone":"15868861909",
                                        "gui_order_id":780012,
                                        "take_time":"1497002174000",
                                        "take_role":3,
                                        "post_time":"1497002163000",
                                        "lg_order_code":"123123",
                                        "guest_address":"万家花城",
                                        "exceeded_hours":72,
                                        "gui_id":"sss12RF3Rdfggt",
                                        "company_code":"cabinet.cainiao.com"
                                    }
                                ]
                            },
                            "station_id":114425,
                            "gui_company_name":"速递易",
                            "total_collection_num":1,
                            "fifth_address":"[速递易]",
                            "cabinet_detail_address":"临江花园23幢自行车库速递易"
                        }
                    ]
                },
                "delivery_status_enum":"ALREADY_TAKE",
                "total_collection_num":1
            },
            "collections_over_time":{
                "cabinet_post_list":{
                    "cabinet_post_list":[
                        {
                            "collection_post_list":{
                                "collection_post_list":[
                                    {
                                        "mail_no":"9202983284342",
                                        "exceeded_hours":72,
                                        "guest_phone":"13475180712",
                                        "gui_order_id":780013,
                                        "post_time":"1497004296000",
                                        "lg_order_code":"12313",
                                        "take_role":2,
                                        "take_time":"1231241231",
                                        "guest_address":"万家花城",
                                        "gui_id":"sss12RF3Rdfggt",
                                        "company_code":"cabinet.cainiao.com"
                                    }
                                ]
                            },
                            "station_id":114425,
                            "gui_company_name":"速递易",
                            "total_collection_num":1,
                            "fifth_address":"[速递易]",
                            "cabinet_detail_address":"临江花园23幢自行车库速递易"
                        }
                    ]
                },
                "delivery_status_enum":"OVETTIME",
                "total_collection_num":1
            },
            "logistics_flag":true,
            "package_trace_detail_list":{
                "package_trace_detail_list":[
                    {
                        "buyer_nick":"昵称",
                        "city":"杭州",
                        "receiver_contact":"12348888",
                        "tp_name":"圆通快递",
                        "city_code":"330011",
                        "standerd_desc":"xxx 快件已签收",
                        "gmt_create":"2018-01-03 11:22:33",
                        "operator":"李三",
                        "mail_no":"122aswqwww222",
                        "tp_code":"YTO",
                        "operator_contact":"1212xxxx3334",
                        "district":"西湖区",
                        "sender_contact":"153xxxx3321",
                        "action":"TMS_SIGN",
                        "order_code":"LP22200011",
                        "time":111110000,
                        "desc":"xxx 已签收"
                    }
                ]
            }
        },
        "is_success":true,
        "status_code":"error",
        "status_message":"error"
    }
}

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.locker.top.post.search (搜索自提柜投件列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ