淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
refund_order	YuNuoRefundDto	必须			销退单
└ refund_fee Number 必须 10000 退款金额 └ buyer_remark String 可选备注备注卖家备注 └ order_id String 必须 10000001 原订单id └ express_no String 可选 abc001 快递单号（退货时需要） └ refund_reason String 必须原因原因退款原因 └ channel String 必须 XXX 渠道 └ express_company_code String 可选 YTO 快递公司编码（退货时需要） └ type Number 必须 1 类型（1退款，2退货） └ apply_time Date 必须 2021-01-01 00:00:00 退款申请时间 items YuNuoRefundItemDto [] 必须商品明细 └ quantity Number 必须 1 数量 └ barcode String 必须 11111111 条码 └ item_key String 必须 22222222 商品id └ refund_id String 必须 100001 退款/退货 id

名称	类型	示例值	描述
result	JkResult		返回结果
└ success Boolean true 是否成功 └ error_code String ALREADY_REFUND 错误码 └ error_msg String 已退款错误原因

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthRetailRefundorderCreateRequest req = new AlibabaAlihealthRetailRefundorderCreateRequest();
AlibabaAlihealthRetailRefundorderCreateRequest.YuNuoRefundDto obj1 = new AlibabaAlihealthRetailRefundorderCreateRequest.YuNuoRefundDto();
obj1.setRefundFee(10000L);
obj1.setBuyerRemark("备注备注");
obj1.setOrderId("10000001");
obj1.setExpressNo("abc001");
obj1.setRefundReason("原因原因");
obj1.setChannel("XXX");
obj1.setExpressCompanyCode("YTO");
obj1.setType(1L);
obj1.setApplyTime(StringUtils.parseDateTime("2021-01-01 00:00:00"));
List<AlibabaAlihealthRetailRefundorderCreateRequest.YuNuoRefundItemDto> list3 = new ArrayList<AlibabaAlihealthRetailRefundorderCreateRequest.YuNuoRefundItemDto>();
AlibabaAlihealthRetailRefundorderCreateRequest.YuNuoRefundItemDto obj4 = new AlibabaAlihealthRetailRefundorderCreateRequest.YuNuoRefundItemDto();
list3.add(obj4);
obj4.setQuantity(1L);
obj4.setBarcode("11111111");
obj4.setItemKey("22222222");
obj1.setItems(list3);
obj1.setRefundId("100001");
req.setRefundOrder(obj1);
AlibabaAlihealthRetailRefundorderCreateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthRetailRefundorderCreateRequest req = new AlibabaAlihealthRetailRefundorderCreateRequest();
AlibabaAlihealthRetailRefundorderCreateRequest.YuNuoRefundDtoDomain obj1 = new AlibabaAlihealthRetailRefundorderCreateRequest.YuNuoRefundDtoDomain();
obj1.RefundFee = 10000L;
obj1.BuyerRemark = "备注备注";
obj1.OrderId = "10000001";
obj1.ExpressNo = "abc001";
obj1.RefundReason = "原因原因";
obj1.Channel = "XXX";
obj1.ExpressCompanyCode = "YTO";
obj1.Type = 1L;
obj1.ApplyTime = DateTime.Parse(2021-01-01 00:00:00");
List<AlibabaAlihealthRetailRefundorderCreateRequest.YuNuoRefundItemDtoDomain> list3 = new List<AlibabaAlihealthRetailRefundorderCreateRequest.YuNuoRefundItemDtoDomain>();
AlibabaAlihealthRetailRefundorderCreateRequest.YuNuoRefundItemDtoDomain obj4 = new AlibabaAlihealthRetailRefundorderCreateRequest.YuNuoRefundItemDtoDomain();
list3.Add(obj4);
obj4.Quantity = 1L;
obj4.Barcode = "11111111";
obj4.ItemKey = "22222222";
obj1.Items= list3;
obj1.RefundId = "100001";
req.RefundOrder_ = obj1;
AlibabaAlihealthRetailRefundorderCreateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthRetailRefundorderCreateRequest;
$refund_order = new YuNuoRefundDto;
$refund_order->refund_fee="10000";
$refund_order->buyer_remark="备注备注";
$refund_order->order_id="10000001";
$refund_order->express_no="abc001";
$refund_order->refund_reason="原因原因";
$refund_order->channel="XXX";
$refund_order->express_company_code="YTO";
$refund_order->type="1";
$refund_order->apply_time="2021-01-01 00:00:00";
$items = new YuNuoRefundItemDto;
$items->quantity="1";
$items->barcode="11111111";
$items->item_key="22222222";
$refund_order->items = $items;
$refund_order->refund_id="100001";
$req->setRefundOrder(json_encode($refund_order));
$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=alibaba.alihealth.retail.refundorder.create' \
-d 'partner_id=apidoc' \
-d 'sign=28DF3852C992A29C43321E43C155AD8E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-24+15%3A44%3A06' \
-d 'v=2.0' \
-d 'refund_order=null'

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

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

req.refund_order=""
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,"alibaba.alihealth.retail.refundorder.create");
add_param(pRequest,"refund_order","数据结构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('alibaba.alihealth.retail.refundorder.create', {
	'refund_order':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_retail_refundorder_create_response>
    <result>
        <success>true</success>
        <error_code>ALREADY_REFUND</error_code>
        <error_msg>已退款</error_msg>
    </result>
</alibaba_alihealth_retail_refundorder_create_response>

{
    "alibaba_alihealth_retail_refundorder_create_response":{
        "result":{
            "success":true,
            "error_code":"ALREADY_REFUND",
            "error_msg":"已退款"
        }
    }
}

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.alihealth.retail.refundorder.create (阿里健康门店销退单创建)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ