淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
trade_no	String	可选	100004000000000045678	最大长度：64	零售+平台订单号,和out_trade_no不能同时为空
out_trade_no	String	可选	OT9043289567834	最大长度：64	外部订单号，和trade_no不能同时为空
store_id	String	可选	100004		零售+门店ID，如果传递的是outTradeNola，那么这个是必传的

名称	类型	示例值	描述
channel	String	POS	订单创建渠道， API("经由零售+平台API创建"), POS("经由零售+平台收银系统创建"), TAOBAO("经由淘宝/天猫创建");
channel_data	String	{"k1":v1}	渠道数据，JSON
buyer_id	String	53456436	买家ID
buyer_id_type	String	ALIPAY_OPENID	买家类型： TAOBAO_OPENID("经阿里百川淘宝登陆获取到的用户ID"), ALIPAY_OPENID("经蚂蚁金服开放平台支付宝App登陆获得的用户ID"), WECHAT_OPENID("经微信开放平台微信App登陆获得的用户id"), PHONE_NUMBER("通过手机号码登陆"), APP_USERID("商户自由的用户ID"), ANONYMOUS_USER("匿名用户");
out_card_no	String	543765476	商户自有的会员卡号
order_body	String	如意金箍棒	订单描述
sales_id	String	dg001	导购员ID
goods_list	Goods []	goodsList	购买的商品列表
└ id String 53465467 商品ID └ price Number 6000 商品价格，基础单位，比如人民币分 └ currency String CYN 货币种类： CYN("人民币"), USD("美元"), HKD("港币"); └ guider String 9527 导购员 └ quantity Number 1 货物数量 └ title String 如意金箍棒棒套商品标题 └ sku_id Number 3435344353 商品skuId └ item_id Number 65476576 商品itemId └ custom_codes String 6923432432,69235435,69,45345465 商家自用编码集合，对应该item_sku. 逗号分隔字符串
total_amount	Number	6000	订单总金额基础单位，人民币分
fund_bill_list	FundBill []	fundBillList	支付资金渠道列表
└ id String 201612310005439547867 资金渠道的id: * 1. type=CASH：为空； * 2. type=UNIONPAY：银联流水号； * 3. type=ALIPAY：支付宝订单号； * 4. type=WECHAT_PAY：微信支付订单号； * 6. type=CUSTOM_PROMOTION：零售商自有优惠id。 * 7. type=CUSTOM_PREPAY_CARD：零售商自有储值卡id * 8. type=MALING：为空 └ type String ALIPAY 资金渠道类型: CASH("现金支付"), UNIONPAY("银联刷卡支付"), ALIPAY("支付宝支付"), WECHAT_PAY("微信支付"), PROMOTION("零售+平台的优惠"), CUSTOM_PROMOTION("零售商自有优惠"), CUSTOM_PREPAY_CARD("零售商自有储值卡"), MALING("支付时抹零"); └ buyer_id String 53456436 用户ID └ buyer_id_type String ALIPAY_OPENID 买家类型： TAOBAO_OPENID("经阿里百川淘宝登陆获取到的用户ID"), ALIPAY_OPENID("经蚂蚁金服开放平台支付宝App登陆获得的用户ID"), WECHAT_OPENID("经微信开放平台微信App登陆获得的用户id"), PHONE_NUMBER("通过手机号码登陆"), APP_USERID("商户自由的用户ID"), ANONYMOUS_USER("匿名用户"); └ title String 支付宝支付标题： * 1. type=CASH：现金支付； * 2. type=UNIONPAY：银联刷卡支付； * 3. type=ALIPAY：支付宝支付； * 4. type=WECHAT_PAY：微信支付； * 5. type=PROMOTION: 零售+平台的优惠名称； * 6. type=CUSTOM_PROMOTION：零售商自有优惠名称； * 7. type=CUSTOM_PREPAY_CARD：零售商自有储值卡； * 8. type=MALING：抹零 * └ amount Number 5000 金额/优惠抵扣金额，单位：分 └ currency String CYN 货币种类： CYN("人民币"), USD("美元"), HKD("港币"); └ extend_params String {"k1":v1} 扩展参数，JSON格式 └ attachment String age:16,gender:female 附加数据，在查询订单中原样返回，该字段主要用于商户携带订单的自定义数据
picking_up	String	SELF_DELIVERY	提货方式: LOGISTICS("物流发货"), SELF_DELIVERY("门店自提");
gmt_create	Date	2016-12-31 23:59:59	创建时间
gmt_pay	Date	2016-12-31 23:59:59	支付时间
gmt_cancel	Date	2016-12-31 23:59:59	订单取消时间
refund_list	Refund []	refundList	退款列表
└ refund_time Date 2016-12-31 23:59:59 refundTime └ out_request_no String 347543658346 outRequestNo refund_bill_list FundBill [] refundBillList 退款渠道列表 └ id String 201612310005439547867 资金渠道的id: * 1. type=CASH：为空； * 2. type=UNIONPAY：银联流水号； * 3. type=ALIPAY：支付宝订单号； * 4. type=WECHAT_PAY：微信支付订单号； * 6. type=CUSTOM_PROMOTION：零售商自有优惠id。 * 7. type=CUSTOM_PREPAY_CARD：零售商自有储值卡id * 8. type=MALING：为空 └ type String ALIPAY 资金渠道类型: CASH("现金支付"), UNIONPAY("银联刷卡支付"), ALIPAY("支付宝支付"), WECHAT_PAY("微信支付"), PROMOTION("零售+平台的优惠"), CUSTOM_PROMOTION("零售商自有优惠"), CUSTOM_PREPAY_CARD("零售商自有储值卡"), MALING("支付时抹零"); └ buyer_id String 53456436 用户ID └ buyer_id_type String ALIPAY_OPENID 买家类型： TAOBAO_OPENID("经阿里百川淘宝登陆获取到的用户ID"), ALIPAY_OPENID("经蚂蚁金服开放平台支付宝App登陆获得的用户ID"), WECHAT_OPENID("经微信开放平台微信App登陆获得的用户id"), PHONE_NUMBER("通过手机号码登陆"), APP_USERID("商户自由的用户ID"), ANONYMOUS_USER("匿名用户"); └ title String 支付宝支付标题： * 1. type=CASH：现金支付； * 2. type=UNIONPAY：银联刷卡支付； * 3. type=ALIPAY：支付宝支付； * 4. type=WECHAT_PAY：微信支付； * 5. type=PROMOTION: 零售+平台的优惠名称； * 6. type=CUSTOM_PROMOTION：零售商自有优惠名称； * 7. type=CUSTOM_PREPAY_CARD：零售商自有储值卡； * 8. type=MALING：抹零 * └ amount Number 5000 退款金额，单位：分 └ currency String CYN 货币种类： CYN("人民币"), USD("美元"), HKD("港币"); └ extend_params String {"k1":v1} 扩展参数，JSON格式 └ attachment String age:16,gender:female 附加数据，在查询订单中原样返回，该字段主要用于商户携带订单的自定义数据 └ refund_goods String itemIdA_skuIdA:2,itemIdB_skuIdB:3 退货的商品，逗号分隔元素，商品和数量冒号分隔
pay_status	String	SUCCESS	payStatus
refund_status	String	REFUNDED_PART	退款状态: REFUNED("已全额退款"), REFUNDED_PART("已部分退货");
logistics_status	String	SIGNED	物流状态: WAIT_FOR_CONSIGN("有待发货商品"), WAIT_FOR_SIGN("全部商品已发货"), SIGNED("全部商品已签收"), REJECTED("全部商品已拒收");
logistics_status_list	LogisticsStatus []	logisticsStatusList	物流状态列表
└ goods_id String 7875645_34234:2,6575675_324245:4 该物流单里面的商品，商品和商品之间逗号分隔，商品和数量冒号分隔 └ status String SIGNED 物流状态: WAIT_FOR_CONSIGN("有待发货商品"), WAIT_FOR_SIGN("全部商品已发货"), SIGNED("全部商品已签收"), REJECTED("全部商品已拒收"); └ logistics_company_name String 八戒速运物流公司名称 └ logistics_company_id String bajie9527 物流公司ID └ logistics_id String 54765876876 物流单号 └ modifyed_time Date 2016-12-31 23:59:59 更新时间 logistics_log_list LogisticsLog [] logisticsLogList 更新日志列表 └ time Date 2016-12-31 23:59:59 time └ desc String 货物抵达水帘洞内容
extend_params	String	{"k1":v1}	扩展参数 JSON
attachment	String	age:16,gender:female	透传参数，格式自定，查询时原样返回
trade_no	String	20170000004353453	零售+订单号
out_trade_no	String	3454765767	外部业务方订单号
omni_trade_no	String	986543454	全渠道订单号
store_id	String	100004	订单所在的零售+门店ID
sales_name	String	白骨精	收银员名称
trade_biz_type	byte	1	0：门店订单；1：全渠道订单；3：网直供订单

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaNlifeB2cTradeGetRequest req = new AlibabaNlifeB2cTradeGetRequest();
req.setTradeNo("100004000000000045678");
req.setOutTradeNo("OT9043289567834");
req.setStoreId("100004");
AlibabaNlifeB2cTradeGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaNlifeB2cTradeGetRequest req = new AlibabaNlifeB2cTradeGetRequest();
req.TradeNo = "100004000000000045678";
req.OutTradeNo = "OT9043289567834";
req.StoreId = "100004";
AlibabaNlifeB2cTradeGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaNlifeB2cTradeGetRequest;
$req->setTradeNo("100004000000000045678");
$req->setOutTradeNo("OT9043289567834");
$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.get' \
-d 'partner_id=apidoc' \
-d 'session=ed494049-c30e-41c3-8e6e-de4dd73328ff' \
-d 'sign=2CFD624452FFA8D890E9D98470F5C655' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+15%3A17%3A40' \
-d 'v=2.0' \
-d 'out_trade_no=OT9043289567834' \
-d 'store_id=100004' \
-d 'trade_no=100004000000000045678'

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

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

req.trade_no="100004000000000045678"
req.out_trade_no="OT9043289567834"
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.get");
add_param(pRequest,"trade_no","100004000000000045678");
add_param(pRequest,"out_trade_no","OT9043289567834");
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.get', {
	'trade_no':'100004000000000045678',
	'out_trade_no':'OT9043289567834',
	'store_id':'100004'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_nlife_b2c_trade_get_response>
    <channel>POS</channel>
    <channel_data>{&quot;k1&quot;:v1}</channel_data>
    <buyer_id>53456436</buyer_id>
    <buyer_id_type>ALIPAY_OPENID</buyer_id_type>
    <out_card_no>543765476</out_card_no>
    <order_body>如意金箍棒</order_body>
    <sales_id>dg001</sales_id>
    <goods_list>
        <goods>
            <id>53465467</id>
            <price>6000</price>
            <currency>CYN</currency>
            <guider>9527</guider>
            <quantity>1</quantity>
            <title>如意金箍棒棒套</title>
            <sku_id>3435344353</sku_id>
            <item_id>65476576</item_id>
            <custom_codes>6923432432,69235435,69,45345465</custom_codes>
        </goods>
    </goods_list>
    <total_amount>6000</total_amount>
    <fund_bill_list>
        <fund_bill>
            <id>201612310005439547867</id>
            <type>ALIPAY</type>
            <buyer_id>53456436</buyer_id>
            <buyer_id_type>ALIPAY_OPENID</buyer_id_type>
            <title>支付宝支付</title>
            <amount>5000</amount>
            <currency>CYN</currency>
            <extend_params>{&quot;k1&quot;:v1}</extend_params>
            <attachment>age:16,gender:female</attachment>
        </fund_bill>
    </fund_bill_list>
    <picking_up>SELF_DELIVERY</picking_up>
    <gmt_create>2016-12-31 23:59:59</gmt_create>
    <gmt_pay>2016-12-31 23:59:59</gmt_pay>
    <gmt_cancel>2016-12-31 23:59:59</gmt_cancel>
    <refund_list>
        <refund>
            <refund_time>2016-12-31 23:59:59</refund_time>
            <out_request_no>347543658346</out_request_no>
            <refund_bill_list>
                <fund_bill>
                    <id>201612310005439547867</id>
                    <type>ALIPAY</type>
                    <buyer_id>53456436</buyer_id>
                    <buyer_id_type>ALIPAY_OPENID</buyer_id_type>
                    <title>支付宝支付</title>
                    <amount>5000</amount>
                    <currency>CYN</currency>
                    <extend_params>{&quot;k1&quot;:v1}</extend_params>
                    <attachment>age:16,gender:female</attachment>
                </fund_bill>
            </refund_bill_list>
            <refund_goods>itemIdA_skuIdA:2,itemIdB_skuIdB:3</refund_goods>
        </refund>
    </refund_list>
    <pay_status>SUCCESS</pay_status>
    <refund_status>REFUNDED_PART</refund_status>
    <logistics_status>SIGNED</logistics_status>
    <logistics_status_list>
        <logistics_status>
            <goods_id>7875645_34234:2,6575675_324245:4</goods_id>
            <status>SIGNED</status>
            <logistics_company_name>八戒速运</logistics_company_name>
            <logistics_company_id>bajie9527</logistics_company_id>
            <logistics_id>54765876876</logistics_id>
            <modifyed_time>2016-12-31 23:59:59</modifyed_time>
            <logistics_log_list>
                <logistics_log>
                    <time>2016-12-31 23:59:59</time>
                    <desc>货物抵达水帘洞</desc>
                </logistics_log>
            </logistics_log_list>
        </logistics_status>
    </logistics_status_list>
    <extend_params>{&quot;k1&quot;:v1}</extend_params>
    <attachment>age:16,gender:female</attachment>
    <trade_no>20170000004353453</trade_no>
    <out_trade_no>3454765767</out_trade_no>
    <omni_trade_no>986543454</omni_trade_no>
    <store_id>100004</store_id>
    <sales_name>白骨精</sales_name>
    <trade_biz_type>1</trade_biz_type>
</alibaba_nlife_b2c_trade_get_response>

{
    "alibaba_nlife_b2c_trade_get_response":{
        "channel":"POS",
        "channel_data":"{\"k1\":v1}",
        "buyer_id":"53456436",
        "buyer_id_type":"ALIPAY_OPENID",
        "out_card_no":"543765476",
        "order_body":"如意金箍棒",
        "sales_id":"dg001",
        "goods_list":{
            "goods":[
                {
                    "id":"53465467",
                    "price":6000,
                    "currency":"CYN",
                    "guider":"9527",
                    "quantity":1,
                    "title":"如意金箍棒棒套",
                    "sku_id":3435344353,
                    "item_id":65476576,
                    "custom_codes":"6923432432,69235435,69,45345465"
                }
            ]
        },
        "total_amount":6000,
        "fund_bill_list":{
            "fund_bill":[
                {
                    "id":"201612310005439547867",
                    "type":"ALIPAY",
                    "buyer_id":"53456436",
                    "buyer_id_type":"ALIPAY_OPENID",
                    "title":"支付宝支付",
                    "amount":5000,
                    "currency":"CYN",
                    "extend_params":"{\"k1\":v1}",
                    "attachment":"age:16,gender:female"
                }
            ]
        },
        "picking_up":"SELF_DELIVERY",
        "gmt_create":"2016-12-31 23:59:59",
        "gmt_pay":"2016-12-31 23:59:59",
        "gmt_cancel":"2016-12-31 23:59:59",
        "refund_list":{
            "refund":[
                {
                    "refund_time":"2016-12-31 23:59:59",
                    "out_request_no":"347543658346",
                    "refund_bill_list":{
                        "fund_bill":[
                            {
                                "id":"201612310005439547867",
                                "type":"ALIPAY",
                                "buyer_id":"53456436",
                                "buyer_id_type":"ALIPAY_OPENID",
                                "title":"支付宝支付",
                                "amount":5000,
                                "currency":"CYN",
                                "extend_params":"{\"k1\":v1}",
                                "attachment":"age:16,gender:female"
                            }
                        ]
                    },
                    "refund_goods":"itemIdA_skuIdA:2,itemIdB_skuIdB:3"
                }
            ]
        },
        "pay_status":"SUCCESS",
        "refund_status":"REFUNDED_PART",
        "logistics_status":"SIGNED",
        "logistics_status_list":{
            "logistics_status":[
                {
                    "goods_id":"7875645_34234:2,6575675_324245:4",
                    "status":"SIGNED",
                    "logistics_company_name":"八戒速运",
                    "logistics_company_id":"bajie9527",
                    "logistics_id":"54765876876",
                    "modifyed_time":"2016-12-31 23:59:59",
                    "logistics_log_list":{
                        "logistics_log":[
                            {
                                "time":"2016-12-31 23:59:59",
                                "desc":"货物抵达水帘洞"
                            }
                        ]
                    }
                }
            ]
        },
        "extend_params":"{\"k1\":v1}",
        "attachment":"age:16,gender:female",
        "trade_no":"20170000004353453",
        "out_trade_no":"3454765767",
        "omni_trade_no":"986543454",
        "store_id":"100004",
        "sales_name":"白骨精",
        "trade_biz_type":"1"
    }
}

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.get (零售+平台查询订单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ