淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
fields	String	必须	tid,type,status,payment,orders,buyer_nick		需要返回的字段列表，多个字段用半角逗号分隔，可选值为返回示例中能看到的所有字段。
tid	Number	必须	123456789		交易编号

名称	类型	示例值	描述
trade	Trade		搜索到的交易信息列表，返回的Trade和Order中包含的具体信息为入参fields请求的字段信息
└ type String fixed(一口价) 交易类型列表，同时查询多种交易类型可用逗号分隔。默认同时查询guarantee_trade, auto_delivery, ec, cod的4种交易类型的数据可选值 fixed(一口价) auction(拍卖) guarantee_trade(一口价、拍卖) auto_delivery(自动发货) independent_simple_trade(旺店入门版交易) independent_shop_trade(旺店标准版交易) ec(直冲) cod(货到付款) fenxiao(分销) game_equipment(游戏装备) shopex_trade(ShopEX交易) netcn_trade(万网交易) external_trade(统一外部交易)o2o_offlinetrade（O2O交易）step (万人团)nopaid(无付款订单)pre_auth_type(预授权0元购机交易) └ created Date 2000-01-01 00:00:00 交易创建时间。格式:yyyy-MM-dd HH:mm:ss └ tid String 2231958349 交易编号 (父订单的交易编号) └ status String TRADE_NO_CREATE_PAY 交易状态。可选值: * 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(拼团中订单或者发货强管控的订单，已付款但禁止发货) └ total_fee String 200.07 商品金额（商品价格乘以数量的总金额）。精确到2位小数;单位:元。如:200.07，表示:200元7分 └ num_iid Number 3424234 商品数字编号 └ price String 200.07 商品价格。精确到2位小数；单位：元。如：200.07，表示：200元7分 └ num Number 1 商品购买数量。取值范围：大于零的整数,对于一个trade对应多个order的时候（一笔主订单，对应多笔子订单），num=0，num是一个跟商品关联的属性，一笔订单对应多比子订单的时候，主订单上的num无意义。 orders Order [] 订单列表 └ price String 200.07 商品价格。精确到2位小数;单位:元。如:200.07，表示:200元7分 └ num_iid Number 2342344 商品数字ID └ sku_id String 5937146 商品的最小库存单位Sku的id.可以通过taobao.item.sku.get获取详细的Sku信息 └ status String TRADE_NO_CREATE_PAY 订单状态（请关注此状态，如果为TRADE_CLOSED_BY_TAOBAO状态，则不要对此订单进行发货，切记啊！）。可选值: TRADE_NO_CREATE_PAY(没有创建支付宝交易) WAIT_BUYER_PAY(等待买家付款) WAIT_SELLER_SEND_GOODS(等待卖家发货,即:买家已付款) WAIT_BUYER_CONFIRM_GOODS(等待买家确认收货,即:卖家已发货) TRADE_BUYER_SIGNED(买家已签收,货到付款专用) TRADE_FINISHED(交易成功) TRADE_CLOSED(付款以后用户退款成功，交易自动关闭) TRADE_CLOSED_BY_TAOBAO(付款以前，卖家或买家主动关闭交易) PAY_PENDING(国际信用卡支付付款确认中) └ oid String 2231958349 子订单编号 └ total_fee String 200.07 应付金额（商品价格 * 商品数量 + 手工调整金额 - 子订单级订单优惠金额）。精确到2位小数;单位:元。如:200.07，表示:200元7分 └ num Number 1 购买数量。取值范围:大于零的整数 └ outer_sku_id String 81893848 外部网店自己定义的Sku编号 └ outer_iid String 152e442aefe88dd41cb0879232c0dcb0 商家外部编码(可与商家外部系统对接)。外部商家自己定义的商品Item的id，可以通过taobao.items.custom.get获取商品的Item的信息 └ pic_path String http://img08.taobao.net/bao/uploaded/i8/T1jVXXXePbXXaoPB6a_091917.jpg 商品图片的绝对路径 └ title String 测试机器商品标题 └ customization String { "itemId": 123, "skuId": 123, "text": [ { "id": 44, "content": "home" } ], "pic": [ { "id": 44, "url": "sn" } ] ,"dingzhi":";pluginId:182;dingzhiId:157886;"} 定制信息 └ payment String 29.98 子订单实付金额。精确到2位小数，单位:元。如:200.07，表示:200元7分。 └ discount_fee String 200.07 子订单级订单优惠金额。精确到2位小数;单位:元。如:200.07，表示:200元7分 └ divide_order_fee String 20.00 分摊之后的实付金额 └ part_mjz_discount String 20.00 优惠分摊 └ pay_time String 2000-01-01 00:00:00 付款时间。格式:yyyy-MM-dd HH:mm:ss。订单的付款时间即为物流订单的创建时间。 └ seller_memo String 好的卖家备注（与淘宝网上订单的卖家备注对应，只有卖家才能查看该字段） └ buyer_memo String 上衣要大一号买家备注（与淘宝网上订单的买家备注对应，只有买家才能查看该字段） └ post_fee String 200.07 邮费。精确到2位小数;单位:元。如:200.07，表示:200元7分 └ has_post_fee Boolean true 是否包含邮费。与available_confirm_fee同时使用。可选值:true(包含),false(不包含) promotion_details PromotionDetail [] 优惠详情 └ promotion_id String mjs 优惠id，(由营销工具id、优惠活动id和优惠详情id组成，结构为：营销工具id-优惠活动id_优惠详情id，如mjs-123024_211143） └ promotion_desc String 双11促销，满就送优惠活动的描述 └ gift_item_num String 1 满就送礼物的礼物数量 └ gift_item_id String 13233791195 赠品的宝贝id └ gift_item_name String 晨光签字笔满就送商品时，所送商品的名称 └ discount_fee String 10.00 优惠金额（免运费、限时打折时为空）,单位：元 └ promotion_name String 满就减钱优惠信息的名称 └ id String 22331764490705 交易的主订单或子订单号 └ step_trade_status String FRONT_NOPAID_FINAL_NOPAID 分阶段付款的订单状态（例如万人团订单等），目前有三返回状态FRONT_NOPAID_FINAL_NOPAID(定金未付尾款未付)，FRONT_PAID_FINAL_NOPAID(定金已付尾款未付)，FRONT_PAID_FINAL_PAID(定金和尾款都付) └ step_paid_fee String 525.70 分阶段付款的已付金额（万人团订单已付金额） └ seller_nick String 麦包包卖家昵称 └ payment String 200.07 实付金额。精确到2位小数;单位:元。如:200.07，表示:200元7分 └ modified Date 2000-01-01 00:00:00 交易修改时间(用户对订单的任何修改都会更新此字段)。格式:yyyy-MM-dd HH:mm:ss └ buyer_open_uid String 买家的openuid,入参fields中传入buyer_nick ，才能返回

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpenTradeGetRequest req = new OpenTradeGetRequest();
req.setFields("tid,type,status,payment,orders,buyer_nick");
req.setTid(123456789L);
OpenTradeGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpenTradeGetRequest req = new OpenTradeGetRequest();
req.Fields = "tid,type,status,payment,orders,buyer_nick";
req.Tid = 123456789L;
OpenTradeGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpenTradeGetRequest;
$req->setFields("tid,type,status,payment,orders,buyer_nick");
$req->setTid("123456789");
$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=taobao.open.trade.get' \
-d 'partner_id=apidoc' \
-d 'session=1474b4c3-8b7d-448b-87db-5d0d4cea2f64' \
-d 'sign=CA5AD13B2E4DA35D8E3E60C68111CD78' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-06+19%3A42%3A35' \
-d 'v=2.0' \
-d 'fields=tid%2Ctype%2Cstatus%2Cpayment%2Corders%2Cbuyer_nick' \
-d 'tid=123456789'

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

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

req.fields="tid,type,status,payment,orders,buyer_nick"
req.tid=123456789
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,"taobao.open.trade.get");
add_param(pRequest,"fields","tid,type,status,payment,orders,buyer_nick");
add_param(pRequest,"tid","123456789");
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('taobao.open.trade.get', {
	'fields':'tid,type,status,payment,orders,buyer_nick',
	'tid':'123456789'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<open_trade_get_response>
    <trade>
        <type>fixed(一口价)</type>
        <created>2000-01-01 00:00:00</created>
        <tid>2231958349</tid>
        <status>TRADE_NO_CREATE_PAY</status>
        <total_fee>200.07</total_fee>
        <num_iid>3424234</num_iid>
        <price>200.07</price>
        <num>1</num>
        <orders>
            <order>
                <price>200.07</price>
                <num_iid>2342344</num_iid>
                <sku_id>5937146</sku_id>
                <status>TRADE_NO_CREATE_PAY</status>
                <oid>2231958349</oid>
                <total_fee>200.07</total_fee>
                <num>1</num>
                <outer_sku_id>81893848</outer_sku_id>
                <outer_iid>152e442aefe88dd41cb0879232c0dcb0</outer_iid>
                <pic_path>http://img08.taobao.net/bao/uploaded/i8/T1jVXXXePbXXaoPB6a_091917.jpg</pic_path>
                <title>测试机器</title>
                <customization>{ &quot;itemId&quot;: 123, &quot;skuId&quot;: 123, &quot;text&quot;: [ { &quot;id&quot;: 44, &quot;content&quot;: &quot;home&quot; } ], &quot;pic&quot;: [ { &quot;id&quot;: 44, &quot;url&quot;: &quot;sn&quot; } ] ,&quot;dingzhi&quot;:&quot;;pluginId:182;dingzhiId:157886;&quot;}</customization>
                <payment>29.98</payment>
                <discount_fee>200.07</discount_fee>
                <divide_order_fee>20.00</divide_order_fee>
                <part_mjz_discount>20.00</part_mjz_discount>
            </order>
        </orders>
        <pay_time>2000-01-01 00:00:00</pay_time>
        <seller_memo>好的</seller_memo>
        <buyer_memo>上衣要大一号</buyer_memo>
        <post_fee>200.07</post_fee>
        <has_post_fee>true</has_post_fee>
        <promotion_details>
            <promotion_detail>
                <promotion_id>mjs</promotion_id>
                <promotion_desc>双11促销，满就送</promotion_desc>
                <gift_item_num>1</gift_item_num>
                <gift_item_id>13233791195</gift_item_id>
                <gift_item_name>晨光签字笔</gift_item_name>
                <discount_fee>10.00</discount_fee>
                <promotion_name>满就减钱</promotion_name>
                <id>22331764490705</id>
            </promotion_detail>
        </promotion_details>
        <step_trade_status>FRONT_NOPAID_FINAL_NOPAID</step_trade_status>
        <step_paid_fee>525.70</step_paid_fee>
        <seller_nick>麦包包</seller_nick>
        <payment>200.07</payment>
        <modified>2000-01-01 00:00:00</modified>
        <buyer_open_uid></buyer_open_uid>
    </trade>
</open_trade_get_response>

{
    "open_trade_get_response":{
        "trade":{
            "type":"fixed(一口价)",
            "created":"2000-01-01 00:00:00",
            "tid":"2231958349",
            "status":"TRADE_NO_CREATE_PAY",
            "total_fee":"200.07",
            "num_iid":3424234,
            "price":"200.07",
            "num":1,
            "orders":{
                "order":[
                    {
                        "price":"200.07",
                        "num_iid":2342344,
                        "sku_id":"5937146",
                        "status":"TRADE_NO_CREATE_PAY",
                        "oid":"2231958349",
                        "total_fee":"200.07",
                        "num":1,
                        "outer_sku_id":"81893848",
                        "outer_iid":"152e442aefe88dd41cb0879232c0dcb0",
                        "pic_path":"http:\/\/img08.taobao.net\/bao\/uploaded\/i8\/T1jVXXXePbXXaoPB6a_091917.jpg",
                        "title":"测试机器",
                        "customization":"{ \"itemId\": 123, \"skuId\": 123, \"text\": [ { \"id\": 44, \"content\": \"home\" } ], \"pic\": [ { \"id\": 44, \"url\": \"sn\" } ] ,\"dingzhi\":\";pluginId:182;dingzhiId:157886;\"}",
                        "payment":"29.98",
                        "discount_fee":"200.07",
                        "divide_order_fee":"20.00",
                        "part_mjz_discount":"20.00"
                    }
                ]
            },
            "pay_time":"2000-01-01 00:00:00",
            "seller_memo":"好的",
            "buyer_memo":"上衣要大一号",
            "post_fee":"200.07",
            "has_post_fee":true,
            "promotion_details":{
                "promotion_detail":[
                    {
                        "promotion_id":"mjs",
                        "promotion_desc":"双11促销，满就送",
                        "gift_item_num":"1",
                        "gift_item_id":"13233791195",
                        "gift_item_name":"晨光签字笔",
                        "discount_fee":"10.00",
                        "promotion_name":"满就减钱",
                        "id":"22331764490705"
                    }
                ]
            },
            "step_trade_status":"FRONT_NOPAID_FINAL_NOPAID",
            "step_paid_fee":"525.70",
            "seller_nick":"麦包包",
            "payment":"200.07",
            "modified":"2000-01-01 00:00:00",
            "buyer_open_uid":""
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
isv.invalid-parameter:tid	参数：tid无效，格式不对、非法值、越界等	填写正确的订单号
isv.trade-not-exist	交易不存在	订单已进入历史库，出现错误清除本地数据库该订单，不要重试
isv.invalid-permission	必须是此交易的买家或卖家才能获取交易详细信息	查看是否程序出问题导致取到别的卖家的交易ID而无法查看，出现错误不要重试
isp.trade-service-failed	交易服务不可用	联系淘宝技术支持
isp.call-limited	接口调用限制，流控	联系淘宝技术支持

API测试工具错误码查询工具 SDK下载

交易API

taobao.open.trade.get (获取单笔交易的部分信息(商家应用使用))

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ