淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
package_query_d_t_o	PackageQueryDTO	可选			入参
└ token_code String 可选 20111xxx 同城令牌号 └ node_code String 可选 20111xxx 仓Code └ work_unit_id String 可选 lbx 作业单元ID

名称	类型	示例值	描述
result	Result		结果
data Data data route_nodes RouteNodes [] 路由节点 └ node_index String 1 节点序号 └ node_type String 1 节点类型 └ node_code String 大润发闸北店节点名称 └ token_codes String [] 令牌列表 └ operational_requirement String 温层:冷服务要求:贵品作业要求 └ merge_order_tag String 多-2 合单标 └ buyer_address String xxxx 收件人地址 └ buyer_phone String 138****1234 收件人电话 └ buyer_name String 张三收件人名称 └ time_order_tag String 早001 末端合流标示 └ aoi_name String 阿里巴巴西溪园区 AOI名称 └ route_area String 123456 区块ID └ wave_time String 09:00:00~13:00:00 波次时间 └ fulfill_date String 2020-11-26 应履约日期 └ end_rdc_short_code String 1 1 └ site_short_code String 1 1 └ end_chute_short_code String 1 1 └ success Boolean true 成功 └ code String 1001 1001 └ message String 1001 1001

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCainiaoWhcWarehouseTmsQueryRequest req = new AlibabaCainiaoWhcWarehouseTmsQueryRequest();
AlibabaCainiaoWhcWarehouseTmsQueryRequest.PackageQueryDTO obj1 = new AlibabaCainiaoWhcWarehouseTmsQueryRequest.PackageQueryDTO();
obj1.setTokenCode("20111xxx");
obj1.setNodeCode("20111xxx");
obj1.setWorkUnitId("lbx");
req.setPackageQueryDTO(obj1);
AlibabaCainiaoWhcWarehouseTmsQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaCainiaoWhcWarehouseTmsQueryRequest req = new AlibabaCainiaoWhcWarehouseTmsQueryRequest();
AlibabaCainiaoWhcWarehouseTmsQueryRequest.PackageQueryDTODomain obj1 = new AlibabaCainiaoWhcWarehouseTmsQueryRequest.PackageQueryDTODomain();
obj1.TokenCode = "20111xxx";
obj1.NodeCode = "20111xxx";
obj1.WorkUnitId = "lbx";
req.PackageQueryDTO_ = obj1;
AlibabaCainiaoWhcWarehouseTmsQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaCainiaoWhcWarehouseTmsQueryRequest;
$package_query_d_t_o = new PackageQueryDTO;
$package_query_d_t_o->token_code="20111xxx";
$package_query_d_t_o->node_code="20111xxx";
$package_query_d_t_o->work_unit_id="lbx";
$req->setPackageQueryDTO(json_encode($package_query_d_t_o));
$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=alibaba.cainiao.whc.warehouse.tms.query' \
-d 'partner_id=apidoc' \
-d 'sign=2C51F0275735C4A9D03A9087E89E233A' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+09%3A15%3A20' \
-d 'v=2.0' \
-d 'package_query_d_t_o=%7B%7D'

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

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

req.package_query_d_t_o="{}"
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,"alibaba.cainiao.whc.warehouse.tms.query");
add_param(pRequest,"package_query_d_t_o","数据结构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('alibaba.cainiao.whc.warehouse.tms.query', {
	'package_query_d_t_o':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_cainiao_whc_warehouse_tms_query_response>
    <result>
        <data>
            <route_nodes>
                <route_nodes>
                    <node_index>1</node_index>
                    <node_type>1</node_type>
                    <node_code>大润发闸北店</node_code>
                </route_nodes>
            </route_nodes>
            <operational_requirement>温层:冷 服务要求:贵品</operational_requirement>
            <merge_order_tag>多-2</merge_order_tag>
            <buyer_address>xxxx</buyer_address>
            <buyer_phone>138****1234</buyer_phone>
            <buyer_name>张三</buyer_name>
            <time_order_tag>早001</time_order_tag>
            <aoi_name>阿里巴巴西溪园区</aoi_name>
            <route_area>123456</route_area>
            <wave_time>09:00:00~13:00:00</wave_time>
            <fulfill_date>2020-11-26</fulfill_date>
            <end_rdc_short_code>1</end_rdc_short_code>
            <site_short_code>1</site_short_code>
            <end_chute_short_code>1</end_chute_short_code>
        </data>
        <success>true</success>
        <code>1001</code>
        <message>1001</message>
    </result>
</alibaba_cainiao_whc_warehouse_tms_query_response>

{
    "alibaba_cainiao_whc_warehouse_tms_query_response":{
        "result":{
            "data":{
                "route_nodes":{
                    "route_nodes":[
                        {
                            "node_index":"1",
                            "node_type":"1",
                            "node_code":"大润发闸北店"
                        }
                    ]
                },
                "operational_requirement":"温层:冷 服务要求:贵品",
                "merge_order_tag":"多-2",
                "buyer_address":"xxxx",
                "buyer_phone":"138****1234",
                "buyer_name":"张三",
                "time_order_tag":"早001",
                "aoi_name":"阿里巴巴西溪园区",
                "route_area":"123456",
                "wave_time":"09:00:00~13:00:00",
                "fulfill_date":"2020-11-26",
                "end_rdc_short_code":"1",
                "site_short_code":"1",
                "end_chute_short_code":"1"
            },
            "success":true,
            "code":"1001",
            "message":"1001"
        }
    }
}

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

alibaba.cainiao.whc.warehouse.tms.query (获取面单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ