淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
inputjson	String	必须	{"alipayTradeNo":"AlipayTradeNo","attributes":{},"auctionId":123,"auctionPicUrl":"AuctionPicUrl","auctionPrice":12,"auctionTitle":"AuctionTitle","bizOrderId":123,"bizType":1,"buyAmount":1,"buyerId":123,"endTime":1508990124639,"gmtCreate":1508990124639,"gmtModify":1508990124639,"orderNo":"OrderNo","payTime":1508990124639,"sellerId":123,"sellerNick":"SellerNick","subBizType":12,"tradeStatus":1}		外部订单json串

名称	类型	示例值	描述
result	ResultSet	null	result
└ page_results Number 0 pageResults results Results [] null results └ biz_order_id Number 0 bizOrderId └ result_code String - resultCode └ sub_result_code String - subResultCode └ success Boolean true success └ total_results Number 0 totalResults └ has_next Boolean false hasNext └ exception String exception exception └ error_code String 0 errorCode └ error_msg String 0 errorMsg

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TradeOrderSyncoutorderRequest req = new TradeOrderSyncoutorderRequest();
req.setInputjson("{\"alipayTradeNo\":\"AlipayTradeNo\",\"attributes\":{},\"auctionId\":123,\"auctionPicUrl\":\"AuctionPicUrl\",\"auctionPrice\":12,\"auctionTitle\":\"AuctionTitle\",\"bizOrderId\":123,\"bizType\":1,\"buyAmount\":1,\"buyerId\":123,\"endTime\":1508990124639,\"gmtCreate\":1508990124639,\"gmtModify\":1508990124639,\"orderNo\":\"OrderNo\",\"payTime\":1508990124639,\"sellerId\":123,\"sellerNick\":\"SellerNick\",\"subBizType\":12,\"tradeStatus\":1}");
TradeOrderSyncoutorderResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TradeOrderSyncoutorderRequest req = new TradeOrderSyncoutorderRequest();
req.Inputjson = "{\"alipayTradeNo\":\"AlipayTradeNo\",\"attributes\":{},\"auctionId\":123,\"auctionPicUrl\":\"AuctionPicUrl\",\"auctionPrice\":12,\"auctionTitle\":\"AuctionTitle\",\"bizOrderId\":123,\"bizType\":1,\"buyAmount\":1,\"buyerId\":123,\"endTime\":1508990124639,\"gmtCreate\":1508990124639,\"gmtModify\":1508990124639,\"orderNo\":\"OrderNo\",\"payTime\":1508990124639,\"sellerId\":123,\"sellerNick\":\"SellerNick\",\"subBizType\":12,\"tradeStatus\":1}";
TradeOrderSyncoutorderResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TradeOrderSyncoutorderRequest;
$req->setInputjson("{\"alipayTradeNo\":\"AlipayTradeNo\",\"attributes\":{},\"auctionId\":123,\"auctionPicUrl\":\"AuctionPicUrl\",\"auctionPrice\":12,\"auctionTitle\":\"AuctionTitle\",\"bizOrderId\":123,\"bizType\":1,\"buyAmount\":1,\"buyerId\":123,\"endTime\":1508990124639,\"gmtCreate\":1508990124639,\"gmtModify\":1508990124639,\"orderNo\":\"OrderNo\",\"payTime\":1508990124639,\"sellerId\":123,\"sellerNick\":\"SellerNick\",\"subBizType\":12,\"tradeStatus\":1}");
$resp = $c->execute($req);

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.trade.order.syncoutorder' \
-d 'partner_id=apidoc' \
-d 'sign=799A5CA69A3B10FB0774567BE824B1EA' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-06+21%3A09%3A07' \
-d 'v=2.0' \
-d 'inputjson=%7B%5C%22alipayTradeNo%5C%22%3A%5C%22AlipayTradeNo%5C%22%2C%5C%22attributes%5C%22%3A%7B%7D%2C%5C%22auctionId%5C%22%3A123%2C%5C%22auctionPicUrl%5C%22%3A%5C%22AuctionPicUrl%5C%22%2C%5C%22auctionPrice%5C%22%3A12%2C%5C%22auctionTitle%5C%22%3A%5C%22AuctionTitle%5C%22%2C%5C%22bizOrderId%5C%22%3A123%2C%5C%22bizType%5C%22%3A1%2C%5C%22buyAmount%5C%22%3A1%2C%5C%22buyerId%5C%22%3A123%2C%5C%22endTime%5C%22%3A1508990124639%2C%5C%22gmtCreate%5C%22%3A1508990124639%2C%5C%22gmtModify%5C%22%3A1508990124639%2C%5C%22orderNo%5C%22%3A%5C%22OrderNo%5C%22%2C%5C%22payTime%5C%22%3A1508990124639%2C%5C%22sellerId%5C%22%3A123%2C%5C%22sellerNick%5C%22%3A%5C%22SellerNick%5C%22%2C%5C%22subBizType%5C%22%3A12%2C%5C%22tradeStatus%5C%22%3A1%7D'

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

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

req.inputjson="{\"alipayTradeNo\":\"AlipayTradeNo\",\"attributes\":{},\"auctionId\":123,\"auctionPicUrl\":\"AuctionPicUrl\",\"auctionPrice\":12,\"auctionTitle\":\"AuctionTitle\",\"bizOrderId\":123,\"bizType\":1,\"buyAmount\":1,\"buyerId\":123,\"endTime\":1508990124639,\"gmtCreate\":1508990124639,\"gmtModify\":1508990124639,\"orderNo\":\"OrderNo\",\"payTime\":1508990124639,\"sellerId\":123,\"sellerNick\":\"SellerNick\",\"subBizType\":12,\"tradeStatus\":1}"
try:
	resp= req.getResponse()
	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.trade.order.syncoutorder");
add_param(pRequest,"inputjson","{\"alipayTradeNo\":\"AlipayTradeNo\",\"attributes\":{},\"auctionId\":123,\"auctionPicUrl\":\"AuctionPicUrl\",\"auctionPrice\":12,\"auctionTitle\":\"AuctionTitle\",\"bizOrderId\":123,\"bizType\":1,\"buyAmount\":1,\"buyerId\":123,\"endTime\":1508990124639,\"gmtCreate\":1508990124639,\"gmtModify\":1508990124639,\"orderNo\":\"OrderNo\",\"payTime\":1508990124639,\"sellerId\":123,\"sellerNick\":\"SellerNick\",\"subBizType\":12,\"tradeStatus\":1}");
pResponse = top_execute(pClient,pRequest,NULL);
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.trade.order.syncoutorder', {
	'inputjson':'{\"alipayTradeNo\":\"AlipayTradeNo\",\"attributes\":{},\"auctionId\":123,\"auctionPicUrl\":\"AuctionPicUrl\",\"auctionPrice\":12,\"auctionTitle\":\"AuctionTitle\",\"bizOrderId\":123,\"bizType\":1,\"buyAmount\":1,\"buyerId\":123,\"endTime\":1508990124639,\"gmtCreate\":1508990124639,\"gmtModify\":1508990124639,\"orderNo\":\"OrderNo\",\"payTime\":1508990124639,\"sellerId\":123,\"sellerNick\":\"SellerNick\",\"subBizType\":12,\"tradeStatus\":1}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<trade_order_syncoutorder_response>
    <result>
        <page_results>0</page_results>
        <results>
            <results>
                <biz_order_id>0</biz_order_id>
                <result_code>-</result_code>
                <sub_result_code>-</sub_result_code>
                <success>true</success>
            </results>
        </results>
        <total_results>0</total_results>
        <has_next>false</has_next>
        <exception>exception</exception>
        <error_code>0</error_code>
        <error_msg>0</error_msg>
    </result>
</trade_order_syncoutorder_response>

{
    "trade_order_syncoutorder_response":{
        "result":{
            "page_results":0,
            "results":{
                "results":[
                    {
                        "biz_order_id":0,
                        "result_code":"-",
                        "sub_result_code":"-",
                        "success":true
                    }
                ]
            },
            "total_results":0,
            "has_next":false,
            "exception":"exception",
            "error_code":"0",
            "error_msg":"0"
        }
    }
}

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

taobao.trade.order.syncoutorder (外部订单同步接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ