淘宝开放平台 - 文档中心

请求地址：

环境	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_order_id	Number	必须	123	需要修改退款的子采购单id
is_return_goods	Boolean	必须	true	是否退货，只有子采购单发货后，才能申请退货
return_fee	Number	必须	230	需要退款的金额
refund_reason_id	Number	必须	1	发货前： 1、缺货，2、拍错商品，3、商品缺少所需样式，4、协商一致退款，5、未及时发货，0、其它发货后：经销： 1、商品质量问题，2、收到的商品不符，3、协商一致退款，4、一直未收到货，5、退还多付邮费，6、折扣、赠品、发票等问题，0、其它代销： 1、商品质量问题，2、收到的商品不符，3、协商一致退款，4、买家一直未收到货，5、退还多付邮费，6、折扣、赠品、发票等问题，0、其它
refund_desc	String	必须	退款说明	退款说明

名称	类型	示例值	描述
is_success	Boolean	true	退款是否修改成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
FenxiaoRefundUpdateRequest req = new FenxiaoRefundUpdateRequest();
req.setSubOrderId(123L);
req.setIsReturnGoods(true);
req.setReturnFee(230L);
req.setRefundReasonId(1L);
req.setRefundDesc("退款说明");
FenxiaoRefundUpdateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
FenxiaoRefundUpdateRequest req = new FenxiaoRefundUpdateRequest();
req.SubOrderId = 123L;
req.IsReturnGoods = true;
req.ReturnFee = 230L;
req.RefundReasonId = 1L;
req.RefundDesc = "退款说明";
FenxiaoRefundUpdateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new FenxiaoRefundUpdateRequest;
$req->setSubOrderId("123");
$req->setIsReturnGoods("true");
$req->setReturnFee("230");
$req->setRefundReasonId("1");
$req->setRefundDesc("退款说明");
$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.fenxiao.refund.update' \
-d 'partner_id=apidoc' \
-d 'session=da4f1566-48c4-4504-b96a-ace6378ba49d' \
-d 'sign=8EDBD2A6B4FAC3DE1ED1C86E171E9F17' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+18%3A03%3A32' \
-d 'v=2.0' \
-d 'is_return_goods=true' \
-d 'refund_desc=%E9%80%80%E6%AC%BE%E8%AF%B4%E6%98%8E' \
-d 'refund_reason_id=1' \
-d 'return_fee=230' \
-d 'sub_order_id=123'

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

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

req.sub_order_id=123
req.is_return_goods=true
req.return_fee=230
req.refund_reason_id=1
req.refund_desc="退款说明"
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.fenxiao.refund.update");
add_param(pRequest,"sub_order_id","123");
add_param(pRequest,"is_return_goods","true");
add_param(pRequest,"return_fee","230");
add_param(pRequest,"refund_reason_id","1");
add_param(pRequest,"refund_desc","退款说明");
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.fenxiao.refund.update', {
	'sub_order_id':'123',
	'is_return_goods':'true',
	'return_fee':'230',
	'refund_reason_id':'1',
	'refund_desc':'退款说明'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<fenxiao_refund_update_response>
    <is_success>true</is_success>
</fenxiao_refund_update_response>

{
    "fenxiao_refund_update_response":{
        "is_success":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"
	}
}

错误码	错误描述	解决方案

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

开放平台

分销API

taobao.fenxiao.refund.update (修改退款协议)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ