淘宝开放平台

请求地址：

环境	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_goods_create_request	RefundGoodsCreateRequest	可选			退货请求
refund_goods_sub_orders RefundGoodsSubOrder [] 可选退货商品列表 └ sub_biz_order_id String 必须 55418859311842 退货商品子订单号 └ goods_amount String 必须 5 退货件数 └ fulfill_amount String 必须 5 取货件数 └ sku_code String 可选 3445938631100 商品skucode └ refund_fee Number 可选 23 退款金额 └ fulfill_end_time Date 可选 2018-04-25 19:00:00 期待取货结束时间 └ fulfill_start_time Date 可选 2018-04-25 10:00:00 期待取货开始时间 └ weight_item Boolean 必须 true 是否称重 └ gift Boolean 必须 false 是否赠品 └ left_warehouse Boolean 可选 false 是否离开货架 └ refund_id String 可选 29933 退款单id └ sub_biz_order_id String 必须 55418859311842 子订单号，默认传商品列表的第一个子订单号 └ shop_id String 必须 10021 门店标识 └ refund_fetch_type String 必须 FETCH_HOME 取货类型（"FETCH_HOME"：上门；"ON_SHOP"：到店；"NONE"：无需取） └ main_biz_order_id String 必须 55418859311842 主订单号 └ buyer_id String 必须 102123 买家标识 └ buyer_name String 可选陈伟霆买家姓名 └ buyer_phone String 可选 17889893333 买家联系方式 └ buyer_address String 可选杭州市文一路买家地址 └ operator String 可选欧尚小二操作人 └ operator_memo String 可选退货原因小二备注 └ init_from Number 可选 19 渠道来源，欧尚外卖默认是19

名称	类型	示例值	描述
result	RefundGoodsCreateResult		返回结果
└ refund_goods_id String 80001974411842 退货单id └ success Boolean true 是否创建成功 └ error_code String ILLEGAL_PARAMETERS 错误码 └ error_msg String 请求参数非法错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkTradeRefundCreateRequest req = new AlibabaWdkTradeRefundCreateRequest();
AlibabaWdkTradeRefundCreateRequest.RefundGoodsCreateRequest obj1 = new AlibabaWdkTradeRefundCreateRequest.RefundGoodsCreateRequest();
List<AlibabaWdkTradeRefundCreateRequest.RefundGoodsSubOrder> list3 = new ArrayList<AlibabaWdkTradeRefundCreateRequest.RefundGoodsSubOrder>();
AlibabaWdkTradeRefundCreateRequest.RefundGoodsSubOrder obj4 = new AlibabaWdkTradeRefundCreateRequest.RefundGoodsSubOrder();
list3.add(obj4);
obj4.setSubBizOrderId("55418859311842");
obj4.setGoodsAmount("5");
obj4.setFulfillAmount("5");
obj4.setSkuCode("3445938631100");
obj4.setRefundFee(23L);
obj4.setFulfillEndTime(StringUtils.parseDateTime("2018-04-25 19:00:00"));
obj4.setFulfillStartTime(StringUtils.parseDateTime("2018-04-25 10:00:00"));
obj4.setWeightItem(true);
obj4.setGift(false);
obj4.setLeftWarehouse(false);
obj4.setRefundId("29933");
obj1.setRefundGoodsSubOrders(list3);
obj1.setSubBizOrderId("55418859311842");
obj1.setShopId("10021");
obj1.setRefundFetchType("FETCH_HOME");
obj1.setMainBizOrderId("55418859311842");
obj1.setBuyerId("102123");
obj1.setBuyerName("陈伟霆");
obj1.setBuyerPhone("17889893333");
obj1.setBuyerAddress("杭州市文一路");
obj1.setOperator("欧尚小二");
obj1.setOperatorMemo("退货原因");
obj1.setInitFrom(19L);
req.setRefundGoodsCreateRequest(obj1);
AlibabaWdkTradeRefundCreateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkTradeRefundCreateRequest req = new AlibabaWdkTradeRefundCreateRequest();
AlibabaWdkTradeRefundCreateRequest.RefundGoodsCreateRequestDomain obj1 = new AlibabaWdkTradeRefundCreateRequest.RefundGoodsCreateRequestDomain();
List<AlibabaWdkTradeRefundCreateRequest.RefundGoodsSubOrderDomain> list3 = new List<AlibabaWdkTradeRefundCreateRequest.RefundGoodsSubOrderDomain>();
AlibabaWdkTradeRefundCreateRequest.RefundGoodsSubOrderDomain obj4 = new AlibabaWdkTradeRefundCreateRequest.RefundGoodsSubOrderDomain();
list3.Add(obj4);
obj4.SubBizOrderId = "55418859311842";
obj4.GoodsAmount = "5";
obj4.FulfillAmount = "5";
obj4.SkuCode = "3445938631100";
obj4.RefundFee = 23L;
obj4.FulfillEndTime = DateTime.Parse(2018-04-25 19:00:00");
obj4.FulfillStartTime = DateTime.Parse(2018-04-25 10:00:00");
obj4.WeightItem = true;
obj4.Gift = false;
obj4.LeftWarehouse = false;
obj4.RefundId = "29933";
obj1.RefundGoodsSubOrders= list3;
obj1.SubBizOrderId = "55418859311842";
obj1.ShopId = "10021";
obj1.RefundFetchType = "FETCH_HOME";
obj1.MainBizOrderId = "55418859311842";
obj1.BuyerId = "102123";
obj1.BuyerName = "陈伟霆";
obj1.BuyerPhone = "17889893333";
obj1.BuyerAddress = "杭州市文一路";
obj1.Operator = "欧尚小二";
obj1.OperatorMemo = "退货原因";
obj1.InitFrom = 19L;
req.RefundGoodsCreateRequest_ = obj1;
AlibabaWdkTradeRefundCreateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkTradeRefundCreateRequest;
$refund_goods_create_request = new RefundGoodsCreateRequest;
$refund_goods_sub_orders = new RefundGoodsSubOrder;
$refund_goods_sub_orders->sub_biz_order_id="55418859311842";
$refund_goods_sub_orders->goods_amount="5";
$refund_goods_sub_orders->fulfill_amount="5";
$refund_goods_sub_orders->sku_code="3445938631100";
$refund_goods_sub_orders->refund_fee="23";
$refund_goods_sub_orders->fulfill_end_time="2018-04-25 19:00:00";
$refund_goods_sub_orders->fulfill_start_time="2018-04-25 10:00:00";
$refund_goods_sub_orders->weight_item="true";
$refund_goods_sub_orders->gift="false";
$refund_goods_sub_orders->left_warehouse="false";
$refund_goods_sub_orders->refund_id="29933";
$refund_goods_create_request->refund_goods_sub_orders = $refund_goods_sub_orders;
$refund_goods_create_request->sub_biz_order_id="55418859311842";
$refund_goods_create_request->shop_id="10021";
$refund_goods_create_request->refund_fetch_type="FETCH_HOME";
$refund_goods_create_request->main_biz_order_id="55418859311842";
$refund_goods_create_request->buyer_id="102123";
$refund_goods_create_request->buyer_name="陈伟霆";
$refund_goods_create_request->buyer_phone="17889893333";
$refund_goods_create_request->buyer_address="杭州市文一路";
$refund_goods_create_request->operator="欧尚小二";
$refund_goods_create_request->operator_memo="退货原因";
$refund_goods_create_request->init_from="19";
$req->setRefundGoodsCreateRequest(json_encode($refund_goods_create_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.wdk.trade.refund.create' \
-d 'partner_id=apidoc' \
-d 'session=bde861a9-3d15-4ec7-b27c-06b20c5b5d79' \
-d 'sign=7009C883BD995D849F2C67A840329272' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+11%3A19%3A58' \
-d 'v=2.0' \
-d 'refund_goods_create_request=null'

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

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

req.refund_goods_create_request=""
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.wdk.trade.refund.create");
add_param(pRequest,"refund_goods_create_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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.wdk.trade.refund.create', {
	'refund_goods_create_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_wdk_trade_refund_create_response>
    <result>
        <refund_goods_id>80001974411842</refund_goods_id>
        <success>true</success>
        <error_code>ILLEGAL_PARAMETERS</error_code>
        <error_msg>请求参数非法</error_msg>
    </result>
</alibaba_wdk_trade_refund_create_response>

{
    "alibaba_wdk_trade_refund_create_response":{
        "result":{
            "refund_goods_id":"80001974411842",
            "success":true,
            "error_code":"ILLEGAL_PARAMETERS",
            "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.wdk.trade.refund.create (外部渠道逆向订单创建)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ