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

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
request	ReturnOrderQueryRequest	可选			cest
└ ownerCode String 可选 H1234 货主编码 └ warehouseCode String 可选 CK1234 仓库编码 └ returnOrderCode String 必须 R1234 退货单编码 └ returnOrderId String 可选 CK1234 仓库系统订单编码 └ page Number 必须 1 当前页(从1开始) └ pageSize Number 必须 20 每页orderLine条数(最多100条) └ extendProps Map 可选扩展属性

名称	类型	示例值	描述
response	ReturnOrderQueryResponse		response
└ flag String success 响应结果:success\|failure └ code String 0 响应码 └ message String invalid appkey 响应信息 returnOrder ReturnOrder 退货单信息 └ returnOrderCode String R1234 ERP的退货入库单编码 └ returnOrderId String R1234 仓库系统订单编码 └ warehouseCode String W1234 仓库编码(统仓统配等无需ERP指定仓储编码的情况填OTHER) └ orderType String THRK 单据类型(THRK=退货入库;HHRK=换货入库;只传英文编码) └ orderConfirmTime String 2016-09-09 12:00:00 确认入库时间(YYYY-MM-DD HH:MM:SS) └ logisticsCode String SF 物流公司编码(SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通、ZTO=中通(ZTO)、HTKY=百世汇通、 UC=优速、STO=申通、TTKDEX=天天快递、QFKD=全峰、FAST=快捷、POSTB=邮政小包、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、 AMAZON=亚马逊物流、OTHER=其他;只传英文编码) └ logisticsName String 顺丰物流公司名称 └ expressCode String YD1234 运单号 └ returnReason String 破损退货退货原因 senderInfo SenderInfo 发件人信息 └ company String 淘宝公司名称 └ name String 老王姓名 └ zipCode String 043300 邮编 └ tel String 81020340 固定电话 └ mobile String 13214567869 移动电话 └ email String 345@gmail.com 电子邮箱 └ countryCode String 051532 国家二字码 └ province String 浙江省省份 └ city String 杭州城市 └ area String 余杭区域 └ town String 横加桥村镇 └ detailAddress String 杭州市余杭区989号详细地址 └ remark String 备注信息备注 orderLines OrderLine [] 订单信息 └ orderLineNo String D1234 单据行号 └ sourceOrderCode String PD1224 交易平台订单 └ subSourceOrderCode String PL1234 交易平台子订单编码 └ itemCode String I1234 商品编码 └ itemId String CK1234 仓储系统商品编码(条件为提供后端（仓储系统）商品编码的仓储系统) └ inventoryType String ZP 库存类型(ZP=正品;CC=残次;JS=机损;XS=箱损;默认为ZP) └ planQty Number 12 应收商品数量 └ actualQty Number 13 实收商品数量 └ batchCode String P123 批次编码 └ productDate String 2016-09-09 生产日期(YYYY-MM-DD) └ expireDate String 2016-09-09 过期日期(YYYY-MM-DD) └ produceCode String P1234 生产批号 └ qrCode String 1;1;1 商品的二维码(类似电子产品的SN码;用来进行商品的溯源;多个二维码之间用分号;隔开)

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

QimenClient client = new DefaultQimenClient(url, appkey, secret);
ReturnorderQueryRequest req = new ReturnorderQueryRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setOwnerCode("H1234");
req.setWarehouseCode("CK1234");
req.setReturnOrderCode("R1234");
req.setReturnOrderId("CK1234");
req.setPage(1L);
req.setPageSize(20L);
ReturnorderQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

IQimenClient client = new DefaultQimenClient(url, appkey, secret);
ReturnorderQueryRequest req = new ReturnorderQueryRequest();
req.CustomerId = "stub-cust-code";
req.Version = "2.0";
req.OwnerCode = "H1234";
req.WarehouseCode = "CK1234";
req.ReturnOrderCode = "R1234";
req.ReturnOrderId = "CK1234";
req.Page = 1L;
req.PageSize = 20L;
ReturnorderQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenReturnorderQueryRequest;
$request = new ReturnOrderQueryRequest;
$request->owner_code="H1234";
$request->warehouse_code="CK1234";
$request->return_order_code="R1234";
$request->return_order_id="CK1234";
$request->page="1";
$request->page_size="20";
$request->extend_props="";
$req->setRequest(json_encode($request));
$resp = $c->execute($req);

curl -X POST 'http://qimenapi.tbsandbox.com/router/qimen/service?app_key=testerp_appkey&customerId=stub-cust-code&format=xml&method=taobao.qimen.returnorder.query&sign=6E857AAF3D796923C1DCAB3A1194423F&sign_method=md5&timestamp=2024-05-06+15%3A27%3A44&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <returnOrderCode>R1234</returnOrderCode>
  <ownerCode>H1234</ownerCode>
  <returnOrderId>CK1234</returnOrderId>
  <pageSize>20</pageSize>
  <extendProps/>
  <page>1</page>
  <warehouseCode>CK1234</warehouseCode>
</request>'

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

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

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

XML示例
JSON示例

<response>
    <flag>success</flag>
    <code>0</code>
    <message>invalid appkey</message>
    <returnOrder>
        <returnOrderCode>R1234</returnOrderCode>
        <returnOrderId>R1234</returnOrderId>
        <warehouseCode>W1234</warehouseCode>
        <orderType>THRK</orderType>
        <orderConfirmTime>2016-09-09 12:00:00</orderConfirmTime>
        <logisticsCode>SF</logisticsCode>
        <logisticsName>顺丰</logisticsName>
        <expressCode>YD1234</expressCode>
        <returnReason>破损退货</returnReason>
        <senderInfo>
            <company>淘宝</company>
            <name>老王</name>
            <zipCode>043300</zipCode>
            <tel>81020340</tel>
            <mobile>13214567869</mobile>
            <email>345@gmail.com</email>
            <countryCode>051532</countryCode>
            <province>浙江省</province>
            <city>杭州</city>
            <area>余杭</area>
            <town>横加桥</town>
            <detailAddress>杭州市余杭区989号</detailAddress>
        </senderInfo>
        <remark>备注信息</remark>
    </returnOrder>
    <orderLines>
        <orderLine>
            <orderLineNo>D1234</orderLineNo>
            <sourceOrderCode>PD1224</sourceOrderCode>
            <subSourceOrderCode>PL1234</subSourceOrderCode>
            <itemCode>I1234</itemCode>
            <itemId>CK1234</itemId>
            <inventoryType>ZP</inventoryType>
            <planQty>12</planQty>
            <actualQty>13</actualQty>
            <batchCode>P123</batchCode>
            <productDate>2016-09-09</productDate>
            <expireDate>2016-09-09</expireDate>
            <produceCode>P1234</produceCode>
            <qrCode>1;1;1</qrCode>
        </orderLine>
    </orderLines>
</response>

{
    "response":{
        "flag":"success",
        "code":"0",
        "message":"invalid appkey",
        "returnOrder":{
            "returnOrderCode":"R1234",
            "returnOrderId":"R1234",
            "warehouseCode":"W1234",
            "orderType":"THRK",
            "orderConfirmTime":"2016-09-09 12:00:00",
            "logisticsCode":"SF",
            "logisticsName":"顺丰",
            "expressCode":"YD1234",
            "returnReason":"破损退货",
            "senderInfo":{
                "company":"淘宝",
                "name":"老王",
                "zipCode":"043300",
                "tel":"81020340",
                "mobile":"13214567869",
                "email":"345@gmail.com",
                "countryCode":"051532",
                "province":"浙江省",
                "city":"杭州",
                "area":"余杭",
                "town":"横加桥",
                "detailAddress":"杭州市余杭区989号"
            },
            "remark":"备注信息"
        },
        "orderLines":{
            "orderLine":[
                {
                    "orderLineNo":"D1234",
                    "sourceOrderCode":"PD1224",
                    "subSourceOrderCode":"PL1234",
                    "itemCode":"I1234",
                    "itemId":"CK1234",
                    "inventoryType":"ZP",
                    "planQty":12,
                    "actualQty":13,
                    "batchCode":"P123",
                    "productDate":"2016-09-09",
                    "expireDate":"2016-09-09",
                    "produceCode":"P1234",
                    "qrCode":"1;1;1"
                }
            ]
        }
    }
}

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

taobao.qimen.returnorder.query (退货入库单查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈