淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
publisher_refund_order_query_option	PublisherRefundOrderQueryOption	可选			全量维权订单查询入参
└ jump_type Number 可选 1 跳转类型，当向前或者向后翻页必须提供,-1: 向前翻页,1：向后翻页 └ order_scene Number 必须 1 1全部订单 └ page_size Number 必须 1 单页订单量，1-100，上限100条 └ query_type Number 必须 1 1-维权发起时间，2-订单结算时间（正向订单），3-维权完成时间，4-订单创建时间，5-订单更新时间（注意：入参startTime小于2022年12月20日0点时，query_type只能为1、2、3；入参startTime大于等于2022年12月20日0点时，query_type可以为1、2、3、4、5) └ page_no Number 必须 0 查询页数 └ position_index String 可选 2222_334666 位点，除第一页之外，都需要传递；前端原样返回。 └ start_time String 必须 2022-12-23 12:28:22 开始时间 └ member_type Number 必须 1 1 表示2方，2表示3方，4表示不限 └ end_time String 必须 2022-12-23 13:28:22 结束时间

名称	类型	示例值	描述
data	OrderPage		返回数据
result PublisherRefundOrderDTO [] 真正的业务数据结构 └ refund_suit_id String 12345 维权编号，是当前订单发生维权退款的编号，非淘宝订单编号，如订单发生多次维权，则会产生多个维权编号 └ tb_trade_parent_id String 1707359271433894971 淘宝父订单编号(买家在淘宝后台显示的订单编号) └ tb_trade_id String 1707359271433894971 淘宝子订单编号 └ tb_trade_create_time String 2022-10-19 14:33:06 订单创建时间 └ earning_time String 2022-10-19 14:39:31 订单结算时间 └ tk_refund_time String 2022-10-19 14:41:22 维权创建时间 └ tk_refund_suit_time String 2022-10-19 14:42:29 维权完成时间 └ modified_time String 2022-10-20 03:26:23 订单更新时间 └ item_title String zf测试商品003商品，测试请不要拍商品标题 └ tk_order_role String 二方推广者角色(二方、三方) └ refund_status Number 2 维权创建(淘客结算回执) 4, 维权成功(淘客结算回执) 2, 维权失败(淘客结算回执) 3, 发生多次维权，待处理 11, 从淘客处补扣（钱已结给淘客）等待扣款 12, 从淘客处补扣（钱已结给淘客）扣款成功 13, 从卖家处补扣（钱已结给卖家）等待扣款 14, 从卖家处补扣（钱已结给卖家）扣款成功 15 └ tb_trade_finish_price String 5.00 结算金额(订单确认收货后的成交金额） └ refund_fee String 3.50 维权金额(买家申请维权退款的金额) └ pub_share_fee String 1.10 结算预估收入=结算金额*提成。以订单确认收货后的成交金额为基数，预估您可能获得的收入。 └ tk_commission_fee_refund String 0.71 应退还佣金(不含技术服务费和渠道专项服务费) └ tk_subsidy_fee_refund String 0 应退还补贴(不含技术服务费和渠道专项服务费) └ tk_commission_alimm_refund_fee String 0.06 应退还佣金对应的技术服务费 └ tk_subsidy_alimm_refund_fee String 0 应退还补贴对应的技术服务费 └ tk_commission_agent_refund_fee String 0 应退还佣金对应的渠道专项服务费 └ tk_subsidy_agent_refund_fee String 0 应退还补贴对应的渠道专项服务费 └ show_return_fee String 0.77 应退还预估收入：订单发生维权退款应退还的预估收入（佣金+补贴，含技术服务费和渠道专项服务费） └ relation_id Number 1111111 渠道关系id └ special_id Number 22222 会员关系id └ pre_page Number 1 上一页 └ next_page Number 1 下一页 └ page_no Number 1 页码 └ page_size Number 2 每页订单量 └ has_next Boolean false 是否有下一页 └ position_index String 1661386106_3nXt8TjdqT 位点 └ has_pre Boolean false 是否有上一页
result_code	Number	200	接口返回值信息，跟rpc架构保持一致
biz_error_desc	String	开始时间不能为空	业务错误信息
biz_error_code	Number	101	业务错误码 101, 102,103
result_msg	String	result	返回信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkOrderRefundGetRequest req = new TbkOrderRefundGetRequest();
TbkOrderRefundGetRequest.PublisherRefundOrderQueryOption obj1 = new TbkOrderRefundGetRequest.PublisherRefundOrderQueryOption();
obj1.setJumpType(1L);
obj1.setOrderScene(1L);
obj1.setPageSize(1L);
obj1.setQueryType(1L);
obj1.setPageNo(0L);
obj1.setPositionIndex("2222_334666");
obj1.setStartTime("2022-12-23 12:28:22");
obj1.setMemberType(1L);
obj1.setEndTime("2022-12-23 13:28:22");
req.setPublisherRefundOrderQueryOption(obj1);
TbkOrderRefundGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkOrderRefundGetRequest req = new TbkOrderRefundGetRequest();
TbkOrderRefundGetRequest.PublisherRefundOrderQueryOptionDomain obj1 = new TbkOrderRefundGetRequest.PublisherRefundOrderQueryOptionDomain();
obj1.JumpType = 1L;
obj1.OrderScene = 1L;
obj1.PageSize = 1L;
obj1.QueryType = 1L;
obj1.PageNo = 0L;
obj1.PositionIndex = "2222_334666";
obj1.StartTime = "2022-12-23 12:28:22";
obj1.MemberType = 1L;
obj1.EndTime = "2022-12-23 13:28:22";
req.PublisherRefundOrderQueryOption_ = obj1;
TbkOrderRefundGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkOrderRefundGetRequest;
$publisher_refund_order_query_option = new PublisherRefundOrderQueryOption;
$publisher_refund_order_query_option->jump_type="1";
$publisher_refund_order_query_option->order_scene="1";
$publisher_refund_order_query_option->page_size="1";
$publisher_refund_order_query_option->query_type="1";
$publisher_refund_order_query_option->page_no="0";
$publisher_refund_order_query_option->position_index="2222_334666";
$publisher_refund_order_query_option->start_time="2022-12-23 12:28:22";
$publisher_refund_order_query_option->member_type="1";
$publisher_refund_order_query_option->end_time="2022-12-23 13:28:22";
$req->setPublisherRefundOrderQueryOption(json_encode($publisher_refund_order_query_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.order.refund.get' \
-d 'partner_id=apidoc' \
-d 'sign=4BA5147A936CCDD4098B72D992A0F65E' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-08+10%3A02%3A16' \
-d 'v=2.0' \
-d 'publisher_refund_order_query_option=null'

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

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

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

XML示例
JSON示例

<tbk_order_refund_get_response>
    <data>
        <result>
            <publisher_refund_order_d_t_o>
                <refund_suit_id>12345</refund_suit_id>
                <tb_trade_parent_id>1707359271433894971</tb_trade_parent_id>
                <tb_trade_id>1707359271433894971</tb_trade_id>
                <tb_trade_create_time>2022-10-19 14:33:06</tb_trade_create_time>
                <earning_time>2022-10-19 14:39:31</earning_time>
                <tk_refund_time>2022-10-19 14:41:22</tk_refund_time>
                <tk_refund_suit_time>2022-10-19 14:42:29</tk_refund_suit_time>
                <modified_time>2022-10-20 03:26:23</modified_time>
                <item_title>zf测试商品003商品，测试请不要拍</item_title>
                <tk_order_role>二方</tk_order_role>
                <refund_status>2</refund_status>
                <tb_trade_finish_price>5.00</tb_trade_finish_price>
                <refund_fee>3.50</refund_fee>
                <pub_share_fee>1.10</pub_share_fee>
                <tk_commission_fee_refund>0.71</tk_commission_fee_refund>
                <tk_subsidy_fee_refund>0</tk_subsidy_fee_refund>
                <tk_commission_alimm_refund_fee>0.06</tk_commission_alimm_refund_fee>
                <tk_subsidy_alimm_refund_fee>0</tk_subsidy_alimm_refund_fee>
                <tk_commission_agent_refund_fee>0</tk_commission_agent_refund_fee>
                <tk_subsidy_agent_refund_fee>0</tk_subsidy_agent_refund_fee>
                <show_return_fee>0.77</show_return_fee>
                <relation_id>1111111</relation_id>
                <special_id>22222</special_id>
            </publisher_refund_order_d_t_o>
        </result>
        <pre_page>1</pre_page>
        <next_page>1</next_page>
        <page_no>1</page_no>
        <page_size>2</page_size>
        <has_next>false</has_next>
        <position_index>1661386106_3nXt8TjdqT</position_index>
        <has_pre>false</has_pre>
    </data>
    <result_code>200</result_code>
    <biz_error_desc>开始时间不能为空</biz_error_desc>
    <biz_error_code>101</biz_error_code>
    <result_msg>result</result_msg>
</tbk_order_refund_get_response>

{
    "tbk_order_refund_get_response":{
        "data":{
            "result":{
                "publisher_refund_order_d_t_o":[
                    {
                        "refund_suit_id":"12345",
                        "tb_trade_parent_id":"1707359271433894971",
                        "tb_trade_id":"1707359271433894971",
                        "tb_trade_create_time":"2022-10-19 14:33:06",
                        "earning_time":"2022-10-19 14:39:31",
                        "tk_refund_time":"2022-10-19 14:41:22",
                        "tk_refund_suit_time":"2022-10-19 14:42:29",
                        "modified_time":"2022-10-20 03:26:23",
                        "item_title":"zf测试商品003商品，测试请不要拍",
                        "tk_order_role":"二方",
                        "refund_status":2,
                        "tb_trade_finish_price":"5.00",
                        "refund_fee":"3.50",
                        "pub_share_fee":"1.10",
                        "tk_commission_fee_refund":"0.71",
                        "tk_subsidy_fee_refund":"0",
                        "tk_commission_alimm_refund_fee":"0.06",
                        "tk_subsidy_alimm_refund_fee":"0",
                        "tk_commission_agent_refund_fee":"0",
                        "tk_subsidy_agent_refund_fee":"0",
                        "show_return_fee":"0.77",
                        "relation_id":1111111,
                        "special_id":22222
                    }
                ]
            },
            "pre_page":1,
            "next_page":1,
            "page_no":1,
            "page_size":2,
            "has_next":false,
            "position_index":"1661386106_3nXt8TjdqT",
            "has_pre":false
        },
        "result_code":200,
        "biz_error_desc":"开始时间不能为空",
        "biz_error_code":101,
        "result_msg":"result"
    }
}

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

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ