淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param0	NrTimingOrderSoldQueryReqDto	可选			入参对象
└ end_created Date 可选 2018-04-29 00:00:00 要查询的订单创建结束时间，开始时间和结束时间之间最多相隔72小时 └ start_created Date 可选 2018-05-01 00:00:00 要查询的订单创建开始时间 └ brand_seller_id Number 可选 321321321 要查询订单数据的商家的sellerID └ page_no Number 可选 1 页码 └ page_size Number 可选 20 每页大小--当前限制了20 └ biz_identity String 可选 dss 业务标识，dss标识定时送业务；jsd表示极速达业务

名称	类型	示例值	描述
result	NewRetailResult	result	result
result_data NrTimingOrderSoldQueryRespDto resultData resultData trade_order_detail_d_t_os TradeOrderDetailDto [] tradeOrderDetailDTOs 主订单列表 order_d_t_os NrOrderDto [] orderDTOs 子订单列表 └ order_id Number 3432432432 子订单号 └ title String 商品标题 title └ item_id Number 3432432 itemId └ sku_id Number 2432432 skuId └ num Number 3 数量 └ refund_status String SUCCESS 退款状态可选值WAIT_SELLER_AGREE(买家已经申请退款，等待卖家同意)，WAIT_BUYER_RETURN_GOODS(卖家已经同意退款，等待买家退货)，WAIT_SELLER_CONFIRM_GOODS(买家已经退货，等待卖家确认收货)，SELLER_REFUSE_BUYER(卖家拒绝退款)，CLOSED(退款关闭)，SUCCESS(退款成功) └ seller_nick String 张三商家昵称 └ buyer_nick String 张三买家昵称 └ create_time Date 2018-04-27 11:22:41 createTime └ outer_id_sku String 2432432 商家对应的sku的外部编码 └ pay_time String 2018-04-27 13:00:00 付款时间 └ receiver_name String 张伟收货人 └ receiver_mobile String 18611119999 手机号码 └ receiver_phone String 057188882343 电话号码 └ receiver_province String 浙江省省 └ receiver_city String 杭州市市 └ receiver_district String 余杭区区 └ receiver_town String 五常街道镇 └ receiver_address String 文一西路969 收货地址 └ appoint_start_time String 2018-04-27 11:00:00 预约开始时间 └ appoint_end_time String 2018-04-27 13:00:00 预约结束时间 └ store_code String 34232432 门店编码 └ seller_nick String 李四商家昵称 └ buyer_nick String 李四买家昵称 └ create_time String 2018-07-02 订单创建时间 └ order_id String 32432432 子订单编号 └ status String TRADE_FINISHED 可选值:TRADE_NO_CREATE_PAY(没有创建支付宝交易)，WAIT_BUYER_PAY(等待买家付款)，SELLER_CONSIGNED_PART(卖家部分发货)，WAIT_SELLER_SEND_GOODS(等待卖家发货,即:买家已付款)，WAIT_BUYER_CONFIRM_GOODS(等待买家确认收货,即:卖家已发货)，TRADE_BUYER_SIGNED(买家已签收,货到付款专用)，TRADE_FINISHED(交易成功)，TRADE_CLOSED(付款以后用户退款成功，交易自动关闭)，TRADE_CLOSED_BY_TAOBAO(付款以前，卖家或买家主动关闭交易)，PAY_PENDING(国际信用卡支付付款确认中) * WAIT_PRE_AUTH_CONFIRM(0元购合约中)，PAID_FORBID_CONSIGN(拼团中订单或者发货强管控的订单，已付款但禁止发货) └ post_fee String 12321 邮费单位分 └ page_size Number 1 页码 └ total_num Number 231 总记录数 └ page_no Number 20 每页大小 └ error_message String 查询时间取件不能超过3天 errorMessage └ error_code String INVALID_PARAMETER_START_AND_END_CREATE errorCode └ success_flag Boolean false successFlag

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallNrSoldOrderlistQueryJstRequest req = new TmallNrSoldOrderlistQueryJstRequest();
TmallNrSoldOrderlistQueryJstRequest.NrTimingOrderSoldQueryReqDto obj1 = new TmallNrSoldOrderlistQueryJstRequest.NrTimingOrderSoldQueryReqDto();
obj1.setEndCreated(StringUtils.parseDateTime("2018-04-29 00:00:00"));
obj1.setStartCreated(StringUtils.parseDateTime("2018-05-01 00:00:00"));
obj1.setBrandSellerId(321321321L);
obj1.setPageNo(1L);
obj1.setPageSize(20L);
obj1.setBizIdentity("dss");
req.setParam0(obj1);
TmallNrSoldOrderlistQueryJstResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallNrSoldOrderlistQueryJstRequest req = new TmallNrSoldOrderlistQueryJstRequest();
TmallNrSoldOrderlistQueryJstRequest.NrTimingOrderSoldQueryReqDtoDomain obj1 = new TmallNrSoldOrderlistQueryJstRequest.NrTimingOrderSoldQueryReqDtoDomain();
obj1.EndCreated = DateTime.Parse(2018-04-29 00:00:00");
obj1.StartCreated = DateTime.Parse(2018-05-01 00:00:00");
obj1.BrandSellerId = 321321321L;
obj1.PageNo = 1L;
obj1.PageSize = 20L;
obj1.BizIdentity = "dss";
req.Param0_ = obj1;
TmallNrSoldOrderlistQueryJstResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallNrSoldOrderlistQueryJstRequest;
$param0 = new NrTimingOrderSoldQueryReqDto;
$param0->end_created="2018-04-29 00:00:00";
$param0->start_created="2018-05-01 00:00:00";
$param0->brand_seller_id="321321321";
$param0->page_no="1";
$param0->page_size="20";
$param0->biz_identity="dss";
$req->setParam0(json_encode($param0));
$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=tmall.nr.sold.orderlist.query.jst' \
-d 'partner_id=apidoc' \
-d 'session=e354b8d0-170d-4f50-92ac-c3ed4ab3a7fe' \
-d 'sign=B82375C783E53DB54EE7CBF46900F917' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+20%3A47%3A58' \
-d 'v=2.0' \
-d 'param0=null'

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

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

req.param0=""
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,"tmall.nr.sold.orderlist.query.jst");
add_param(pRequest,"param0","数据结构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('tmall.nr.sold.orderlist.query.jst', {
	'param0':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_nr_sold_orderlist_query_jst_response>
    <result>
        <result_data>
            <trade_order_detail_d_t_os>
                <trade_order_detail_dto>
                    <order_d_t_os>
                        <nr_order_dto>
                            <order_id>3432432432</order_id>
                            <title>商品标题</title>
                            <item_id>3432432</item_id>
                            <sku_id>2432432</sku_id>
                            <num>3</num>
                            <refund_status>SUCCESS</refund_status>
                            <seller_nick>张三</seller_nick>
                            <buyer_nick>张三</buyer_nick>
                            <create_time>2018-04-27 11:22:41</create_time>
                            <outer_id_sku>2432432</outer_id_sku>
                        </nr_order_dto>
                    </order_d_t_os>
                    <pay_time>2018-04-27 13:00:00</pay_time>
                    <receiver_name>张伟</receiver_name>
                    <receiver_mobile>18611119999</receiver_mobile>
                    <receiver_phone>057188882343</receiver_phone>
                    <receiver_province>浙江省</receiver_province>
                    <receiver_city>杭州市</receiver_city>
                    <receiver_district>余杭区</receiver_district>
                    <receiver_town>五常街道</receiver_town>
                    <receiver_address>文一西路969</receiver_address>
                    <appoint_start_time>2018-04-27 11:00:00</appoint_start_time>
                    <appoint_end_time>2018-04-27 13:00:00</appoint_end_time>
                    <store_code>34232432</store_code>
                    <seller_nick>李四</seller_nick>
                    <buyer_nick>李四</buyer_nick>
                    <create_time>2018-07-02</create_time>
                    <order_id>32432432</order_id>
                    <status>TRADE_FINISHED</status>
                    <post_fee>12321</post_fee>
                </trade_order_detail_dto>
            </trade_order_detail_d_t_os>
            <page_size>1</page_size>
            <total_num>231</total_num>
            <page_no>20</page_no>
        </result_data>
        <error_message>查询时间取件不能超过3天</error_message>
        <error_code>INVALID_PARAMETER_START_AND_END_CREATE</error_code>
        <success_flag>false</success_flag>
    </result>
</tmall_nr_sold_orderlist_query_jst_response>

{
    "tmall_nr_sold_orderlist_query_jst_response":{
        "result":{
            "result_data":{
                "trade_order_detail_d_t_os":{
                    "trade_order_detail_dto":[
                        {
                            "order_d_t_os":{
                                "nr_order_dto":[
                                    {
                                        "order_id":3432432432,
                                        "title":"商品标题",
                                        "item_id":3432432,
                                        "sku_id":2432432,
                                        "num":3,
                                        "refund_status":"SUCCESS",
                                        "seller_nick":"张三",
                                        "buyer_nick":"张三",
                                        "create_time":"2018-04-27 11:22:41",
                                        "outer_id_sku":"2432432"
                                    }
                                ]
                            },
                            "pay_time":"2018-04-27 13:00:00",
                            "receiver_name":"张伟",
                            "receiver_mobile":"18611119999",
                            "receiver_phone":"057188882343",
                            "receiver_province":"浙江省",
                            "receiver_city":"杭州市",
                            "receiver_district":"余杭区",
                            "receiver_town":"五常街道",
                            "receiver_address":"文一西路969",
                            "appoint_start_time":"2018-04-27 11:00:00",
                            "appoint_end_time":"2018-04-27 13:00:00",
                            "store_code":"34232432",
                            "seller_nick":"李四",
                            "buyer_nick":"李四",
                            "create_time":"2018-07-02",
                            "order_id":"32432432",
                            "status":"TRADE_FINISHED",
                            "post_fee":"12321"
                        }
                    ]
                },
                "page_size":1,
                "total_num":231,
                "page_no":20
            },
            "error_message":"查询时间取件不能超过3天",
            "error_code":"INVALID_PARAMETER_START_AND_END_CREATE",
            "success_flag":false
        }
    }
}

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下载

开放平台

天猫新零售

tmall.nr.sold.orderlist.query.jst (已入塔商家查询订单列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ