淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
supplier_order_query_request	SupplierOrderQueryRequest	可选			查询参数
└ order_from Number 可选 4 订单来源，4：盒马，3：饿了么 └ store_id String 可选 9871 经营店id └ source_merchant_code String 可选 HM 实际售卖商家code └ end_time Date 可选 2017-08-09 00:00:00 结束时间 └ start_time Date 可选 2017-08-08 00:00:00 开始时间 └ page_index Number 可选 0 分页页码，从0开始 └ page_size Number 可选 200 分页大小，默认200 └ order_client String 可选 APP 下单终端: APP 、POS └ order_status String [] 可选 SUCCESS 订单状态: PAID / PACAKAGED / SUCCESS └ shop_id String 可选 1234 渠道店id

名称	类型	示例值	描述
result	OrderListSyncPagedResult		result
└ next_index Number 1 返回下一查询页的序号。如果返回值是-1，则无下一页。数据拉取完成。 └ return_code String HM02008888888001 returnCode └ return_msg String 成功 returnMsg └ total_number String 100 订单总数量 orders OrderSyncDto [] 订单列表 └ open_uid String afadfdfd 买家id对应的open_uid，加密过 └ trade_attributes String {"point":"2"} 扩展map └ duty_code String 123 班次号 └ gift_coupon String 1123424_1000 赠券，格式为券ID_券金额，金额单位为分 └ package_time Date 2017-08-18 00:00:00 打包时间 └ member_point String 1 会员积分 └ order_status String PAID 订单状态 └ merchant_code String HM 商家code └ operator_name String 123 收银员名称 └ tb_biz_order_id Number 12132 淘宝订单号 └ operator_id String 1212 收银员id └ member_card_num String 123 会员卡号 └ member_discount_amt Number 12 会员优惠金额，单位分 └ store_id String 123 经营店id └ post_fee Number 12 邮费 └ pay_time Date 2017-08-18 00:00:00 支付时间 └ original_amt Number 1234 商品总原价 └ discount_amt Number 321 总优惠金额 └ biz_order_id Number 1234 盒马订单号 └ out_order_id String 13132 外部订单号 └ shop_id String 123 渠道店id └ source_merchant_code String HM 实际售卖商家code └ order_from Number 4 订单渠道，4：盒马，3：饿了么 └ order_client String APP 下单终端: APP,POS sub_orders SubOrderSyncDto [] subOrders └ out_sku_code String 21323 外部SkuCode └ sku_code String 121 skuCode └ trade_sub_attributes String {"point":"2"} 扩展属性map └ stock_unit String kg 库存单位 └ sale_unit String g 售卖单位 └ biz_order_id Number 1212 盒马订单号 └ tb_biz_order_id Number 21213 淘宝订单号 └ out_order_id String 13131 外部订单号 └ pick_amount_stock String 2 库存单位拣货数量 └ pick_amt Number 24 拣货金额，单位分 └ buy_amount_stock String 2 库存单位购买数量 └ order_type String COMMON 订单类型 COMMON，GIFT └ txd_pmt_amt Number 0 淘鲜达分摊金额 └ order_status String SHIPPED 子订单状态 └ status_change_time String {"SHIPPED":"2017-08-18 00:00:00"} 履约各状态时间 └ price Number 12 单价 └ original_amt Number 24 原价=单价*库存单位购买数量 └ promotion_discount_amt Number 0 优惠金额 └ member_discount_amt Number 0 会员优惠金额 └ promotion_info String [{\"activeId\":\"6653556217\",\"activeName\":\"\",\"discountFee\":178,\"outActiveId\":\"\",\"txdActiveId\":\"6653556217\",\"type\":\"shopbonus\",\"voucherId\":\"567445601000\"}] 优惠来源明细，json格式的字符串，是个数组，可能包含多个优惠来源 pay_channels PayChannel [] payChannels └ pay_type Number 1 payType └ pay_amount Number 10 payAmount └ actual_pay_amount Number 10 actualPayAmount └ pay_attributes String {\"tno\":\"123\",\"tsn\":\"123\"} payAttributes └ success Boolean true success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkSupplierOrderListRequest req = new AlibabaWdkSupplierOrderListRequest();
AlibabaWdkSupplierOrderListRequest.SupplierOrderQueryRequest obj1 = new AlibabaWdkSupplierOrderListRequest.SupplierOrderQueryRequest();
obj1.setOrderFrom(4L);
obj1.setStoreId("9871");
obj1.setSourceMerchantCode("HM");
obj1.setEndTime(StringUtils.parseDateTime("2017-08-09 00:00:00"));
obj1.setStartTime(StringUtils.parseDateTime("2017-08-08 00:00:00"));
obj1.setPageIndex(0L);
obj1.setPageSize(200L);
obj1.setOrderClient("APP");
obj1.setOrderStatus("SUCCESS");
obj1.setShopId("1234");
req.setSupplierOrderQueryRequest(obj1);
AlibabaWdkSupplierOrderListResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkSupplierOrderListRequest req = new AlibabaWdkSupplierOrderListRequest();
AlibabaWdkSupplierOrderListRequest.SupplierOrderQueryRequestDomain obj1 = new AlibabaWdkSupplierOrderListRequest.SupplierOrderQueryRequestDomain();
obj1.OrderFrom = 4L;
obj1.StoreId = "9871";
obj1.SourceMerchantCode = "HM";
obj1.EndTime = DateTime.Parse(2017-08-09 00:00:00");
obj1.StartTime = DateTime.Parse(2017-08-08 00:00:00");
obj1.PageIndex = 0L;
obj1.PageSize = 200L;
obj1.OrderClient = "APP";
obj1.OrderStatus = "SUCCESS";
obj1.ShopId = "1234";
req.SupplierOrderQueryRequest_ = obj1;
AlibabaWdkSupplierOrderListResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkSupplierOrderListRequest;
$supplier_order_query_request = new SupplierOrderQueryRequest;
$supplier_order_query_request->order_from="4";
$supplier_order_query_request->store_id="9871";
$supplier_order_query_request->source_merchant_code="HM";
$supplier_order_query_request->end_time="2017-08-09 00:00:00";
$supplier_order_query_request->start_time="2017-08-08 00:00:00";
$supplier_order_query_request->page_index="0";
$supplier_order_query_request->page_size="200";
$supplier_order_query_request->order_client="APP";
$supplier_order_query_request->order_status="SUCCESS";
$supplier_order_query_request->shop_id="1234";
$req->setSupplierOrderQueryRequest(json_encode($supplier_order_query_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=alibaba.wdk.supplier.order.list' \
-d 'partner_id=apidoc' \
-d 'session=b8484c01-2b2f-4a97-9c73-2b6e16de56b0' \
-d 'sign=7B89FB79A1E5CDA8A3F770ECD579054D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A24%3A18' \
-d 'v=2.0' \
-d 'supplier_order_query_request=null'

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

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

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

XML示例
JSON示例

<alibaba_wdk_supplier_order_list_response>
    <result>
        <next_index>1</next_index>
        <return_code>HM02008888888001</return_code>
        <return_msg>成功</return_msg>
        <total_number>100</total_number>
        <orders>
            <order_sync_dto>
                <open_uid>afadfdfd</open_uid>
                <trade_attributes>{&quot;point&quot;:&quot;2&quot;}</trade_attributes>
                <duty_code>123</duty_code>
                <gift_coupon>1123424_1000</gift_coupon>
                <package_time>2017-08-18 00:00:00</package_time>
                <member_point>1</member_point>
                <order_status>PAID</order_status>
                <merchant_code>HM</merchant_code>
                <operator_name>123</operator_name>
                <tb_biz_order_id>12132</tb_biz_order_id>
                <operator_id>1212</operator_id>
                <member_card_num>123</member_card_num>
                <member_discount_amt>12</member_discount_amt>
                <store_id>123</store_id>
                <post_fee>12</post_fee>
                <pay_time>2017-08-18 00:00:00</pay_time>
                <original_amt>1234</original_amt>
                <discount_amt>321</discount_amt>
                <biz_order_id>1234</biz_order_id>
                <out_order_id>13132</out_order_id>
                <shop_id>123</shop_id>
                <source_merchant_code>HM</source_merchant_code>
                <order_from>4</order_from>
                <order_client>APP</order_client>
                <sub_orders>
                    <sub_order_sync_dto>
                        <out_sku_code>21323</out_sku_code>
                        <sku_code>121</sku_code>
                        <trade_sub_attributes>{&quot;point&quot;:&quot;2&quot;}</trade_sub_attributes>
                        <stock_unit>kg</stock_unit>
                        <sale_unit>g</sale_unit>
                        <biz_order_id>1212</biz_order_id>
                        <tb_biz_order_id>21213</tb_biz_order_id>
                        <out_order_id>13131</out_order_id>
                        <pick_amount_stock>2</pick_amount_stock>
                        <pick_amt>24</pick_amt>
                        <buy_amount_stock>2</buy_amount_stock>
                        <order_type>COMMON</order_type>
                        <txd_pmt_amt>0</txd_pmt_amt>
                        <order_status>SHIPPED</order_status>
                        <status_change_time>{&quot;SHIPPED&quot;:&quot;2017-08-18 00:00:00&quot;}</status_change_time>
                        <price>12</price>
                        <original_amt>24</original_amt>
                        <promotion_discount_amt>0</promotion_discount_amt>
                        <member_discount_amt>0</member_discount_amt>
                        <promotion_info>[{\&quot;activeId\&quot;:\&quot;6653556217\&quot;,\&quot;activeName\&quot;:\&quot;\&quot;,\&quot;discountFee\&quot;:178,\&quot;outActiveId\&quot;:\&quot;\&quot;,\&quot;txdActiveId\&quot;:\&quot;6653556217\&quot;,\&quot;type\&quot;:\&quot;shopbonus\&quot;,\&quot;voucherId\&quot;:\&quot;567445601000\&quot;}]</promotion_info>
                    </sub_order_sync_dto>
                </sub_orders>
                <pay_channels>
                    <pay_channel>
                        <pay_type>1</pay_type>
                        <pay_amount>10</pay_amount>
                        <actual_pay_amount>10</actual_pay_amount>
                        <pay_attributes>{\&quot;tno\&quot;:\&quot;123\&quot;,\&quot;tsn\&quot;:\&quot;123\&quot;}</pay_attributes>
                    </pay_channel>
                </pay_channels>
            </order_sync_dto>
        </orders>
        <success>true</success>
    </result>
</alibaba_wdk_supplier_order_list_response>

{
    "alibaba_wdk_supplier_order_list_response":{
        "result":{
            "next_index":1,
            "return_code":"HM02008888888001",
            "return_msg":"成功",
            "total_number":"100",
            "orders":{
                "order_sync_dto":[
                    {
                        "open_uid":"afadfdfd",
                        "trade_attributes":"{\"point\":\"2\"}",
                        "duty_code":"123",
                        "gift_coupon":"1123424_1000",
                        "package_time":"2017-08-18 00:00:00",
                        "member_point":"1",
                        "order_status":"PAID",
                        "merchant_code":"HM",
                        "operator_name":"123",
                        "tb_biz_order_id":12132,
                        "operator_id":"1212",
                        "member_card_num":"123",
                        "member_discount_amt":12,
                        "store_id":"123",
                        "post_fee":12,
                        "pay_time":"2017-08-18 00:00:00",
                        "original_amt":1234,
                        "discount_amt":321,
                        "biz_order_id":1234,
                        "out_order_id":"13132",
                        "shop_id":"123",
                        "source_merchant_code":"HM",
                        "order_from":4,
                        "order_client":"APP",
                        "sub_orders":{
                            "sub_order_sync_dto":[
                                {
                                    "out_sku_code":"21323",
                                    "sku_code":"121",
                                    "trade_sub_attributes":"{\"point\":\"2\"}",
                                    "stock_unit":"kg",
                                    "sale_unit":"g",
                                    "biz_order_id":1212,
                                    "tb_biz_order_id":21213,
                                    "out_order_id":"13131",
                                    "pick_amount_stock":"2",
                                    "pick_amt":24,
                                    "buy_amount_stock":"2",
                                    "order_type":"COMMON",
                                    "txd_pmt_amt":0,
                                    "order_status":"SHIPPED",
                                    "status_change_time":"{\"SHIPPED\":\"2017-08-18 00:00:00\"}",
                                    "price":12,
                                    "original_amt":24,
                                    "promotion_discount_amt":0,
                                    "member_discount_amt":0,
                                    "promotion_info":"[{\\\"activeId\\\":\\\"6653556217\\\",\\\"activeName\\\":\\\"\\\",\\\"discountFee\\\":178,\\\"outActiveId\\\":\\\"\\\",\\\"txdActiveId\\\":\\\"6653556217\\\",\\\"type\\\":\\\"shopbonus\\\",\\\"voucherId\\\":\\\"567445601000\\\"}]"
                                }
                            ]
                        },
                        "pay_channels":{
                            "pay_channel":[
                                {
                                    "pay_type":1,
                                    "pay_amount":10,
                                    "actual_pay_amount":10,
                                    "pay_attributes":"{\\\"tno\\\":\\\"123\\\",\\\"tsn\\\":\\\"123\\\"}"
                                }
                            ]
                        }
                    }
                ]
            },
            "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

alibaba.wdk.supplier.order.list (五道口供应商维度正向订单拉取)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ