淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
external_agree_return_goods_refund_order_request	ExternalAgreeReturnGoodsRefundOrderRequest	必须		默认值：request	请求
└ out_refund_no String 可选 erp_11111 erp退款单号 └ receiver_mobile_phone String 可选 15836963246 退货接收方手机号码 └ return_street_name String 可选东环街道退货接收方街道 └ receiver_full_name String 可选张三退货接收方姓名 └ refund_no String 必须 566399665656 渠道退款单号 └ return_city_name String 可选广州市退货接收方市 └ return_area_name String 可选番禺区退货接收方区 └ return_province_name String 可选广东省退货接收方省 └ return_detail_address String 可选东环街道番禺大道北番禺科技大楼1201 退货接收方详细地址

名称	类型	示例值	描述
trace_id	String	212ce8fc17762455287715000f2333	traceId
retriable	Boolean	false	retriable
biz_success	Boolean	success	是否业务成功
biz_error_message	String	退货地址不合法	错误信息
biz_error_code	String	return_address_illegal	错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAscpChannelRefundAgreeReturnGoodsRequest req = new AlibabaAscpChannelRefundAgreeReturnGoodsRequest();
AlibabaAscpChannelRefundAgreeReturnGoodsRequest.ExternalAgreeReturnGoodsRefundOrderRequest obj1 = new AlibabaAscpChannelRefundAgreeReturnGoodsRequest.ExternalAgreeReturnGoodsRefundOrderRequest();
obj1.setOutRefundNo("erp_11111");
obj1.setReceiverMobilePhone("15836963246");
obj1.setReturnStreetName("东环街道");
obj1.setReceiverFullName("张三");
obj1.setRefundNo("566399665656");
obj1.setReturnCityName("广州市");
obj1.setReturnAreaName("番禺区");
obj1.setReturnProvinceName("广东省");
obj1.setReturnDetailAddress("东环街道番禺大道北番禺科技大楼1201");
req.setExternalAgreeReturnGoodsRefundOrderRequest(obj1);
AlibabaAscpChannelRefundAgreeReturnGoodsResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAscpChannelRefundAgreeReturnGoodsRequest req = new AlibabaAscpChannelRefundAgreeReturnGoodsRequest();
AlibabaAscpChannelRefundAgreeReturnGoodsRequest.ExternalAgreeReturnGoodsRefundOrderRequestDomain obj1 = new AlibabaAscpChannelRefundAgreeReturnGoodsRequest.ExternalAgreeReturnGoodsRefundOrderRequestDomain();
obj1.OutRefundNo = "erp_11111";
obj1.ReceiverMobilePhone = "15836963246";
obj1.ReturnStreetName = "东环街道";
obj1.ReceiverFullName = "张三";
obj1.RefundNo = "566399665656";
obj1.ReturnCityName = "广州市";
obj1.ReturnAreaName = "番禺区";
obj1.ReturnProvinceName = "广东省";
obj1.ReturnDetailAddress = "东环街道番禺大道北番禺科技大楼1201";
req.ExternalAgreeReturnGoodsRefundOrderRequest_ = obj1;
AlibabaAscpChannelRefundAgreeReturnGoodsResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAscpChannelRefundAgreeReturnGoodsRequest;
$external_agree_return_goods_refund_order_request = new ExternalAgreeReturnGoodsRefundOrderRequest;
$external_agree_return_goods_refund_order_request->out_refund_no="erp_11111";
$external_agree_return_goods_refund_order_request->receiver_mobile_phone="15836963246";
$external_agree_return_goods_refund_order_request->return_street_name="东环街道";
$external_agree_return_goods_refund_order_request->receiver_full_name="张三";
$external_agree_return_goods_refund_order_request->refund_no="566399665656";
$external_agree_return_goods_refund_order_request->return_city_name="广州市";
$external_agree_return_goods_refund_order_request->return_area_name="番禺区";
$external_agree_return_goods_refund_order_request->return_province_name="广东省";
$external_agree_return_goods_refund_order_request->return_detail_address="东环街道番禺大道北番禺科技大楼1201";
$req->setExternalAgreeReturnGoodsRefundOrderRequest(json_encode($external_agree_return_goods_refund_order_request));
$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=alibaba.ascp.channel.refund.agree.return.goods' \
-d 'partner_id=apidoc' \
-d 'session=eac59968-1cd5-4085-a934-97c1c1cf3fbc' \
-d 'sign=35707291E11A1317D2697379F329F235' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-06-01+02%3A37%3A08' \
-d 'v=2.0' \
-d 'external_agree_return_goods_refund_order_request=null'

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

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

req.external_agree_return_goods_refund_order_request="数据结构示例JSON格式"
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,"alibaba.ascp.channel.refund.agree.return.goods");
add_param(pRequest,"external_agree_return_goods_refund_order_request","数据结构JSON示例");
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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.ascp.channel.refund.agree.return.goods', {
	'external_agree_return_goods_refund_order_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_ascp_channel_refund_agree_return_goods_response>
    <trace_id>212ce8fc17762455287715000f2333</trace_id>
    <retriable>false</retriable>
    <biz_success>success</biz_success>
    <biz_error_message>退货地址不合法</biz_error_message>
    <biz_error_code>return_address_illegal</biz_error_code>
</alibaba_ascp_channel_refund_agree_return_goods_response>

{
    "alibaba_ascp_channel_refund_agree_return_goods_response":{
        "trace_id":"212ce8fc17762455287715000f2333",
        "retriable":false,
        "biz_success":success,
        "biz_error_message":"退货地址不合法",
        "biz_error_code":"return_address_illegal"
    }
}

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

alibaba.ascp.channel.refund.agree.return.goods (渠道退款单同意退货)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ