淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
start_date	Date	必须	2017-10-31 00:00:00	开始时间
end_date	Date	必须	2017-10-31 23:00:00	结束时间
page_no	Number	必须	1	页码
page_size	Number	必须	10	分页大小
store_id	String	必须	100004	零售门店在零售+平台对应的ID

名称	类型	示例值	描述
total	Number	89	查询命中数量
order_list	Order []		订单列表
goods_list Goods [] 商品列表 └ quantity Number 1 商品数量 └ guider String 89757 导购员编号 └ currency String CNY 币种 └ price Number 100 商品价格，人民币分 └ id String 1000040000000001234542 零售+商品ID └ item_id Number 34543645645 商品itemId └ sku_id Number 23423423 商品skuId └ sales_name String 范蠡收银员姓名 └ trade_status String WAIT_PAY 交易状态:WAIT_PAY：等待支付；SUCCESS：支付成功；CLOSED：交易关闭 └ gmt_pay String 2017-11-01 12:00:00 支付时间 └ actual_pay_amount Number 2000 实付金额，人民币分 └ total_amount Number 3000 订单金额，人民币分 └ gmt_create String 2017-11-01 12:00:00 下单时间 └ store_name String 花果山公仔门店名称 └ store_id Number 100004 门店ID └ trade_no String 20171101000002323423 零售+订单号 └ pay_channel String ALIPAY 支付渠道 └ refunded_amount Number 1000 已退金额，人民币分 └ refund_status String REFUNDED 退款状态：REFUNDED_PART：已部分退款；REFUNDED：已全部退款 refunded_goods Goods [] 发生退货的商品列表 └ sku_id Number 23423423 商品skuId └ item_id Number 34543645645 商品itemId └ id String 1000040000000001234542 零售+商品ID └ price Number 100 商品价格，人民币分 └ currency String CNY 币种 └ guider String 89757 导购员编号 └ quantity Number 1 商品数量 └ sales_id String LT0001 收银员ID └ trade_biz_type Number 1 0：门店订单；1：全渠道订单；3：网直供订单 └ omni_trade_no String 65774355345 如果是全渠道订单，此处为淘宝订单号 └ out_trade_no String 5465476 外部订单号即业务方订单号

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaNlifeB2cTradeDownloadRequest req = new AlibabaNlifeB2cTradeDownloadRequest();
req.setStartDate(StringUtils.parseDateTime("2017-10-31 00:00:00"));
req.setEndDate(StringUtils.parseDateTime("2017-10-31 23:00:00"));
req.setPageNo(1L);
req.setPageSize(10L);
req.setStoreId("100004");
AlibabaNlifeB2cTradeDownloadResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaNlifeB2cTradeDownloadRequest req = new AlibabaNlifeB2cTradeDownloadRequest();
req.StartDate = DateTime.Parse("2017-10-31 00:00:00");
req.EndDate = DateTime.Parse("2017-10-31 23:00:00");
req.PageNo = 1L;
req.PageSize = 10L;
req.StoreId = "100004";
AlibabaNlifeB2cTradeDownloadResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaNlifeB2cTradeDownloadRequest;
$req->setStartDate("2017-10-31 00:00:00");
$req->setEndDate("2017-10-31 23:00:00");
$req->setPageNo("1");
$req->setPageSize("10");
$req->setStoreId("100004");
$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.nlife.b2c.trade.download' \
-d 'partner_id=apidoc' \
-d 'session=6bc24763-263a-4839-bdf3-8962b9ee4ed0' \
-d 'sign=6589FE454A8D2A787A5E500E28F92E5C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+15%3A37%3A50' \
-d 'v=2.0' \
-d 'end_date=2017-10-31+23%3A00%3A00' \
-d 'page_no=1' \
-d 'page_size=10' \
-d 'start_date=2017-10-31+00%3A00%3A00' \
-d 'store_id=100004'

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

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

req.start_date="2017-10-31 00:00:00"
req.end_date="2017-10-31 23:00:00"
req.page_no=1
req.page_size=10
req.store_id="100004"
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.nlife.b2c.trade.download");
add_param(pRequest,"start_date","2017-10-31 00:00:00");
add_param(pRequest,"end_date","2017-10-31 23:00:00");
add_param(pRequest,"page_no","1");
add_param(pRequest,"page_size","10");
add_param(pRequest,"store_id","100004");
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.nlife.b2c.trade.download', {
	'start_date':'2017-10-31 00:00:00',
	'end_date':'2017-10-31 23:00:00',
	'page_no':'1',
	'page_size':'10',
	'store_id':'100004'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_nlife_b2c_trade_download_response>
    <total>89</total>
    <order_list>
        <order>
            <goods_list>
                <goods>
                    <quantity>1</quantity>
                    <guider>89757</guider>
                    <currency>CNY</currency>
                    <price>100</price>
                    <id>1000040000000001234542</id>
                    <item_id>34543645645</item_id>
                    <sku_id>23423423</sku_id>
                </goods>
            </goods_list>
            <sales_name>范蠡</sales_name>
            <trade_status>WAIT_PAY</trade_status>
            <gmt_pay>2017-11-01 12:00:00</gmt_pay>
            <actual_pay_amount>2000</actual_pay_amount>
            <total_amount>3000</total_amount>
            <gmt_create>2017-11-01 12:00:00</gmt_create>
            <store_name>花果山公仔</store_name>
            <store_id>100004</store_id>
            <trade_no>20171101000002323423</trade_no>
            <pay_channel>ALIPAY</pay_channel>
            <refunded_amount>1000</refunded_amount>
            <refund_status>REFUNDED</refund_status>
            <refunded_goods>
                <goods>
                    <sku_id>23423423</sku_id>
                    <item_id>34543645645</item_id>
                    <id>1000040000000001234542</id>
                    <price>100</price>
                    <currency>CNY</currency>
                    <guider>89757</guider>
                    <quantity>1</quantity>
                </goods>
            </refunded_goods>
            <sales_id>LT0001</sales_id>
            <trade_biz_type>1</trade_biz_type>
            <omni_trade_no>65774355345</omni_trade_no>
            <out_trade_no>5465476</out_trade_no>
        </order>
    </order_list>
</alibaba_nlife_b2c_trade_download_response>

{
    "alibaba_nlife_b2c_trade_download_response":{
        "total":89,
        "order_list":{
            "order":[
                {
                    "goods_list":{
                        "goods":[
                            {
                                "quantity":1,
                                "guider":"89757",
                                "currency":"CNY",
                                "price":100,
                                "id":"1000040000000001234542",
                                "item_id":34543645645,
                                "sku_id":23423423
                            }
                        ]
                    },
                    "sales_name":"范蠡",
                    "trade_status":"WAIT_PAY",
                    "gmt_pay":"2017-11-01 12:00:00",
                    "actual_pay_amount":2000,
                    "total_amount":3000,
                    "gmt_create":"2017-11-01 12:00:00",
                    "store_name":"花果山公仔",
                    "store_id":100004,
                    "trade_no":"20171101000002323423",
                    "pay_channel":"ALIPAY",
                    "refunded_amount":1000,
                    "refund_status":"REFUNDED",
                    "refunded_goods":{
                        "goods":[
                            {
                                "sku_id":23423423,
                                "item_id":34543645645,
                                "id":"1000040000000001234542",
                                "price":100,
                                "currency":"CNY",
                                "guider":"89757",
                                "quantity":1
                            }
                        ]
                    },
                    "sales_id":"LT0001",
                    "trade_biz_type":1,
                    "omni_trade_no":"65774355345",
                    "out_trade_no":"5465476"
                }
            ]
        }
    }
}

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

开放平台

零售plus

alibaba.nlife.b2c.trade.download (b2c下载订单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ