阿里安全开放平台-阿里聚安全

请求地址：

环境	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_logistics_order_nos	String	可选	1	子物流单号
item_codes	String	可选	sku 编码	sku 编码
partnerid	String	可选	FN	配送业务分配的ID
logistics_order_no	String	可选	运单编号	运单编号
pickup_order_no	String	可选	取货单号	取货单号

名称	类型	示例值	描述
resp_detail	String	""	respDetail
errorcode	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);
AlibabaWdkTmsOrderSalesreturnCancelRequest req = new AlibabaWdkTmsOrderSalesreturnCancelRequest();
req.setSubLogisticsOrderNos("1");
req.setItemCodes("sku 编码");
req.setPartnerid("FN");
req.setLogisticsOrderNo("运单编号");
req.setPickupOrderNo("取货单号");
AlibabaWdkTmsOrderSalesreturnCancelResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkTmsOrderSalesreturnCancelRequest req = new AlibabaWdkTmsOrderSalesreturnCancelRequest();
req.SubLogisticsOrderNos = "1";
req.ItemCodes = "sku 编码";
req.Partnerid = "FN";
req.LogisticsOrderNo = "运单编号";
req.PickupOrderNo = "取货单号";
AlibabaWdkTmsOrderSalesreturnCancelResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkTmsOrderSalesreturnCancelRequest;
$req->setSubLogisticsOrderNos("1");
$req->setItemCodes("sku 编码");
$req->setPartnerid("FN");
$req->setLogisticsOrderNo("运单编号");
$req->setPickupOrderNo("取货单号");
$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.cancel' \
-d 'partner_id=apidoc' \
-d 'session=a20927be-b98c-403a-b134-20fcde04f32a' \
-d 'sign=34D839010EBECB55795112ECA9256ED1' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+20%3A56%3A02' \
-d 'v=2.0' \
-d 'item_codes=sku+%E7%BC%96%E7%A0%81' \
-d 'logistics_order_no=%E8%BF%90%E5%8D%95%E7%BC%96%E5%8F%B7' \
-d 'partnerid=FN' \
-d 'pickup_order_no=%E5%8F%96%E8%B4%A7%E5%8D%95%E5%8F%B7' \
-d 'sub_logistics_order_nos=1'

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

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

req.sub_logistics_order_nos="1"
req.item_codes="sku 编码"
req.partnerid="FN"
req.logistics_order_no="运单编号"
req.pickup_order_no="取货单号"
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.cancel");
add_param(pRequest,"sub_logistics_order_nos","1");
add_param(pRequest,"item_codes","sku 编码");
add_param(pRequest,"partnerid","FN");
add_param(pRequest,"logistics_order_no","运单编号");
add_param(pRequest,"pickup_order_no","取货单号");
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.cancel', {
	'sub_logistics_order_nos':'1',
	'item_codes':'sku 编码',
	'partnerid':'FN',
	'logistics_order_no':'运单编号',
	'pickup_order_no':'取货单号'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_wdk_tms_order_salesreturn_cancel_response>
    <resp_detail>&quot;&quot;</resp_detail>
    <errorcode>&quot;isv.invalid-parameter&quot;</errorcode>
    <error_msg>&quot;参数错误&quot;</error_msg>
    <is_success>true</is_success>
</alibaba_wdk_tms_order_salesreturn_cancel_response>

{
    "alibaba_wdk_tms_order_salesreturn_cancel_response":{
        "resp_detail":"\"\"",
        "errorcode":"\"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.cancel (退货订单取消接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈