淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
search_option	TopApiRefundRptOption	必须			参数option
└ page_size Number 必须 1 pagesize └ search_type Number 必须 1 1-维权发起时间，2-订单结算时间（正向订单），3-维权完成时间，4-订单创建时间，5-订单更新时间 └ refund_type Number 必须 1 1 表示2方，2表示3方，0表示不限 └ start_time Date 必须 2018-10-10 00:00:00 开始时间 └ page_no Number 必须 1 pagenumber └ biz_type Number 必须 1 1代表渠道关系id，2代表会员关系id

名称	类型	示例值	描述
result	RpcResult		返回结果封装对象
└ result_msg String 返回信息 data PageResult 真正的业务数据结构 └ page_no String pageNo └ page_size String pageSize └ total_count String 总值 results Result [] 订单列表 └ tb_trade_parent_id Number 淘宝订单编号 └ special_id Number 会员关系id └ relation_id Number 渠道关系id └ tk3rd_pub_id Number 第三方推广者memberid └ tk_pub_id Number 推广者memberid └ tk_subsidy_fee_refund3rd_pub String 第三方应该返还的补贴 └ tk_commission_fee_refund3rd_pub String 第三方应该返还的佣金 └ tk_subsidy_fee_refund_pub String 第二方应该返还的补贴(不包括技术服务费) └ tk_commission_fee_refund_pub String 第二方应该返还的佣金(不包括技术服务费) └ tk_refund_suit_time Date 维权完成时间 └ tk_refund_time Date 维权创建时间 └ earning_time Date 订单结算时间 └ tb_trade_create_time Date 订单创建时间 └ refund_status Number 维权创建(淘客结算回执) 4,维权成功(淘客结算回执) 2,维权失败(淘客结算回执) 3,发生多次维权，待处理 11,从淘客处补扣（钱已结给淘客）等待扣款 12,从淘客处补扣（钱已结给淘客）扣款成功 13,从卖家处补扣（钱已结给卖家）等待扣款 14,从卖家处补扣（钱已结给卖家）扣款成功 15 └ tb_auction_title String 宝贝标题 └ tb_trade_id Number 淘宝子订单编号 └ refund_fee String 维权金额 └ tb_trade_finish_price String 结算金额 └ tk_pub_show_return_fee String 应返商家金额(二方) └ tk3rd_pub_show_return_fee String 应返商家金额(三方) └ refund_type Number 1 表示2方，2表示3方 └ alsc_pid String （口碑订单）口碑父订单号 └ alsc_id String （口碑订单）口碑子订单号 └ modified_time Date 更新时间 └ result_code Number 接口返回值信息，跟rpc架构保持一致 └ biz_error_desc String 业务错误信息 └ biz_error_code Number 业务错误码 101, 102,103

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkRelationRefundRequest req = new TbkRelationRefundRequest();
TbkRelationRefundRequest.TopApiRefundRptOption obj1 = new TbkRelationRefundRequest.TopApiRefundRptOption();
obj1.setPageSize(1L);
obj1.setSearchType(1L);
obj1.setRefundType(1L);
obj1.setStartTime(StringUtils.parseDateTime("2018-10-10 00:00:00"));
obj1.setPageNo(1L);
obj1.setBizType(1L);
req.setSearchOption(obj1);
TbkRelationRefundResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkRelationRefundRequest req = new TbkRelationRefundRequest();
TbkRelationRefundRequest.TopApiRefundRptOptionDomain obj1 = new TbkRelationRefundRequest.TopApiRefundRptOptionDomain();
obj1.PageSize = 1L;
obj1.SearchType = 1L;
obj1.RefundType = 1L;
obj1.StartTime = DateTime.Parse(2018-10-10 00:00:00");
obj1.PageNo = 1L;
obj1.BizType = 1L;
req.SearchOption_ = obj1;
TbkRelationRefundResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkRelationRefundRequest;
$search_option = new TopApiRefundRptOption;
$search_option->page_size="1";
$search_option->search_type="1";
$search_option->refund_type="1";
$search_option->start_time="2018-10-10 00:00:00";
$search_option->page_no="1";
$search_option->biz_type="1";
$req->setSearchOption(json_encode($search_option));
$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.tbk.relation.refund' \
-d 'partner_id=apidoc' \
-d 'sign=FAC6E3CB2B16FBD2F4EF544AC3D7D462' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-01-16+01%3A03%3A52' \
-d 'v=2.0' \
-d 'search_option=null'

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

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

req.search_option=""
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.tbk.relation.refund");
add_param(pRequest,"search_option","数据结构JSON示例");
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.tbk.relation.refund', {
	'search_option':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_relation_refund_response>
    <result>
        <result_msg></result_msg>
        <data>
            <page_no></page_no>
            <page_size></page_size>
            <total_count></total_count>
            <results>
                <result>
                    <tb_trade_parent_id></tb_trade_parent_id>
                    <special_id></special_id>
                    <relation_id></relation_id>
                    <tk3rd_pub_id></tk3rd_pub_id>
                    <tk_pub_id></tk_pub_id>
                    <tk_subsidy_fee_refund3rd_pub></tk_subsidy_fee_refund3rd_pub>
                    <tk_commission_fee_refund3rd_pub></tk_commission_fee_refund3rd_pub>
                    <tk_subsidy_fee_refund_pub></tk_subsidy_fee_refund_pub>
                    <tk_commission_fee_refund_pub></tk_commission_fee_refund_pub>
                    <tk_refund_suit_time></tk_refund_suit_time>
                    <tk_refund_time></tk_refund_time>
                    <earning_time></earning_time>
                    <tb_trade_create_time></tb_trade_create_time>
                    <refund_status></refund_status>
                    <tb_auction_title></tb_auction_title>
                    <tb_trade_id></tb_trade_id>
                    <refund_fee></refund_fee>
                    <tb_trade_finish_price></tb_trade_finish_price>
                    <tk_pub_show_return_fee></tk_pub_show_return_fee>
                    <tk3rd_pub_show_return_fee></tk3rd_pub_show_return_fee>
                    <refund_type></refund_type>
                    <alsc_pid></alsc_pid>
                    <alsc_id></alsc_id>
                    <modified_time></modified_time>
                </result>
            </results>
        </data>
        <result_code></result_code>
        <biz_error_desc></biz_error_desc>
        <biz_error_code></biz_error_code>
    </result>
</tbk_relation_refund_response>

{
    "tbk_relation_refund_response":{
        "result":{
            "result_msg":"",
            "data":{
                "page_no":"",
                "page_size":"",
                "total_count":"",
                "results":{
                    "result":[
                        {
                            "tb_trade_parent_id":,
                            "special_id":,
                            "relation_id":,
                            "tk3rd_pub_id":,
                            "tk_pub_id":,
                            "tk_subsidy_fee_refund3rd_pub":"",
                            "tk_commission_fee_refund3rd_pub":"",
                            "tk_subsidy_fee_refund_pub":"",
                            "tk_commission_fee_refund_pub":"",
                            "tk_refund_suit_time":"",
                            "tk_refund_time":"",
                            "earning_time":"",
                            "tb_trade_create_time":"",
                            "refund_status":,
                            "tb_auction_title":"",
                            "tb_trade_id":,
                            "refund_fee":"",
                            "tb_trade_finish_price":"",
                            "tk_pub_show_return_fee":"",
                            "tk3rd_pub_show_return_fee":"",
                            "refund_type":,
                            "alsc_pid":"",
                            "alsc_id":"",
                            "modified_time":""
                        }
                    ]
                }
            },
            "result_code":,
            "biz_error_desc":"",
            "biz_error_code":
        }
    }
}

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.tbk.relation.refund (淘宝客-推广者-维权退款订单查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ