淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
track_info	TrackingInfo	必须			回传信息
└ gui_id String 必须 12345 柜子ID └ order_type Number 必须 0 订单类型(0-代收业务,1-寄件业务) └ getter_phone String 可选 13200010001 取件人手机号码 └ post_phone String 可选 15200010001 投件人手机号码 └ extra String 可选 {"authCode":"xj3c"} 扩展属性(json键值对),如果是开柜码开柜，返回开柜码 └ action_time Number 必须 14424776121 回传时间 └ gui_no String 必须 A50 柜子编码 └ company_code String 必须 cainiao.lockers.cn 柜子公司编码 └ mail_no String 可选 2342145 运单号 └ action_code String 必须 POSTMAN_POST 动作编码 └ gui_type String 必须 LARGE 柜子格口类型 └ order_code String 必须 abdefg 柜子公司唯一订单号

名称	类型	示例值	描述
result	SingleResult		result
└ error_desc String 调用成功返回信息描述/错误信息描述 └ error_code String 200 参照返回码定义 └ data String {} data └ success Boolean true success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoEndpointLockerTopOrderTrackingRequest req = new CainiaoEndpointLockerTopOrderTrackingRequest();
CainiaoEndpointLockerTopOrderTrackingRequest.TrackingInfo obj1 = new CainiaoEndpointLockerTopOrderTrackingRequest.TrackingInfo();
obj1.setGuiId("12345");
obj1.setOrderType(0L);
obj1.setGetterPhone("13200010001");
obj1.setPostPhone("15200010001");
obj1.setExtra("{\"authCode\":\"xj3c\"}");
obj1.setActionTime(14424776121L);
obj1.setGuiNo("A50");
obj1.setCompanyCode("cainiao.lockers.cn");
obj1.setMailNo("2342145");
obj1.setActionCode("POSTMAN_POST");
obj1.setGuiType("LARGE");
obj1.setOrderCode("abdefg");
req.setTrackInfo(obj1);
CainiaoEndpointLockerTopOrderTrackingResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoEndpointLockerTopOrderTrackingRequest req = new CainiaoEndpointLockerTopOrderTrackingRequest();
CainiaoEndpointLockerTopOrderTrackingRequest.TrackingInfoDomain obj1 = new CainiaoEndpointLockerTopOrderTrackingRequest.TrackingInfoDomain();
obj1.GuiId = "12345";
obj1.OrderType = 0L;
obj1.GetterPhone = "13200010001";
obj1.PostPhone = "15200010001";
obj1.Extra = "{\"authCode\":\"xj3c\"}";
obj1.ActionTime = 14424776121L;
obj1.GuiNo = "A50";
obj1.CompanyCode = "cainiao.lockers.cn";
obj1.MailNo = "2342145";
obj1.ActionCode = "POSTMAN_POST";
obj1.GuiType = "LARGE";
obj1.OrderCode = "abdefg";
req.TrackInfo_ = obj1;
CainiaoEndpointLockerTopOrderTrackingResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoEndpointLockerTopOrderTrackingRequest;
$track_info = new TrackingInfo;
$track_info->gui_id="12345";
$track_info->order_type="0";
$track_info->getter_phone="13200010001";
$track_info->post_phone="15200010001";
$track_info->extra="{\"authCode\":\"xj3c\"}";
$track_info->action_time="14424776121";
$track_info->gui_no="A50";
$track_info->company_code="cainiao.lockers.cn";
$track_info->mail_no="2342145";
$track_info->action_code="POSTMAN_POST";
$track_info->gui_type="LARGE";
$track_info->order_code="abdefg";
$req->setTrackInfo(json_encode($track_info));
$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.order.tracking' \
-d 'partner_id=apidoc' \
-d 'sign=CC054B71496166A661487AD602ED93C7' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-03+23%3A00%3A52' \
-d 'v=2.0' \
-d 'track_info=null'

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

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

req.track_info=""
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.order.tracking");
add_param(pRequest,"track_info","数据结构JSON示例");
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.order.tracking', {
	'track_info':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_endpoint_locker_top_order_tracking_response>
    <result>
        <error_desc>调用成功</error_desc>
        <error_code>200</error_code>
        <data>{}</data>
        <success>true</success>
    </result>
</cainiao_endpoint_locker_top_order_tracking_response>

{
    "cainiao_endpoint_locker_top_order_tracking_response":{
        "result":{
            "error_desc":"调用成功",
            "error_code":"200",
            "data":"{}",
            "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.locker.top.order.tracking (事件回传接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ