淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param_delivery_order_list_top_request	DeliveryOrderListTopRequest	可选			查询列表入参
└ page_no Number 必须 1 当前查询的页码 └ page_size Number 必须 10 当前查询的页大小 └ status Number 可选 1 状态（1--待接单，2--待揽收，3--已取消，4--待支付，6--配送中，7--已完成）

名称	类型	示例值	描述
result	Result		结果
└ res_err_code String 错误码错误码 └ res_err_msg String 错误信息错误信息 model DeliverOrderListResponse {} data DeliverOrderDetailResponse [] [] └ package_id String 12234567 包裹ID └ can_cancel Boolean true 是否可以取消 └ channel String WAYBILL 运力渠道 └ courier_name String 快递小哥快递员姓名 └ courier_phone String 快递电话 123456789 └ cp_code String STO 运力公司CODE └ cp_name String 申通快递运力公司NAME └ delivery_code String 1234 寄件码 └ do_code Number 123 记录ID └ fee Number 1500 总费用 fee_detail StagePriceDetail {} └ continue_price Number 1000 续重单价，单位分 └ continue_weight Number 1000 续重重量，单位克 └ start_price Number 1000 首重价格，单位分 └ start_weight Number 1000 首重重量，单位克 └ total_price Number 1000 总价格 └ total_weight Number 1000 总重量 logistics_info LogisticInfoModel [] {} └ desc String 快递已经到达文一西路969号小邮局物流详情 └ time String 13404555 时间 └ title String 配送中物流状态 └ logo String logo url 快递公司LOGO链接 └ mail_no String YTO12344232 运单号 └ order_time Number 12334555 下单时间 └ pay_status String 1 支付状态（1--待支付，2--支付成功，3--支付失败） └ pay_time Number 12344 支付时间 receiver DeliveryAddressDTO 收件人 └ city String 杭州市市 └ detail String 文一西路969号详细地址 └ district String 余杭区区 └ name String 张三姓名 └ phone String 12345 手机号码 └ province String 浙江省省 └ town String 五常街道街道 sender DeliveryAddressDTO 发货人 └ city String 杭州市市 └ detail String 文一西路969号详细地址 └ district String 余杭区区 └ name String 张三姓名 └ phone String 1234567 手机号码 └ province String 浙江省省 └ town String 五常街道街道 └ service_info String 客服信息客服信息 └ status Number 1 状态码（1--待接单，2--待揽收，3--已取消，4--待支付，6--配送中，7--已完成） └ status_name String 配送中配送状态 └ weight Number 10000 包裹重量，单位克 └ page_no Number 1 当前页码 └ page_size Number 10 当前页大小 top_banner OrderStatusDataDTO [] [] └ count Number 10 100 └ status Number 1 状态码（1--待接单，2--待揽收，3--已取消，4--待支付，6--配送中，7--已完成） └ status_desc String 2 待揽收 └ total_count Number 120 总记录数 └ success String true 请求成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
QianniuDeliveryOrderListRequest req = new QianniuDeliveryOrderListRequest();
QianniuDeliveryOrderListRequest.DeliveryOrderListTopRequest obj1 = new QianniuDeliveryOrderListRequest.DeliveryOrderListTopRequest();
obj1.setPageNo(1L);
obj1.setPageSize(10L);
obj1.setStatus(1L);
req.setParamDeliveryOrderListTopRequest(obj1);
QianniuDeliveryOrderListResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
QianniuDeliveryOrderListRequest req = new QianniuDeliveryOrderListRequest();
QianniuDeliveryOrderListRequest.DeliveryOrderListTopRequestDomain obj1 = new QianniuDeliveryOrderListRequest.DeliveryOrderListTopRequestDomain();
obj1.PageNo = 1L;
obj1.PageSize = 10L;
obj1.Status = 1L;
req.ParamDeliveryOrderListTopRequest_ = obj1;
QianniuDeliveryOrderListResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QianniuDeliveryOrderListRequest;
$param_delivery_order_list_top_request = new DeliveryOrderListTopRequest;
$param_delivery_order_list_top_request->page_no="1";
$param_delivery_order_list_top_request->page_size="10";
$param_delivery_order_list_top_request->status="1";
$req->setParamDeliveryOrderListTopRequest(json_encode($param_delivery_order_list_top_request));
$resp = $c->execute($req, $sessionKey);

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=taobao.qianniu.delivery.order.list' \
-d 'partner_id=apidoc' \
-d 'session=78a10740-ab8b-49ed-8b47-ff916419dddb' \
-d 'sign=ACA7F0FEE716D8E9672139CDE218397B' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-10-26+14%3A43%3A47' \
-d 'v=2.0' \
-d 'param_delivery_order_list_top_request=null'

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

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

req.param_delivery_order_list_top_request="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	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,"taobao.qianniu.delivery.order.list");
add_param(pRequest,"param_delivery_order_list_top_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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('taobao.qianniu.delivery.order.list', {
	'param_delivery_order_list_top_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<qianniu_delivery_order_list_response>
    <result>
        <res_err_code>错误码</res_err_code>
        <res_err_msg>错误信息</res_err_msg>
        <model>
            <data>
                <deliver_order_detail_response>
                    <package_id>12234567</package_id>
                    <can_cancel>true</can_cancel>
                    <channel>WAYBILL</channel>
                    <courier_name>快递小哥</courier_name>
                    <courier_phone>快递电话</courier_phone>
                    <cp_code>STO</cp_code>
                    <cp_name>申通快递</cp_name>
                    <delivery_code>1234</delivery_code>
                    <do_code>123</do_code>
                    <fee>1500</fee>
                    <fee_detail>
                        <continue_price>1000</continue_price>
                        <continue_weight>1000</continue_weight>
                        <start_price>1000</start_price>
                        <start_weight>1000</start_weight>
                        <total_price>1000</total_price>
                        <total_weight>1000</total_weight>
                    </fee_detail>
                    <logistics_info>
                        <logistic_info_model>
                            <desc>快递已经到达文一西路969号小邮局</desc>
                            <time>13404555</time>
                            <title>配送中</title>
                        </logistic_info_model>
                    </logistics_info>
                    <logo>logo url</logo>
                    <mail_no>YTO12344232</mail_no>
                    <order_time>12334555</order_time>
                    <pay_status>1</pay_status>
                    <pay_time>12344</pay_time>
                    <receiver>
                        <city>杭州市</city>
                        <detail>文一西路969号</detail>
                        <district>余杭区</district>
                        <name>张三</name>
                        <phone>12345</phone>
                        <province>浙江省</province>
                        <town>五常街道</town>
                    </receiver>
                    <sender>
                        <city>杭州市</city>
                        <detail>文一西路969号</detail>
                        <district>余杭区</district>
                        <name>张三</name>
                        <phone>1234567</phone>
                        <province>浙江省</province>
                        <town>五常街道</town>
                    </sender>
                    <service_info>客服信息</service_info>
                    <status>1</status>
                    <status_name>配送中</status_name>
                    <weight>10000</weight>
                </deliver_order_detail_response>
            </data>
            <page_no>1</page_no>
            <page_size>10</page_size>
            <top_banner>
                <order_status_data_d_t_o>
                    <count>10</count>
                    <status>1</status>
                    <status_desc>2</status_desc>
                </order_status_data_d_t_o>
            </top_banner>
            <total_count>120</total_count>
        </model>
        <success>true</success>
    </result>
</qianniu_delivery_order_list_response>

{
    "qianniu_delivery_order_list_response":{
        "result":{
            "res_err_code":"错误码",
            "res_err_msg":"错误信息",
            "model":{
                "data":{
                    "deliver_order_detail_response":[
                        {
                            "package_id":"12234567",
                            "can_cancel":true,
                            "channel":"WAYBILL",
                            "courier_name":"快递小哥",
                            "courier_phone":"快递电话",
                            "cp_code":"STO",
                            "cp_name":"申通快递",
                            "delivery_code":"1234",
                            "do_code":123,
                            "fee":1500,
                            "fee_detail":{
                                "continue_price":1000,
                                "continue_weight":1000,
                                "start_price":1000,
                                "start_weight":1000,
                                "total_price":1000,
                                "total_weight":1000
                            },
                            "logistics_info":{
                                "logistic_info_model":[
                                    {
                                        "desc":"快递已经到达文一西路969号小邮局",
                                        "time":"13404555",
                                        "title":"配送中"
                                    }
                                ]
                            },
                            "logo":"logo url",
                            "mail_no":"YTO12344232",
                            "order_time":12334555,
                            "pay_status":"1",
                            "pay_time":12344,
                            "receiver":{
                                "city":"杭州市",
                                "detail":"文一西路969号",
                                "district":"余杭区",
                                "name":"张三",
                                "phone":"12345",
                                "province":"浙江省",
                                "town":"五常街道"
                            },
                            "sender":{
                                "city":"杭州市",
                                "detail":"文一西路969号",
                                "district":"余杭区",
                                "name":"张三",
                                "phone":"1234567",
                                "province":"浙江省",
                                "town":"五常街道"
                            },
                            "service_info":"客服信息",
                            "status":1,
                            "status_name":"配送中",
                            "weight":10000
                        }
                    ]
                },
                "page_no":1,
                "page_size":10,
                "top_banner":{
                    "order_status_data_d_t_o":[
                        {
                            "count":10,
                            "status":1,
                            "status_desc":"2"
                        }
                    ]
                },
                "total_count":120
            },
            "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

taobao.qianniu.delivery.order.list (查询寄件的列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ