淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
page_size	Number	可选	20	默认值：20	每页多少条
page_no	Number	可选	1	默认值：1	分页的第几页
order_status	Number	可选	11		TMS拒签：-100 接收方拒签：-200
order_code	String	可选	LBX0011922059003		物流订单编号
end_time	Date	可选	2013-11-02 21:22:57		查询截止时间
start_time	Date	可选	2011-11-02 21:22:57		查询开始时间
order_type	String	可选	NORMAL_OUT		订单类型: （1）NORMAL_OUT ：正常出库（2）NORMAL_IN：正常入库（3）RETURN_IN：退货入库（4）EXCHANGE_OUT：换货出库
order_sub_type	String	可选	TAOBAO_TRADE		订单子类型：（1）OTHER：其他（2）TAOBAO_TRADE：淘宝交易（3）OTHER_TRADE：其他交易（4）ALLCOATE：调拨（5）CHECK: 盘点单（6）PURCHASE: 采购单

名称	类型	示例值	描述
order_list	WlbOrder []		物流宝订单对象
└ operate_type String IN 出库或者入库，IN表示入库，OUT表示出库 └ order_code String LP12312312 订单编码 └ order_source String TAOBAO 订单来源: 产生物流订单的原因，比如: 订单来源:1:TAOBAO;2:EXT;3:ERP;4:WMS └ order_source_code String 43112312312 对应创建物流宝订单top接口中的的out_biz_code字段，主要是用来去重用 └ order_type String NORMAL 1:正常订单: NORMAL 2:退货订单: RETURN 3:换货订单: CHANGE └ order_sub_type String TAOBAO (1)其它: OTHER (2)淘宝交易: TAOBAO (3)301:调拨: ALLOCATION (4)401:盘点:CHECK (5)501:销售采购:PRUCHASE └ total_amount Number 100 订单总价 └ user_nick String eyyatta 卖家NICK └ store_code String BEST-0001 仓库编码 └ tms_tp_code String STO 发货物流公司编码，STO,YTO,EMS等 └ order_status String 0 物流状态，订单已创建：0 订单已取消: -1 订单关闭:-3 下发中: 10 已下发: 11 TMS拒签 :-100 接收方拒签：-200 已发货:100 签收成功:200 └ order_status_reason String 卖家取消卖家取消,仓库取消标识 └ remark String 备注订单备注 └ prev_order_code String LP0123123 原订单编码 └ is_completed Boolean 1 1 └ buyer_nick String littlecat 买家nick └ receiver_name String 张三接收人姓名 └ receiver_wangwang String little_cat 接收人旺旺 └ receiver_mail String 1 1 └ receiver_zip_code String 310016 收件人邮编 └ receiver_mobile String 13562548935 接收人手机号码 └ receiver_phone String 88155189 接收人固定电话 └ invoice_info String 抬头:**有限公司发票信息 └ order_flag Number 3 第1位:COD,2:限时配送,3:预售,4:需要发票,5:已投诉,第6位:合单,第7位:拆单第8位：EXCHANGE-换货，第9位:VISIT-上门，第10位: MODIFYTRANSPORT-是否可改配送方式，第11位：是否物流代理确认发货 └ receivable_amount Number 10000 应收金额 └ receiver_province String 浙江省收件人省份 └ receiver_city String 绍兴市收件人城市 └ receiver_area String 越城区区或者县 └ receiver_address String 跃升公寓2幢2单元504 收件人具体地址 └ service_fee Number 300 cod服务费 └ cancel_order_status Number 1 订单取消状态： 1-取消中； 2-取消失败； 3-取消完成 └ sender_province String 浙江省发件人所在省份 └ sender_city String 杭州发件人城市 └ sender_area String 西湖区发件人所在区 └ sender_address String 浙江省杭州市西湖区发件人地址 └ sender_name String 小a 发件人姓名 └ sender_email String aa@taobao.com 发件人电子邮箱 └ sender_phone String 0571-88155188 发件人联系电话 └ sender_mobile String 13569856256 发件人移动电话 └ sender_zip_code String 310023 发件人邮编 └ schedule_day String 12:40 配送开始时间通常是HH:MM格式 └ schedule_end String 17:40 配送结束时间通常是HH:MM格式 └ expect_start_time Date 2000-01-01 00:00:00 计划送达开始时间 └ expect_end_time Date 2000-01-01 00:00:00 计划送达结束时间 └ schedule_speed Number 101 发货速度， 101-当日达， 102-次晨达， 103-次日达 └ user_id Number 321123 卖家ID
total_count	Number	500	总条数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
WlbOrderPageGetRequest req = new WlbOrderPageGetRequest();
req.setPageSize(20L);
req.setPageNo(1L);
req.setOrderStatus(11L);
req.setOrderCode("LBX0011922059003");
req.setEndTime(StringUtils.parseDateTime("2013-11-02 21:22:57"));
req.setStartTime(StringUtils.parseDateTime("2011-11-02 21:22:57"));
req.setOrderType("NORMAL_OUT");
req.setOrderSubType("TAOBAO_TRADE");
WlbOrderPageGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
WlbOrderPageGetRequest req = new WlbOrderPageGetRequest();
req.PageSize = 20L;
req.PageNo = 1L;
req.OrderStatus = 11L;
req.OrderCode = "LBX0011922059003";
req.EndTime = DateTime.Parse("2013-11-02 21:22:57");
req.StartTime = DateTime.Parse("2011-11-02 21:22:57");
req.OrderType = "NORMAL_OUT";
req.OrderSubType = "TAOBAO_TRADE";
WlbOrderPageGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new WlbOrderPageGetRequest;
$req->setPageSize("20");
$req->setPageNo("1");
$req->setOrderStatus("11");
$req->setOrderCode("LBX0011922059003");
$req->setEndTime("2013-11-02 21:22:57");
$req->setStartTime("2011-11-02 21:22:57");
$req->setOrderType("NORMAL_OUT");
$req->setOrderSubType("TAOBAO_TRADE");
$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.wlb.order.page.get' \
-d 'partner_id=apidoc' \
-d 'session=ea55ef18-1ee9-4d94-813b-56f78f15f0f2' \
-d 'sign=25CD35967005AE053EE8E3E0A09EC0E5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+18%3A29%3A39' \
-d 'v=2.0' \
-d 'end_time=2013-11-02+21%3A22%3A57' \
-d 'order_code=LBX0011922059003' \
-d 'order_status=11' \
-d 'order_sub_type=TAOBAO_TRADE' \
-d 'order_type=NORMAL_OUT' \
-d 'page_no=1' \
-d 'page_size=20' \
-d 'start_time=2011-11-02+21%3A22%3A57'

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

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

req.page_size=20
req.page_no=1
req.order_status=11
req.order_code="LBX0011922059003"
req.end_time="2013-11-02 21:22:57"
req.start_time="2011-11-02 21:22:57"
req.order_type="NORMAL_OUT"
req.order_sub_type="TAOBAO_TRADE"
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.wlb.order.page.get");
add_param(pRequest,"page_size","20");
add_param(pRequest,"page_no","1");
add_param(pRequest,"order_status","11");
add_param(pRequest,"order_code","LBX0011922059003");
add_param(pRequest,"end_time","2013-11-02 21:22:57");
add_param(pRequest,"start_time","2011-11-02 21:22:57");
add_param(pRequest,"order_type","NORMAL_OUT");
add_param(pRequest,"order_sub_type","TAOBAO_TRADE");
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.wlb.order.page.get', {
	'page_size':'20',
	'page_no':'1',
	'order_status':'11',
	'order_code':'LBX0011922059003',
	'end_time':'2013-11-02 21:22:57',
	'start_time':'2011-11-02 21:22:57',
	'order_type':'NORMAL_OUT',
	'order_sub_type':'TAOBAO_TRADE'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<wlb_order_page_get_response>
    <order_list>
        <wlb_order>
            <operate_type>IN</operate_type>
            <order_code>LP12312312</order_code>
            <order_source>TAOBAO</order_source>
            <order_source_code>43112312312</order_source_code>
            <order_type>NORMAL</order_type>
            <order_sub_type>TAOBAO</order_sub_type>
            <total_amount>100</total_amount>
            <user_nick>eyyatta</user_nick>
            <store_code>BEST-0001</store_code>
            <tms_tp_code>STO</tms_tp_code>
            <order_status>0</order_status>
            <order_status_reason>卖家取消</order_status_reason>
            <remark>备注</remark>
            <prev_order_code>LP0123123</prev_order_code>
            <is_completed>1</is_completed>
            <buyer_nick>littlecat</buyer_nick>
            <receiver_name>张三</receiver_name>
            <receiver_wangwang>little_cat</receiver_wangwang>
            <receiver_mail>1</receiver_mail>
            <receiver_zip_code>310016</receiver_zip_code>
            <receiver_mobile>13562548935</receiver_mobile>
            <receiver_phone>88155189</receiver_phone>
            <invoice_info>抬头:**有限公司</invoice_info>
            <order_flag>3</order_flag>
            <receivable_amount>10000</receivable_amount>
            <receiver_province>浙江省</receiver_province>
            <receiver_city>绍兴市</receiver_city>
            <receiver_area>越城区</receiver_area>
            <receiver_address>跃升公寓2幢2单元504</receiver_address>
            <service_fee>300</service_fee>
            <cancel_order_status>1</cancel_order_status>
            <sender_province>浙江省</sender_province>
            <sender_city>杭州</sender_city>
            <sender_area>西湖区</sender_area>
            <sender_address>浙江省杭州市西湖区</sender_address>
            <sender_name>小a</sender_name>
            <sender_email>aa@taobao.com</sender_email>
            <sender_phone>0571-88155188</sender_phone>
            <sender_mobile>13569856256</sender_mobile>
            <sender_zip_code>310023</sender_zip_code>
            <schedule_day>12:40</schedule_day>
            <schedule_end>17:40</schedule_end>
            <expect_start_time>2000-01-01 00:00:00</expect_start_time>
            <expect_end_time>2000-01-01 00:00:00</expect_end_time>
            <schedule_speed>101</schedule_speed>
            <user_id>321123</user_id>
        </wlb_order>
    </order_list>
    <total_count>500</total_count>
</wlb_order_page_get_response>

{
    "wlb_order_page_get_response":{
        "order_list":{
            "wlb_order":[
                {
                    "operate_type":"IN",
                    "order_code":"LP12312312",
                    "order_source":"TAOBAO",
                    "order_source_code":"43112312312",
                    "order_type":"NORMAL",
                    "order_sub_type":"TAOBAO",
                    "total_amount":100,
                    "user_nick":"eyyatta",
                    "store_code":"BEST-0001",
                    "tms_tp_code":"STO",
                    "order_status":"0",
                    "order_status_reason":"卖家取消",
                    "remark":"备注",
                    "prev_order_code":"LP0123123",
                    "is_completed":1,
                    "buyer_nick":"littlecat",
                    "receiver_name":"张三",
                    "receiver_wangwang":"little_cat",
                    "receiver_mail":"1",
                    "receiver_zip_code":"310016",
                    "receiver_mobile":"13562548935",
                    "receiver_phone":"88155189",
                    "invoice_info":"抬头:**有限公司",
                    "order_flag":3,
                    "receivable_amount":10000,
                    "receiver_province":"浙江省",
                    "receiver_city":"绍兴市",
                    "receiver_area":"越城区",
                    "receiver_address":"跃升公寓2幢2单元504",
                    "service_fee":300,
                    "cancel_order_status":1,
                    "sender_province":"浙江省",
                    "sender_city":"杭州",
                    "sender_area":"西湖区",
                    "sender_address":"浙江省杭州市西湖区",
                    "sender_name":"小a",
                    "sender_email":"aa@taobao.com",
                    "sender_phone":"0571-88155188",
                    "sender_mobile":"13569856256",
                    "sender_zip_code":"310023",
                    "schedule_day":"12:40",
                    "schedule_end":"17:40",
                    "expect_start_time":"2000-01-01 00:00:00",
                    "expect_end_time":"2000-01-01 00:00:00",
                    "schedule_speed":101,
                    "user_id":321123
                }
            ]
        },
        "total_count":500
    }
}

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.wlb.order.page.get (分页查询物流宝订单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ