淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
warehouseCode	String	可选	A123		仓库代码
createDate	String	可选	2017-11-11 10:00:00		创建日期
uniqueKey	String	可选	201710101010		wms单号
createEmp	String	可选	张三		创建人
shippingCode	String	可选	ZT		物流公司
shippingSn	String	可选	201710101010		物流单号
receiveAddress	String	可选	浙江省杭州市余杭区文一西路969号		收货地址
receiverMobile	String	可选	13000000000		收货人电话
orderCode	String	可选	201710101010		订单编号
remark	String	可选	备注信息		备注
products	Products []	可选		最大列表长度：999	退货明细
└ quantity String 可选 1000 数量 └ skuCode String 可选 A123 商品sku编码
customerId	String	必须	customerId		customerId
snList	SnList []	可选		最大列表长度：999	sn编码列表
└ sn String 可选 A123 sn编码

名称	类型	示例值	描述
flag	String	success\|failure	响应结果
code	String	1	响应码
message	String	msg	message

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

QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
TaobaoWmsReturnapplyReportRequest req = new TaobaoWmsReturnapplyReportRequest();
req.setWarehouseCode("A123");
req.setCreateDate("2017-11-11 10:00:00");
req.setUniqueKey("201710101010");
req.setCreateEmp("张三");
req.setShippingCode("ZT");
req.setShippingSn("201710101010");
req.setReceiveAddress("浙江省 杭州市 余杭区 文一西路969号");
req.setReceiverMobile("13000000000");
req.setOrderCode("201710101010");
req.setRemark("备注信息");
List<TaobaoWmsReturnapplyReportRequest.Products> list2 = new ArrayList<TaobaoWmsReturnapplyReportRequest.Products>();
TaobaoWmsReturnapplyReportRequest.Products obj3 = new TaobaoWmsReturnapplyReportRequest.Products();
list2.add(obj3);
obj3.setQuantity("1000");
obj3.setSkuCode("A123");
req.setProducts(list2);
req.setCustomerId("customerId");
List<TaobaoWmsReturnapplyReportRequest.SnList> list5 = new ArrayList<TaobaoWmsReturnapplyReportRequest.SnList>();
TaobaoWmsReturnapplyReportRequest.SnList obj6 = new TaobaoWmsReturnapplyReportRequest.SnList();
list5.add(obj6);
obj6.setSn("A123");
req.setSnList(list5);
TaobaoWmsReturnapplyReportResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TaobaoWmsReturnapplyReportRequest req = new TaobaoWmsReturnapplyReportRequest();
req.WarehouseCode = "A123";
req.CreateDate = "2017-11-11 10:00:00";
req.UniqueKey = "201710101010";
req.CreateEmp = "张三";
req.ShippingCode = "ZT";
req.ShippingSn = "201710101010";
req.ReceiveAddress = "浙江省 杭州市 余杭区 文一西路969号";
req.ReceiverMobile = "13000000000";
req.OrderCode = "201710101010";
req.Remark = "备注信息";
List<TaobaoWmsReturnapplyReportRequest.ProductsDomain> list2 = new List<TaobaoWmsReturnapplyReportRequest.ProductsDomain>();
TaobaoWmsReturnapplyReportRequest.ProductsDomain obj3 = new TaobaoWmsReturnapplyReportRequest.ProductsDomain();
list2.Add(obj3);
obj3.Quantity = "1000";
obj3.SkuCode = "A123";
req.Products_ = list2;
req.CustomerId = "customerId";
List<TaobaoWmsReturnapplyReportRequest.SnListDomain> list5 = new List<TaobaoWmsReturnapplyReportRequest.SnListDomain>();
TaobaoWmsReturnapplyReportRequest.SnListDomain obj6 = new TaobaoWmsReturnapplyReportRequest.SnListDomain();
list5.Add(obj6);
obj6.Sn = "A123";
req.SnList_ = list5;
TaobaoWmsReturnapplyReportResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TaobaoWmsReturnapplyReportRequest;
$req->setWarehouseCode("A123");
$req->setCreateDate("2017-11-11 10:00:00");
$req->setUniqueKey("201710101010");
$req->setCreateEmp("张三");
$req->setShippingCode("ZT");
$req->setShippingSn("201710101010");
$req->setReceiveAddress("浙江省 杭州市 余杭区 文一西路969号");
$req->setReceiverMobile("13000000000");
$req->setOrderCode("201710101010");
$req->setRemark("备注信息");
$products = new Products;
$products->quantity="1000";
$products->sku_code="A123";
$req->setProducts(json_encode($products));
$req->setCustomerId("customerId");
$snList = new SnList;
$snList->sn="A123";
$req->setSnList(json_encode($snList));
$resp = $c->execute($req);

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=qimen.taobao.wms.returnapply.report' \
-d 'partner_id=apidoc' \
-d 'sign=E139E2CA6D11B130A30C114164296A0D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-12+02%3A45%3A54' \
-d 'v=2.0' \
-d 'createDate=2017-11-11+10%3A00%3A00' \
-d 'createEmp=%E5%BC%A0%E4%B8%89' \
-d 'customerId=customerId' \
-d 'orderCode=201710101010' \
-d 'products=null' \
-d 'receiveAddress=%E6%B5%99%E6%B1%9F%E7%9C%81+%E6%9D%AD%E5%B7%9E%E5%B8%82+%E4%BD%99%E6%9D%AD%E5%8C%BA+%E6%96%87%E4%B8%80%E8%A5%BF%E8%B7%AF969%E5%8F%B7' \
-d 'receiverMobile=13000000000' \
-d 'remark=%E5%A4%87%E6%B3%A8%E4%BF%A1%E6%81%AF' \
-d 'shippingCode=ZT' \
-d 'shippingSn=201710101010' \
-d 'snList=null' \
-d 'uniqueKey=201710101010' \
-d 'warehouseCode=A123'

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

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

req.warehouseCode="A123"
req.createDate="2017-11-11 10:00:00"
req.uniqueKey="201710101010"
req.createEmp="张三"
req.shippingCode="ZT"
req.shippingSn="201710101010"
req.receiveAddress="浙江省 杭州市 余杭区 文一西路969号"
req.receiverMobile="13000000000"
req.orderCode="201710101010"
req.remark="备注信息"
req.products="null"
req.customerId="customerId"
req.snList="null"
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,"qimen.taobao.wms.returnapply.report");
add_param(pRequest,"warehouseCode","A123");
add_param(pRequest,"createDate","2017-11-11 10:00:00");
add_param(pRequest,"uniqueKey","201710101010");
add_param(pRequest,"createEmp","张三");
add_param(pRequest,"shippingCode","ZT");
add_param(pRequest,"shippingSn","201710101010");
add_param(pRequest,"receiveAddress","浙江省 杭州市 余杭区 文一西路969号");
add_param(pRequest,"receiverMobile","13000000000");
add_param(pRequest,"orderCode","201710101010");
add_param(pRequest,"remark","备注信息");
add_param(pRequest,"products","数据结构JSON示例");
add_param(pRequest,"customerId","customerId");
add_param(pRequest,"snList","数据结构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('qimen.taobao.wms.returnapply.report', {
	'warehouseCode':'A123',
	'createDate':'2017-11-11 10:00:00',
	'uniqueKey':'201710101010',
	'createEmp':'张三',
	'shippingCode':'ZT',
	'shippingSn':'201710101010',
	'receiveAddress':'浙江省 杭州市 余杭区 文一西路969号',
	'receiverMobile':'13000000000',
	'orderCode':'201710101010',
	'remark':'备注信息',
	'products':'数据结构JSON示例',
	'customerId':'customerId',
	'snList':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<flag>success|failure</flag>
<code>1</code>
<message>msg</message>

{
    "flag":"success|failure",
    "code":"1",
    "message":"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"
	}
}

错误码	错误描述	解决方案
1
isp.http-read-timeout
isp.http-connection-timeout

API测试工具错误码查询工具 SDK下载

开放平台

奇门仓储API

qimen.taobao.wms.returnapply.report (退货异常包裹单通知接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ