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

请求地址：

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

名称	类型	是否必须	示例值	描述
partnerid	String	可选	FN	配送服务分配的ID
logistics_order_no	String	可选	1212	运单号
pickup_order_no	String	可选	12343	取货单号

名称	类型	示例值	描述
result	Result		result
resp_detail ReturnedQueryResDto respDetail └ merchant_cancel_time String 2018-02-06 12:00:00 取消时间 └ sign_fail_time String 2018-02-06 12:00:00 妥投失败时间 └ sign_time String 2018-02-06 12:00:00 妥投成功时间 └ contact_fail_time_time String 2018-02-06 12:00:00 联系不上用户时间 └ pickup_fail_time String 2018-02-06 12:00:00 取货失败时间 └ pickup_order_status_detail String FAILED_DIFFER 取货状态原因 └ pickup_order_status String FAILED_DIFFER 取货状态（PICKUP_SUCCESS,PART_PICKUP,PICKUP_FAIL,CONTACT_CUSTOMER_FAIL,SIGNED_SUCCESS,PART_SIGNED,SIGNED_FAIL,MERCHANT_CANCELED,TIMEOUT_CANCELED） └ timeout_cancel_time String 2018-02-06 12:00:00 超时自动取消时间 sub_order_list ReturnedQueryResSubOrderDto [] subOrderList └ sub_logistics_order_no String 1 物流子订单号 └ item_code String 123 商品编号 └ enter_dock_qty String 1 取货成功后入仓数量， └ need_take_qty String 1 需要取回的数量 └ sub_refund_no String 退货单号退货单号 └ pickup_order_status_desc String PICKUP_SUCCESS 运单详细状态 └ pickup_order_status_detail_desc String 揽收成功状态描述 └ pickup_time String 2018-04-18 00:00:00 取货成功时间 └ 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);
AlibabaWdkTmsOrderSalesreturnQueryRequest req = new AlibabaWdkTmsOrderSalesreturnQueryRequest();
req.setPartnerid("FN");
req.setLogisticsOrderNo("1212");
req.setPickupOrderNo("12343");
AlibabaWdkTmsOrderSalesreturnQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkTmsOrderSalesreturnQueryRequest req = new AlibabaWdkTmsOrderSalesreturnQueryRequest();
req.Partnerid = "FN";
req.LogisticsOrderNo = "1212";
req.PickupOrderNo = "12343";
AlibabaWdkTmsOrderSalesreturnQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkTmsOrderSalesreturnQueryRequest;
$req->setPartnerid("FN");
$req->setLogisticsOrderNo("1212");
$req->setPickupOrderNo("12343");
$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.query' \
-d 'partner_id=apidoc' \
-d 'session=97862a84-2f7b-43f8-b3f9-40c9a7f422e3' \
-d 'sign=762B68CE793DAEDD3406885CD45D4057' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+21%3A21%3A09' \
-d 'v=2.0' \
-d 'logistics_order_no=1212' \
-d 'partnerid=FN' \
-d 'pickup_order_no=12343'

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

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

req.partnerid="FN"
req.logistics_order_no="1212"
req.pickup_order_no="12343"
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.query");
add_param(pRequest,"partnerid","FN");
add_param(pRequest,"logistics_order_no","1212");
add_param(pRequest,"pickup_order_no","12343");
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.query', {
	'partnerid':'FN',
	'logistics_order_no':'1212',
	'pickup_order_no':'12343'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_wdk_tms_order_salesreturn_query_response>
    <result>
        <resp_detail>
            <merchant_cancel_time>2018-02-06 12:00:00</merchant_cancel_time>
            <sign_fail_time>2018-02-06 12:00:00</sign_fail_time>
            <sign_time>2018-02-06 12:00:00</sign_time>
            <contact_fail_time_time>2018-02-06 12:00:00</contact_fail_time_time>
            <pickup_fail_time>2018-02-06 12:00:00</pickup_fail_time>
            <pickup_order_status_detail>FAILED_DIFFER</pickup_order_status_detail>
            <pickup_order_status>FAILED_DIFFER</pickup_order_status>
            <timeout_cancel_time>2018-02-06 12:00:00</timeout_cancel_time>
            <sub_order_list>
                <returned_query_res_sub_order_dto>
                    <sub_logistics_order_no>1</sub_logistics_order_no>
                    <item_code>123</item_code>
                    <enter_dock_qty>1</enter_dock_qty>
                    <need_take_qty>1</need_take_qty>
                    <sub_refund_no>退货单号</sub_refund_no>
                </returned_query_res_sub_order_dto>
            </sub_order_list>
            <pickup_order_status_desc>PICKUP_SUCCESS</pickup_order_status_desc>
            <pickup_order_status_detail_desc>揽收成功</pickup_order_status_detail_desc>
            <pickup_time>2018-04-18 00:00:00</pickup_time>
        </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_query_response>

{
    "alibaba_wdk_tms_order_salesreturn_query_response":{
        "result":{
            "resp_detail":{
                "merchant_cancel_time":"2018-02-06 12:00:00",
                "sign_fail_time":"2018-02-06 12:00:00",
                "sign_time":"2018-02-06 12:00:00",
                "contact_fail_time_time":"2018-02-06 12:00:00",
                "pickup_fail_time":"2018-02-06 12:00:00",
                "pickup_order_status_detail":"FAILED_DIFFER",
                "pickup_order_status":"FAILED_DIFFER",
                "timeout_cancel_time":"2018-02-06 12:00:00",
                "sub_order_list":{
                    "returned_query_res_sub_order_dto":[
                        {
                            "sub_logistics_order_no":"1",
                            "item_code":"123",
                            "enter_dock_qty":"1",
                            "need_take_qty":"1",
                            "sub_refund_no":"退货单号"
                        }
                    ]
                },
                "pickup_order_status_desc":"PICKUP_SUCCESS",
                "pickup_order_status_detail_desc":"揽收成功",
                "pickup_time":"2018-04-18 00:00:00"
            },
            "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.query (退货订单查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈