淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
req	ReturnSalesDto	可选			请求对象
└ exp_earliest_pickup_time String 可选 2018-01-31 12:00:00 期望取货最早时间 └ pickup_addr_lon_lat String 可选 lon,lat 取货地址经纬度 └ exp_latest_rcv_time String 可选 2018-01-31 12:00:00 期望收货最晚时间 └ memo String 可选备注备注 └ refund_order_amount Number 可选 100 退款金额（分） └ pickup_addr_detail String 可选 xxx单xxx号取货地址不能为空 └ exp_latest_pickup_time String 可选 2018-01-31 12:00:00 期望取货最晚时间不能为空 └ pickup_contact_name String 可选某某取货联系人不能为空 └ logistics_order_no String 可选 11111 物流单号不能为空 └ pay_time String 可选 2018-01-31 12:00:00 支付时间不能为空 └ rcv_lon_lat String 可选 lon,lat 收货经纬度不能为空 └ refund_time String 可选 2018-01-31 12:00:00 退款时间不能为空 └ pickup_contact_phone String 可选 1561164xxxx 取货联系人电话不能为空 └ rcv_addr_type Number 可选 1 收货地址类型 1配送站，2仓，3门店 returned_container_dto_list ReturnedContainerDto [] 可选包裹列表 └ container_code String 可选 xxx0001 编号 └ container_type Number 可选 0 包裹类型(不可空) 0:配送箱 1:马夹袋 └ order_amount Number 可选 100 订单金额（分） └ rcv_contact_phone String 可选 15610000 收货人联系电话 └ partnerid String 可选 FN 系统分配的身份标示 └ pickup_addr_poi_name String 可选阿里巴巴西溪园区取货地址Poi名称 └ custom_service String 可选定制服务定制服务 {会员服务: Y, 加急处理: Y, 贵重物品处理:Y, 需要处理冷藏:Y, 需要处理易碎:Y} └ sales_channel String 可选 1 销售渠道 └ collect_amount Number 可选 1000 商家实收金额不能为空 returned_sales_item_d_o_list ReturnedItemSalesDto [] 可选退货商品列表 └ item_spec String 可选 12g/袋规格 └ item_group_id String 可选 1 商品组id,通一组的商品组ID 相同 └ item_delivery_qty String 可选 1 取货数量 └ item_short_name String 可选商品简称商品简称不能为空 └ item_full_name String 可选商品全称商品全称不能为空 └ item_sales_qty String 可选 1 销售数量 └ item_price String 可选 100 价格（分） └ item_weight String 可选 10 重量(g) └ item_volume String 可选 100 体积（ml） └ item_label String 可选熟商品标签 └ item_sales_unit String 可选公斤单位 └ item_bar_code String 可选 1212234 二维码 └ item_desc String 可选描述描述 └ item_pic_url String 可选 http://xx.jpeg 商品图片 └ item_code String 可选 122345 商品编号 └ sub_logistics_order_no String 可选 1 物流子订单号 └ sub_refund_no String 可选退款单号退款单号 └ trade_order_no String 可选 1 交易单号 └ exp_earliest_rcv_time String 可选 2018-01-31 12:00:00 期望收货最早时间 └ merchant_id String 可选 1 商家ID └ order_time String 可选 2018-01-31 12:00:00 下单时间 └ rcv_contact_name String 可选某某收货联系人 └ refund_order_no String 可选 1 退款单号 └ pickup_addr_code String 可选 1 取货地址编码 └ trans_id String 可选 uuid 接口请求ID └ service_code String 可选 1 服务编码 0: （当日取）及时取；1: 次日取 └ actual_amount Number 可选 12 实付金额 └ rcv_addr_detail String 可选 xx 楼 xx 单元收货地址 └ rcv_addr_code String 可选 1 收货地点代码

名称	类型	示例值	描述
result	Result		result
resp_detail ReturnedAcceptRespDto respDetail └ pickup_order_no String 123435 pickupOrderNO └ error_code String "isv.invalid-parameter" errorCode └ error_msg String "参数错误" errorMsg └ is_success Boolean true isSuccess

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkTmsOrderSalesreturnAckRequest req = new AlibabaWdkTmsOrderSalesreturnAckRequest();
AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnSalesDto obj1 = new AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnSalesDto();
obj1.setExpEarliestPickupTime("2018-01-31 12:00:00");
obj1.setPickupAddrLonLat("lon,lat");
obj1.setExpLatestRcvTime("2018-01-31 12:00:00");
obj1.setMemo("备注");
obj1.setRefundOrderAmount(100L);
obj1.setPickupAddrDetail("xxx单xxx号");
obj1.setExpLatestPickupTime("2018-01-31 12:00:00");
obj1.setPickupContactName("某某");
obj1.setLogisticsOrderNo("11111");
obj1.setPayTime("2018-01-31 12:00:00");
obj1.setRcvLonLat("lon,lat");
obj1.setRefundTime("2018-01-31 12:00:00");
obj1.setPickupContactPhone("1561164xxxx");
obj1.setRcvAddrType(1L);
List<AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedContainerDto> list3 = new ArrayList<AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedContainerDto>();
AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedContainerDto obj4 = new AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedContainerDto();
list3.add(obj4);
obj4.setContainerCode("xxx0001");
obj4.setContainerType(0L);
obj1.setReturnedContainerDtoList(list3);
obj1.setOrderAmount(100L);
obj1.setRcvContactPhone("15610000");
obj1.setPartnerid("FN");
obj1.setPickupAddrPoiName("阿里巴巴西溪园区");
obj1.setCustomService("定制服务");
obj1.setSalesChannel("1");
obj1.setCollectAmount(1000L);
List<AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedItemSalesDto> list6 = new ArrayList<AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedItemSalesDto>();
AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedItemSalesDto obj7 = new AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedItemSalesDto();
list6.add(obj7);
obj7.setItemSpec("12g/袋");
obj7.setItemGroupId("1");
obj7.setItemDeliveryQty("1");
obj7.setItemShortName("商品简称");
obj7.setItemFullName("商品全称");
obj7.setItemSalesQty("1");
obj7.setItemPrice("100");
obj7.setItemWeight("10");
obj7.setItemVolume("100");
obj7.setItemLabel("熟");
obj7.setItemSalesUnit("公斤");
obj7.setItemBarCode("1212234");
obj7.setItemDesc("描述");
obj7.setItemPicUrl("http://xx.jpeg");
obj7.setItemCode("122345");
obj7.setSubLogisticsOrderNo("1");
obj7.setSubRefundNo("退款单号");
obj1.setReturnedSalesItemDOList(list6);
obj1.setTradeOrderNo("1");
obj1.setExpEarliestRcvTime("2018-01-31 12:00:00");
obj1.setMerchantId("1");
obj1.setOrderTime("2018-01-31 12:00:00");
obj1.setRcvContactName("某某");
obj1.setRefundOrderNo("1");
obj1.setPickupAddrCode("1");
obj1.setTransId("uuid");
obj1.setServiceCode("1");
obj1.setActualAmount(12L);
obj1.setRcvAddrDetail("xx 楼 xx 单元");
obj1.setRcvAddrCode("1");
req.setReq(obj1);
AlibabaWdkTmsOrderSalesreturnAckResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkTmsOrderSalesreturnAckRequest req = new AlibabaWdkTmsOrderSalesreturnAckRequest();
AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnSalesDtoDomain obj1 = new AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnSalesDtoDomain();
obj1.ExpEarliestPickupTime = "2018-01-31 12:00:00";
obj1.PickupAddrLonLat = "lon,lat";
obj1.ExpLatestRcvTime = "2018-01-31 12:00:00";
obj1.Memo = "备注";
obj1.RefundOrderAmount = 100L;
obj1.PickupAddrDetail = "xxx单xxx号";
obj1.ExpLatestPickupTime = "2018-01-31 12:00:00";
obj1.PickupContactName = "某某";
obj1.LogisticsOrderNo = "11111";
obj1.PayTime = "2018-01-31 12:00:00";
obj1.RcvLonLat = "lon,lat";
obj1.RefundTime = "2018-01-31 12:00:00";
obj1.PickupContactPhone = "1561164xxxx";
obj1.RcvAddrType = 1L;
List<AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedContainerDtoDomain> list3 = new List<AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedContainerDtoDomain>();
AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedContainerDtoDomain obj4 = new AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedContainerDtoDomain();
list3.Add(obj4);
obj4.ContainerCode = "xxx0001";
obj4.ContainerType = 0L;
obj1.ReturnedContainerDtoList= list3;
obj1.OrderAmount = 100L;
obj1.RcvContactPhone = "15610000";
obj1.Partnerid = "FN";
obj1.PickupAddrPoiName = "阿里巴巴西溪园区";
obj1.CustomService = "定制服务";
obj1.SalesChannel = "1";
obj1.CollectAmount = 1000L;
List<AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedItemSalesDtoDomain> list6 = new List<AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedItemSalesDtoDomain>();
AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedItemSalesDtoDomain obj7 = new AlibabaWdkTmsOrderSalesreturnAckRequest.ReturnedItemSalesDtoDomain();
list6.Add(obj7);
obj7.ItemSpec = "12g/袋";
obj7.ItemGroupId = "1";
obj7.ItemDeliveryQty = "1";
obj7.ItemShortName = "商品简称";
obj7.ItemFullName = "商品全称";
obj7.ItemSalesQty = "1";
obj7.ItemPrice = "100";
obj7.ItemWeight = "10";
obj7.ItemVolume = "100";
obj7.ItemLabel = "熟";
obj7.ItemSalesUnit = "公斤";
obj7.ItemBarCode = "1212234";
obj7.ItemDesc = "描述";
obj7.ItemPicUrl = "http://xx.jpeg";
obj7.ItemCode = "122345";
obj7.SubLogisticsOrderNo = "1";
obj7.SubRefundNo = "退款单号";
obj1.ReturnedSalesItemDOList= list6;
obj1.TradeOrderNo = "1";
obj1.ExpEarliestRcvTime = "2018-01-31 12:00:00";
obj1.MerchantId = "1";
obj1.OrderTime = "2018-01-31 12:00:00";
obj1.RcvContactName = "某某";
obj1.RefundOrderNo = "1";
obj1.PickupAddrCode = "1";
obj1.TransId = "uuid";
obj1.ServiceCode = "1";
obj1.ActualAmount = 12L;
obj1.RcvAddrDetail = "xx 楼 xx 单元";
obj1.RcvAddrCode = "1";
req.Req_ = obj1;
AlibabaWdkTmsOrderSalesreturnAckResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkTmsOrderSalesreturnAckRequest;
$req = new ReturnSalesDto;
$req->exp_earliest_pickup_time="2018-01-31 12:00:00";
$req->pickup_addr_lon_lat="lon,lat";
$req->exp_latest_rcv_time="2018-01-31 12:00:00";
$req->memo="备注";
$req->refund_order_amount="100";
$req->pickup_addr_detail="xxx单xxx号";
$req->exp_latest_pickup_time="2018-01-31 12:00:00";
$req->pickup_contact_name="某某";
$req->logistics_order_no="11111";
$req->pay_time="2018-01-31 12:00:00";
$req->rcv_lon_lat="lon,lat";
$req->refund_time="2018-01-31 12:00:00";
$req->pickup_contact_phone="1561164xxxx";
$req->rcv_addr_type="1";
$returned_container_dto_list = new ReturnedContainerDto;
$returned_container_dto_list->container_code="xxx0001";
$returned_container_dto_list->container_type="0";
$req->setReturnedContainerDtoList(json_encode($returned_container_dto_list));
$req->order_amount="100";
$req->rcv_contact_phone="15610000";
$req->partnerid="FN";
$req->pickup_addr_poi_name="阿里巴巴西溪园区";
$req->custom_service="定制服务";
$req->sales_channel="1";
$req->collect_amount="1000";
$returned_sales_item_d_o_list = new ReturnedItemSalesDto;
$returned_sales_item_d_o_list->item_spec="12g/袋";
$returned_sales_item_d_o_list->item_group_id="1";
$returned_sales_item_d_o_list->item_delivery_qty="1";
$returned_sales_item_d_o_list->item_short_name="商品简称";
$returned_sales_item_d_o_list->item_full_name="商品全称";
$returned_sales_item_d_o_list->item_sales_qty="1";
$returned_sales_item_d_o_list->item_price="100";
$returned_sales_item_d_o_list->item_weight="10";
$returned_sales_item_d_o_list->item_volume="100";
$returned_sales_item_d_o_list->item_label="熟";
$returned_sales_item_d_o_list->item_sales_unit="公斤";
$returned_sales_item_d_o_list->item_bar_code="1212234";
$returned_sales_item_d_o_list->item_desc="描述";
$returned_sales_item_d_o_list->item_pic_url="http://xx.jpeg";
$returned_sales_item_d_o_list->item_code="122345";
$returned_sales_item_d_o_list->sub_logistics_order_no="1";
$returned_sales_item_d_o_list->sub_refund_no="退款单号";
$req->setReturnedSalesItemDOList(json_encode($returned_sales_item_d_o_list));
$req->trade_order_no="1";
$req->exp_earliest_rcv_time="2018-01-31 12:00:00";
$req->merchant_id="1";
$req->order_time="2018-01-31 12:00:00";
$req->rcv_contact_name="某某";
$req->refund_order_no="1";
$req->pickup_addr_code="1";
$req->trans_id="uuid";
$req->service_code="1";
$req->actual_amount="12";
$req->rcv_addr_detail="xx 楼 xx 单元";
$req->rcv_addr_code="1";
$req->setReq(json_encode($req));
$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.tms.order.salesreturn.ack' \
-d 'partner_id=apidoc' \
-d 'session=303e45ee-9589-43da-b08f-7931a6a08f7f' \
-d 'sign=CA7E0CE666B3E3DFAD84EDE5014F04AF' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+14%3A52%3A54' \
-d 'v=2.0' \
-d 'req=null'

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

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

req.req=""
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.tms.order.salesreturn.ack");
add_param(pRequest,"req","数据结构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.tms.order.salesreturn.ack', {
	'req':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_wdk_tms_order_salesreturn_ack_response>
    <result>
        <resp_detail>
            <pickup_order_no>123435</pickup_order_no>
        </resp_detail>
        <error_code>&quot;isv.invalid-parameter&quot;</error_code>
        <error_msg>&quot;参数错误&quot;</error_msg>
        <is_success>true</is_success>
    </result>
</alibaba_wdk_tms_order_salesreturn_ack_response>

{
    "alibaba_wdk_tms_order_salesreturn_ack_response":{
        "result":{
            "resp_detail":{
                "pickup_order_no":"123435"
            },
            "error_code":"\"isv.invalid-parameter\"",
            "error_msg":"\"参数错误\"",
            "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

alibaba.wdk.tms.order.salesreturn.ack (退货订单下单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ