淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
query	TradeOrderQuery	可选			订单查询
└ end_time Date 可选 2018-01-26 12:00:00 查询变动结束时间 └ start_time Date 可选 2018-01-26 12:00:00 查询变动开始时间 └ biz_order_ids String [] 可选 ["1","2"] 业务订单标识 └ shop_id String 可选 1001 门店标识 └ page_index Number 可选 0 分页页码 └ page_size Number 可选 20 分页大小（不大于20） └ user_id String 可选 user-id 买家标识

名称	类型	示例值	描述
result	TradeOrderQueryResult		查询结果
└ success Boolean true 查询是否成功 └ error_code String code 错误编码 └ error_msg String message 错误信息 └ page_size Number 20 分页大小 └ page_index Number 0 分页页码 └ page_count Number 10 页码数量 └ total_count Number 123 数据数量 trade_list Tradeorders [] 订单查询结果 └ discount_fee Number 0 折扣金额 └ user_nick String nick 买家昵称 └ order_status String PAID_DONE 订单状态 └ pay_time Date 2018-01-18 18:45:40 支付时间 └ origin_fee Number 1000 原金额 └ user_mem String mem 买家留言 └ order_fulfill_status String SHIPPING 订单履约状态 deliverer OrderDeliverer 订单配送信息 └ deliverer_code String 111 配送人员编码 └ deliverer_phone String 0571 配送人员电话 └ deliverer_name String 李四配送人员姓名 └ sign_memo String 张三本人签收签收备注 └ sign_time Date 2018-01-18 18:45:40 签收时间 └ dispatch_end_time Date 2018-01-18 18:45:40 配送开始时间 └ dispatch_start_time Date 2018-01-18 18:45:40 配送结束时间 └ batch_start_time Date 2018-01-18 18:45:40 批次开始时间 └ batch_end_time Date 2018-01-18 18:45:40 批次结束时间 └ pickup_start_time Date 2018-01-18 18:45:40 拣货开始时间 └ pickup_end_time Date 2018-01-18 18:45:40 拣货结束时间 └ package_end_time Date 2018-01-18 18:45:40 打包结束时间 └ package_start_time Date 2018-01-18 18:45:40 打包开始时间 └ pay_fee Number 1000 支付金额 └ shop_id String 10112 门店编码 └ user_id String 123123 买家标识 └ biz_order_id String 222 业务订单标识 delivery OrderDelivery 收货人信息 └ delivery_start_time Date 2018-01-18 18:45:40 期望配送开始时间 └ consignee_name String 张三收货人姓名 └ delivery_end_time Date 2018-01-18 18:45:40 期望配送结束时间 └ delivery_geo String 120,30 配送坐标 └ delivery_fee Number 0 配送费金额 └ delivery_address String 杭州配送地址 └ consignee_phone String 0571 收货人电话 └ merchant_code String ISV001 商家编码 sub_orders Suborders [] 子订单 └ sale_unit String g 销售单位（非标品） └ order_fulfill_status String SHIPPING 订单履约状态 └ sale_quantity Number 1 销售数量 └ sku_name String 商品 sku名称 └ sale_price Number 100 销售单价 └ biz_order_id String 333 业务订单标识 └ order_status String PAID_DONE 订单状态 └ merchant_code String ISV001 商家编码 └ handling Boolean true 是否加工 └ sku_code String sku sku编码 └ handling_type String 切片加工方式 └ out_order_id String 111-1 外部关联订单标识 └ origin_fee Number 100 订单原价 └ sale_stock_quantity String 10.12 销售实物库存 └ stock_unit String g 实物库存单位 └ pick_sale_quantity Number 1 拣货数量 └ pick_stock_fee Number 90 拣货金额 └ pick_sale_stock_quantity String 10.00 拣货实物库存数量 └ pay_fee Number 200 子订单实际支付金额 └ discount_fee Number 100 子订单优惠金额 └ cancel_node_type String WAREHOUSE 取消时的作业节点:NO_BATCHED(合批前)，WAREHOUSE(仓)，DELIVERY_DOCK(配) └ cancel_result_code String SUCCESS 取消结果: SUCCESS-已拦截，FAILURE-未拦截，SYSTEM_ERROR-系统异常，PARAM_ERROR-参数错误，BUSINESS_ERROR-业务异常 └ out_order_id String 111 外部关联订单标识

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkTradeOrderQueryRequest req = new AlibabaWdkTradeOrderQueryRequest();
AlibabaWdkTradeOrderQueryRequest.TradeOrderQuery obj1 = new AlibabaWdkTradeOrderQueryRequest.TradeOrderQuery();
obj1.setEndTime(StringUtils.parseDateTime("2018-01-26 12:00:00"));
obj1.setStartTime(StringUtils.parseDateTime("2018-01-26 12:00:00"));
obj1.setBizOrderIds(""1","2"");
obj1.setShopId("1001");
obj1.setPageIndex(0L);
obj1.setPageSize(20L);
obj1.setUserId("user-id");
req.setQuery(obj1);
AlibabaWdkTradeOrderQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkTradeOrderQueryRequest req = new AlibabaWdkTradeOrderQueryRequest();
AlibabaWdkTradeOrderQueryRequest.TradeOrderQueryDomain obj1 = new AlibabaWdkTradeOrderQueryRequest.TradeOrderQueryDomain();
obj1.EndTime = DateTime.Parse(2018-01-26 12:00:00");
obj1.StartTime = DateTime.Parse(2018-01-26 12:00:00");
obj1.BizOrderIds = ""1","2"";
obj1.ShopId = "1001";
obj1.PageIndex = 0L;
obj1.PageSize = 20L;
obj1.UserId = "user-id";
req.Query_ = obj1;
AlibabaWdkTradeOrderQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkTradeOrderQueryRequest;
$query = new TradeOrderQuery;
$query->end_time="2018-01-26 12:00:00";
$query->start_time="2018-01-26 12:00:00";
$query->biz_order_ids="[\"1\",\"2\"]";
$query->shop_id="1001";
$query->page_index="0";
$query->page_size="20";
$query->user_id="user-id";
$req->setQuery(json_encode($query));
$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=alibaba.wdk.trade.order.query' \
-d 'partner_id=apidoc' \
-d 'session=77947536-60ce-42c0-ab71-85c47adbe8ae' \
-d 'sign=AF5ABCA448922F84AB38DA35BD710CF2' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+02%3A17%3A08' \
-d 'v=2.0' \
-d 'query=null'

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

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

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

XML示例
JSON示例

<alibaba_wdk_trade_order_query_response>
    <result>
        <success>true</success>
        <error_code>code</error_code>
        <error_msg>message</error_msg>
        <page_size>20</page_size>
        <page_index>0</page_index>
        <page_count>10</page_count>
        <total_count>123</total_count>
        <trade_list>
            <tradeorders>
                <discount_fee>0</discount_fee>
                <user_nick>nick</user_nick>
                <order_status>PAID_DONE</order_status>
                <pay_time>2018-01-18 18:45:40</pay_time>
                <origin_fee>1000</origin_fee>
                <user_mem>mem</user_mem>
                <order_fulfill_status>SHIPPING</order_fulfill_status>
                <deliverer>
                    <deliverer_code>111</deliverer_code>
                    <deliverer_phone>0571</deliverer_phone>
                    <deliverer_name>李四</deliverer_name>
                    <sign_memo>张三本人签收</sign_memo>
                    <sign_time>2018-01-18 18:45:40</sign_time>
                    <dispatch_end_time>2018-01-18 18:45:40</dispatch_end_time>
                    <dispatch_start_time>2018-01-18 18:45:40</dispatch_start_time>
                    <batch_start_time>2018-01-18 18:45:40</batch_start_time>
                    <batch_end_time>2018-01-18 18:45:40</batch_end_time>
                    <pickup_start_time>2018-01-18 18:45:40</pickup_start_time>
                    <pickup_end_time>2018-01-18 18:45:40</pickup_end_time>
                    <package_end_time>2018-01-18 18:45:40</package_end_time>
                    <package_start_time>2018-01-18 18:45:40</package_start_time>
                </deliverer>
                <pay_fee>1000</pay_fee>
                <shop_id>10112</shop_id>
                <user_id>123123</user_id>
                <biz_order_id>222</biz_order_id>
                <delivery>
                    <delivery_start_time>2018-01-18 18:45:40</delivery_start_time>
                    <consignee_name>张三</consignee_name>
                    <delivery_end_time>2018-01-18 18:45:40</delivery_end_time>
                    <delivery_geo>120,30</delivery_geo>
                    <delivery_fee>0</delivery_fee>
                    <delivery_address>杭州</delivery_address>
                    <consignee_phone>0571</consignee_phone>
                </delivery>
                <merchant_code>ISV001</merchant_code>
                <sub_orders>
                    <suborders>
                        <sale_unit>g</sale_unit>
                        <order_fulfill_status>SHIPPING</order_fulfill_status>
                        <sale_quantity>1</sale_quantity>
                        <sku_name>商品</sku_name>
                        <sale_price>100</sale_price>
                        <biz_order_id>333</biz_order_id>
                        <order_status>PAID_DONE</order_status>
                        <merchant_code>ISV001</merchant_code>
                        <handling>true</handling>
                        <sku_code>sku</sku_code>
                        <handling_type>切片</handling_type>
                        <out_order_id>111-1</out_order_id>
                        <origin_fee>100</origin_fee>
                        <sale_stock_quantity>10.12</sale_stock_quantity>
                        <stock_unit>g</stock_unit>
                        <pick_sale_quantity>1</pick_sale_quantity>
                        <pick_stock_fee>90</pick_stock_fee>
                        <pick_sale_stock_quantity>10.00</pick_sale_stock_quantity>
                        <pay_fee>200</pay_fee>
                        <discount_fee>100</discount_fee>
                        <cancel_node_type>WAREHOUSE</cancel_node_type>
                        <cancel_result_code>SUCCESS</cancel_result_code>
                    </suborders>
                </sub_orders>
                <out_order_id>111</out_order_id>
            </tradeorders>
        </trade_list>
    </result>
</alibaba_wdk_trade_order_query_response>

{
    "alibaba_wdk_trade_order_query_response":{
        "result":{
            "success":true,
            "error_code":"code",
            "error_msg":"message",
            "page_size":20,
            "page_index":0,
            "page_count":10,
            "total_count":123,
            "trade_list":{
                "tradeorders":[
                    {
                        "discount_fee":0,
                        "user_nick":"nick",
                        "order_status":"PAID_DONE",
                        "pay_time":"2018-01-18 18:45:40",
                        "origin_fee":1000,
                        "user_mem":"mem",
                        "order_fulfill_status":"SHIPPING",
                        "deliverer":{
                            "deliverer_code":"111",
                            "deliverer_phone":"0571",
                            "deliverer_name":"李四",
                            "sign_memo":"张三本人签收",
                            "sign_time":"2018-01-18 18:45:40",
                            "dispatch_end_time":"2018-01-18 18:45:40",
                            "dispatch_start_time":"2018-01-18 18:45:40",
                            "batch_start_time":"2018-01-18 18:45:40",
                            "batch_end_time":"2018-01-18 18:45:40",
                            "pickup_start_time":"2018-01-18 18:45:40",
                            "pickup_end_time":"2018-01-18 18:45:40",
                            "package_end_time":"2018-01-18 18:45:40",
                            "package_start_time":"2018-01-18 18:45:40"
                        },
                        "pay_fee":1000,
                        "shop_id":"10112",
                        "user_id":"123123",
                        "biz_order_id":"222",
                        "delivery":{
                            "delivery_start_time":"2018-01-18 18:45:40",
                            "consignee_name":"张三",
                            "delivery_end_time":"2018-01-18 18:45:40",
                            "delivery_geo":"120,30",
                            "delivery_fee":0,
                            "delivery_address":"杭州",
                            "consignee_phone":"0571"
                        },
                        "merchant_code":"ISV001",
                        "sub_orders":{
                            "suborders":[
                                {
                                    "sale_unit":"g",
                                    "order_fulfill_status":"SHIPPING",
                                    "sale_quantity":1,
                                    "sku_name":"商品",
                                    "sale_price":100,
                                    "biz_order_id":"333",
                                    "order_status":"PAID_DONE",
                                    "merchant_code":"ISV001",
                                    "handling":true,
                                    "sku_code":"sku",
                                    "handling_type":"切片",
                                    "out_order_id":"111-1",
                                    "origin_fee":100,
                                    "sale_stock_quantity":"10.12",
                                    "stock_unit":"g",
                                    "pick_sale_quantity":1,
                                    "pick_stock_fee":90,
                                    "pick_sale_stock_quantity":"10.00",
                                    "pay_fee":200,
                                    "discount_fee":100,
                                    "cancel_node_type":"WAREHOUSE",
                                    "cancel_result_code":"SUCCESS"
                                }
                            ]
                        },
                        "out_order_id":"111"
                    }
                ]
            }
        }
    }
}

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.wdk.trade.order.query (查询外部交易订单接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ