淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
sub_biz_order_id	Number	可选	88888888	TP子单id
dispute_id	Number	可选	88888888	RP单id
refund_order_id	Number	可选	88888888	退款单id
settlement_no	String	可选	88888888	结算单号
created_begin	Date	可选	2025-01-01 00:00:00	创建时间开始
created_end	Date	可选	2025-01-01 00:00:00	创建时间结束

名称	类型	示例值	描述
data	TopRefundOrderDTO []		结果列表
└ created Date 2020-01-01 22:22:22 创建时间 └ modified Date 2020-01-01 22:22:22 修改时间 └ biz_order_id Number 88888888 TP主单id └ sub_biz_order_id Number 88888888 TP子单id └ dispute_id Number 88888888 RP单id └ sales_order_id Number 88888888 销售单id └ refund_order_id Number 88888888 退款单id └ status Number 10:创建 100:成功 200:关闭退款单状态 └ supplier_id Number 88888888 供应商淘宝id └ distributor_id Number 88888888 分销商淘宝id └ item_id Number 88888888 商品id └ item_outer_id Number 88888888 商品商家编码 └ item_title String abababab 商品标题 └ sku_id Number 88888888 SKU id └ sku_outer_id String abababab SKU 商家编码 └ refund_amount Number 12345678 退款件数 └ dispute_refund_fee Number 12345678 RP退款金额(单位:分) └ refund_fee Number 12345678 销售单退款金额(单位:分) └ settlement_no String abababab 结算单号 └ invoice_bill_no String abababab 开票单号 └ seller_id Number 88888888 店铺卖家id features FeatureDTO [] 扩展字段集合 └ attr_key String key key └ attr_value String value value
page_size	Number	20	分页大小
current_page	Number	1	当前页
total_count	Number	100	总记录数
error_desc	String	error	错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
GongxiaoRefundGetRequest req = new GongxiaoRefundGetRequest();
req.setSubBizOrderId(88888888L);
req.setDisputeId(88888888L);
req.setRefundOrderId(88888888L);
req.setSettlementNo("88888888");
req.setCreatedBegin(StringUtils.parseDateTime("2025-01-01 00:00:00"));
req.setCreatedEnd(StringUtils.parseDateTime("2025-01-01 00:00:00"));
GongxiaoRefundGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
GongxiaoRefundGetRequest req = new GongxiaoRefundGetRequest();
req.SubBizOrderId = 88888888L;
req.DisputeId = 88888888L;
req.RefundOrderId = 88888888L;
req.SettlementNo = "88888888";
req.CreatedBegin = DateTime.Parse("2025-01-01 00:00:00");
req.CreatedEnd = DateTime.Parse("2025-01-01 00:00:00");
GongxiaoRefundGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new GongxiaoRefundGetRequest;
$req->setSubBizOrderId("88888888");
$req->setDisputeId("88888888");
$req->setRefundOrderId("88888888");
$req->setSettlementNo("88888888");
$req->setCreatedBegin("2025-01-01 00:00:00");
$req->setCreatedEnd("2025-01-01 00:00:00");
$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.gongxiao.refund.get' \
-d 'partner_id=apidoc' \
-d 'session=db6d9893-c30e-4a5a-9a57-0e41fcb90fa3' \
-d 'sign=94E526AF12F2A9F472869D8572317EBA' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+17%3A57%3A04' \
-d 'v=2.0' \
-d 'created_begin=2025-01-01+00%3A00%3A00' \
-d 'created_end=2025-01-01+00%3A00%3A00' \
-d 'dispute_id=88888888' \
-d 'refund_order_id=88888888' \
-d 'settlement_no=88888888' \
-d 'sub_biz_order_id=88888888'

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

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

req.sub_biz_order_id=88888888
req.dispute_id=88888888
req.refund_order_id=88888888
req.settlement_no="88888888"
req.created_begin="2025-01-01 00:00:00"
req.created_end="2025-01-01 00:00:00"
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.gongxiao.refund.get");
add_param(pRequest,"sub_biz_order_id","88888888");
add_param(pRequest,"dispute_id","88888888");
add_param(pRequest,"refund_order_id","88888888");
add_param(pRequest,"settlement_no","88888888");
add_param(pRequest,"created_begin","2025-01-01 00:00:00");
add_param(pRequest,"created_end","2025-01-01 00:00:00");
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.gongxiao.refund.get', {
	'sub_biz_order_id':'88888888',
	'dispute_id':'88888888',
	'refund_order_id':'88888888',
	'settlement_no':'88888888',
	'created_begin':'2025-01-01 00:00:00',
	'created_end':'2025-01-01 00:00:00'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<gongxiao_refund_get_response>
    <data>
        <top_refund_order_d_t_o>
            <created>2020-01-01 22:22:22</created>
            <modified>2020-01-01 22:22:22</modified>
            <biz_order_id>88888888</biz_order_id>
            <sub_biz_order_id>88888888</sub_biz_order_id>
            <dispute_id>88888888</dispute_id>
            <sales_order_id>88888888</sales_order_id>
            <refund_order_id>88888888</refund_order_id>
            <status>10:创建 100:成功 200:关闭</status>
            <supplier_id>88888888</supplier_id>
            <distributor_id>88888888</distributor_id>
            <item_id>88888888</item_id>
            <item_outer_id>88888888</item_outer_id>
            <item_title>abababab</item_title>
            <sku_id>88888888</sku_id>
            <sku_outer_id>abababab</sku_outer_id>
            <refund_amount>12345678</refund_amount>
            <dispute_refund_fee>12345678</dispute_refund_fee>
            <refund_fee>12345678</refund_fee>
            <settlement_no>abababab</settlement_no>
            <invoice_bill_no>abababab</invoice_bill_no>
            <seller_id>88888888</seller_id>
            <features>
                <feature_d_t_o>
                    <attr_key>key</attr_key>
                    <attr_value>value</attr_value>
                </feature_d_t_o>
            </features>
        </top_refund_order_d_t_o>
    </data>
    <page_size>20</page_size>
    <current_page>1</current_page>
    <total_count>100</total_count>
    <error_desc>error</error_desc>
</gongxiao_refund_get_response>

{
    "gongxiao_refund_get_response":{
        "data":{
            "top_refund_order_d_t_o":[
                {
                    "created":"\t 2020-01-01 22:22:22",
                    "modified":"\t 2020-01-01 22:22:22",
                    "biz_order_id":88888888,
                    "sub_biz_order_id":88888888,
                    "dispute_id":88888888,
                    "sales_order_id":88888888,
                    "refund_order_id":88888888,
                    "status":10:创建 100:成功 200:关闭,
                    "supplier_id":88888888,
                    "distributor_id":88888888,
                    "item_id":88888888,
                    "item_outer_id":88888888,
                    "item_title":"abababab",
                    "sku_id":88888888,
                    "sku_outer_id":"abababab",
                    "refund_amount":12345678,
                    "dispute_refund_fee":12345678,
                    "refund_fee":12345678,
                    "settlement_no":"abababab",
                    "invoice_bill_no":"abababab",
                    "seller_id":88888888,
                    "features":{
                        "feature_d_t_o":[
                            {
                                "attr_key":"key",
                                "attr_value":"value"
                            }
                        ]
                    }
                }
            ]
        },
        "page_size":20,
        "current_page":1,
        "total_count":100,
        "error_desc":"error"
    }
}

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.gongxiao.refund.get (供销平台退款单列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ