淘宝开放平台

请求地址：

环境	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,rx_audit_status		需要返回的字段列表，多个字段用半角逗号分隔，可选值为返回示例中能看到的所有字段。rx_audit_status=0,处方药未审核
start_created	Date	可选	2000-01-01 00:00:00		查询三个月内交易创建时间开始。格式:yyyy-MM-dd HH:mm:ss
end_created	Date	可选	2000-01-01 23:59:59		查询交易创建时间结束。格式:yyyy-MM-dd HH:mm:ss
status	String	可选	ALL_WAIT_PAY		交易状态
buyer_nick	String	可选	zhangsan		买家昵称
type	String	可选	game_equipment		交易类型列表
ext_type	String	可选	service		可选值有ershou(二手市场的订单）,service（商城服务子订单）mark（双十一大促活动异常订单）作为扩展类型筛选只能做单个ext_type查询，不能全部查询所有的ext_type类型
rate_status	String	可选	RATE_UNBUYER		评价状态，默认查询所有评价状态的数据，除了默认值外每次只能查询一种状态。可选值：RATE_UNBUYER(买家未评)RATE_UNSELLER(卖家未评)RATE_BUYER_UNSELLER(买家已评，卖家未评)RATE_UNBUYER_SELLER(买家未评，卖家已评)RATE_BUYER_SELLER(买家已评,卖家已评)
tag	String	可选	time_card		卖家对交易的自定义分组标签，目前可选值为：time_card（点卡软件代充），fee_card（话费软件代充）
page_no	Number	可选	1	默认值：1	页码。取值范围:大于零的整数; 默认值:1
page_size	Number	可选	40	默认值：40	每页条数。取值范围:大于零的整数; 默认值:40;最大值:100
use_has_next	Boolean	可选	true	默认值：false	是否启用has_next的分页方式，如果指定true,则返回的结果中不包含总记录数，但是会新增一个是否存在下一页的的字段，通过此种方式获取增量交易，接口调用成功率在原有的基础上有所提升。
buyer_open_uid	String	可选	AAHm5d-EAAeGwJedwSHpg8bT		买家openId

名称	类型	示例值	描述
total_results	Number	100	搜索到的交易信息总数
trades	Trade []		搜索到的交易信息列表，返回的Trade和Order中包含的具体信息为入参fields请求的字段信息
└ tid Number 2231958349 交易编号 (父订单的交易编号) └ status String TRADE_NO_CREATE_PAY 交易状态。 └ payment String 200.07 实付金额。精确到2位小数;单位:元。如:200.07，表示:200元7分 └ modified Date 2000-01-01 00:00:00 交易修改时间(用户对订单的任何修改都会更新此字段)。格式:yyyy-MM-dd HH:mm:ss └ 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 分阶段付款的已付金额（万人团订单已付金额） └ send_time String 2000-01-01 订单将在此时间前发出，主要用于预售订单 orders Order [] 订单列表 └ refund_status String SUCCESS(退款成功) 退款状态。退款状态。可选值 WAIT_SELLER_AGREE(买家已经申请退款，等待卖家同意) WAIT_BUYER_RETURN_GOODS(卖家已经同意退款，等待买家退货) WAIT_SELLER_CONFIRM_GOODS(买家已经退货，等待卖家确认收货) SELLER_REFUSE_BUYER(卖家拒绝退款) CLOSED(退款关闭) SUCCESS(退款成功) └ 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元购机交易)
has_next	Boolean	true	是否存在下一页

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TradesSoldGetVoRequest req = new TradesSoldGetVoRequest();
req.setFields("tid,type,status,payment,orders,rx_audit_status");
req.setStartCreated(StringUtils.parseDateTime("2000-01-01 00:00:00"));
req.setEndCreated(StringUtils.parseDateTime("2000-01-01 23:59:59"));
req.setStatus("ALL_WAIT_PAY");
req.setBuyerNick("zhangsan");
req.setType("game_equipment");
req.setExtType("service");
req.setRateStatus("RATE_UNBUYER");
req.setTag("time_card");
req.setPageNo(1L);
req.setPageSize(40L);
req.setUseHasNext(true);
req.setBuyerOpenUid("AAHm5d-EAAeGwJedwSHpg8bT");
TradesSoldGetVoResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TradesSoldGetVoRequest req = new TradesSoldGetVoRequest();
req.Fields = "tid,type,status,payment,orders,rx_audit_status";
req.StartCreated = DateTime.Parse("2000-01-01 00:00:00");
req.EndCreated = DateTime.Parse("2000-01-01 23:59:59");
req.Status = "ALL_WAIT_PAY";
req.BuyerNick = "zhangsan";
req.Type = "game_equipment";
req.ExtType = "service";
req.RateStatus = "RATE_UNBUYER";
req.Tag = "time_card";
req.PageNo = 1L;
req.PageSize = 40L;
req.UseHasNext = true;
req.BuyerOpenUid = "AAHm5d-EAAeGwJedwSHpg8bT";
TradesSoldGetVoResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TradesSoldGetVoRequest;
$req->setFields("tid,type,status,payment,orders,rx_audit_status");
$req->setStartCreated("2000-01-01 00:00:00");
$req->setEndCreated("2000-01-01 23:59:59");
$req->setStatus("ALL_WAIT_PAY");
$req->setBuyerNick("zhangsan");
$req->setType("game_equipment");
$req->setExtType("service");
$req->setRateStatus("RATE_UNBUYER");
$req->setTag("time_card");
$req->setPageNo("1");
$req->setPageSize("40");
$req->setUseHasNext("true");
$req->setBuyerOpenUid("AAHm5d-EAAeGwJedwSHpg8bT");
$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.trades.sold.get.vo' \
-d 'partner_id=apidoc' \
-d 'session=d18af6cc-bdfd-45ee-a071-9c49306ab39c' \
-d 'sign=0BB1D19AF22189C5ACC44DB99C100DF8' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+08%3A02%3A31' \
-d 'v=2.0' \
-d 'buyer_nick=zhangsan' \
-d 'buyer_open_uid=AAHm5d-EAAeGwJedwSHpg8bT' \
-d 'end_created=2000-01-01+23%3A59%3A59' \
-d 'ext_type=service' \
-d 'fields=tid%2Ctype%2Cstatus%2Cpayment%2Corders%2Crx_audit_status' \
-d 'page_no=1' \
-d 'page_size=40' \
-d 'rate_status=RATE_UNBUYER' \
-d 'start_created=2000-01-01+00%3A00%3A00' \
-d 'status=ALL_WAIT_PAY' \
-d 'tag=time_card' \
-d 'type=game_equipment' \
-d 'use_has_next=true'

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

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

req.fields="tid,type,status,payment,orders,rx_audit_status"
req.start_created="2000-01-01 00:00:00"
req.end_created="2000-01-01 23:59:59"
req.status="ALL_WAIT_PAY"
req.buyer_nick="zhangsan"
req.type="game_equipment"
req.ext_type="service"
req.rate_status="RATE_UNBUYER"
req.tag="time_card"
req.page_no=1
req.page_size=40
req.use_has_next=true
req.buyer_open_uid="AAHm5d-EAAeGwJedwSHpg8bT"
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.trades.sold.get.vo");
add_param(pRequest,"fields","tid,type,status,payment,orders,rx_audit_status");
add_param(pRequest,"start_created","2000-01-01 00:00:00");
add_param(pRequest,"end_created","2000-01-01 23:59:59");
add_param(pRequest,"status","ALL_WAIT_PAY");
add_param(pRequest,"buyer_nick","zhangsan");
add_param(pRequest,"type","game_equipment");
add_param(pRequest,"ext_type","service");
add_param(pRequest,"rate_status","RATE_UNBUYER");
add_param(pRequest,"tag","time_card");
add_param(pRequest,"page_no","1");
add_param(pRequest,"page_size","40");
add_param(pRequest,"use_has_next","true");
add_param(pRequest,"buyer_open_uid","AAHm5d-EAAeGwJedwSHpg8bT");
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.trades.sold.get.vo', {
	'fields':'tid,type,status,payment,orders,rx_audit_status',
	'start_created':'2000-01-01 00:00:00',
	'end_created':'2000-01-01 23:59:59',
	'status':'ALL_WAIT_PAY',
	'buyer_nick':'zhangsan',
	'type':'game_equipment',
	'ext_type':'service',
	'rate_status':'RATE_UNBUYER',
	'tag':'time_card',
	'page_no':'1',
	'page_size':'40',
	'use_has_next':'true',
	'buyer_open_uid':'AAHm5d-EAAeGwJedwSHpg8bT'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<trades_sold_get_vo_response>
    <total_results>100</total_results>
    <trades>
        <trade>
            <tid>2231958349</tid>
            <status>TRADE_NO_CREATE_PAY</status>
            <payment>200.07</payment>
            <modified>2000-01-01 00:00:00</modified>
            <step_trade_status>FRONT_NOPAID_FINAL_NOPAID</step_trade_status>
            <step_paid_fee>525.70</step_paid_fee>
            <send_time>2000-01-01</send_time>
            <orders>
                <order>
                    <refund_status>SUCCESS(退款成功)</refund_status>
                </order>
            </orders>
            <type>fixed(一口价)</type>
        </trade>
    </trades>
    <has_next>true</has_next>
</trades_sold_get_vo_response>

{
    "trades_sold_get_vo_response":{
        "total_results":100,
        "trades":{
            "trade":[
                {
                    "tid":2231958349,
                    "status":"TRADE_NO_CREATE_PAY",
                    "payment":"200.07",
                    "modified":"2000-01-01 00:00:00",
                    "step_trade_status":"FRONT_NOPAID_FINAL_NOPAID",
                    "step_paid_fee":"525.70",
                    "send_time":"2000-01-01",
                    "orders":{
                        "order":[
                            {
                                "refund_status":"SUCCESS(退款成功)"
                            }
                        ]
                    },
                    "type":"fixed(一口价)"
                }
            ]
        },
        "has_next":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"
	}
}

错误码	错误描述	解决方案
isv.invalid-parameter:buyer_nick	用户不存在【***】	通过简单的判断可以减少此类错误：排除特殊字符的昵称，如包含空格，冒号之类的昵称或排除字符长度小于5个，大于20个的
isv.invalid-parameter:seller_nick	参数：seller_nick无效，格式不对、非法值、越界等	请填写正确的nick
isp.remote-service-timeout	API调用远程服务超时	1. 每次返回50条以下，时间跨度小于半个小时 2. 避开交易高峰期上午9:30-11:00，下午14:00-17:00，晚上20:00-22:30 3.使用增量API（taobao.increment.trades.get）可以减少甚至避免超时问题
isv.trade-service-rejection	请求被拒绝。	可能原因为限流，请不要频繁调用，尽量避开高峰期。
isp.trade-service-readdb-overflow	数据库限流。	请求量较大，请避开高峰期。
isv.trade-service-access-frequency	服务访问频繁	请稍后重试
isv.invalid-parameter:start_created-or-end_created	不合法的参数	创建时间和结束时间不能为空
isv.invalid-parameter:seller-id	非法的参数	卖家ID非法
isp.call-limited	限流	避开限流

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

交易API

taobao.trades.sold.get.vo (天猫国际海外仓直购店铺)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ