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

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
order_code	String	可选	282101027203		ERP单据编码
store_code	String	可选	WANGXIANG-001		仓库编码
order_flag	String	可选	VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL		用字符串格式来表示订单标记列表：比如VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL 等，中间用“^”来隔开 ---------------------------------------- 订单标记list（所有字母全部大写）： 9:VISIT-上门12: SELLER_AFFORD 是否卖家承担运费默认是，即没 13: SYNC_RETURN_BILL，同时退回发票
prev_order_code	String	可选	LBX29028228999		来源单据号，销售退货时填充原发货的LBX号
tms_service_code	String	可选	SF		快递公司编码
tms_order_code	String	可选	3392029022		运单号
return_reason	String	可选	七天无理由退货		销退时请提供退货的原因
buyer_nick	String	可选	天涯再见		买家昵称
sender_info	Senderinfowlbwmsreturnordernotify	可选			发件人信息
└ sender_zip_code String 可选 644302 发件人邮编 └ sender_province String 可选浙江发件人省份 └ sender_city String 可选杭州发件人城市 └ sender_area String 可选余杭发件人区县 └ sender_town String 可选余杭发件人镇村 └ sender_address String 可选浙江省杭州市余杭镇文一西路969号发件人地址 └ sender_name String 可选李勇发件人姓名 └ sender_mobile String 可选 15884486732 发件人手机，手机与电话二选一传入 └ sender_phone String 可选 0571-22908683 发件人电话
receiver_info	Receiverinfowlbwmsreturnordernotify	可选			收件人信息
└ receiver_zip_code String 可选 637229 收件人邮编 └ receiver_province String 可选四川收件人省份 └ receiver_city String 可选成都收件人城市 └ receiver_area String 可选金牛收件人区县 └ receiver_town String 可选虹桥收件人镇村 └ receiver_address String 可选四川省成都市金牛区西苑小区245号收件人地址 └ receiver_name String 可选红红收件人姓名 └ receiver_mobile String 可选 18738281892 收件人手机，手机与电话二选一传入 └ receiver_phone String 可选 028-92191779 收件人电话 └ receiver_nick String 可选小小熊收件人名称
order_item_list	Orderitemlistwlbwmsreturnordernotify []	可选		最大列表长度：50000	商品信息列表
order_item Orderitemwlbwmsreturnordernotify 可选 1 └ order_item_id String 可选 ERP28922927233 平台交易订单编码,淘系交易请传入交易单号 └ order_source_code String 可选 89288110018181008 平台交易订单编码,淘系交易请传入交易单号 └ sub_source_code String 可选 ERP171919119222 平台交易子订单编码，交易单号传入，子交易编号必填 └ item_id String 可选 2829272822 后端商品ID └ item_quantity Number 可选 12 商品数量 └ extend_fields String 可选 key1:value1;key2:value2 扩展属性, key-value结构，格式要求：以英文分号“;”分隔每组key-value，以英文冒号“:”分隔key与value。如果value中带有分号，需要转成下划线“_”，如果带有冒号，需要转成中划线“-” └ item_name String 可选冰箱商品名称
extend_fields	String	可选	key1:value1;key2:value2		扩展属性, key-value结构，格式要求：以英文分号“;”分隔每组key-value，以英文冒号“:”分隔key与value。如果value中带有分号，需要转成下划线“_”，如果带有冒号，需要转成中划线“-”
remark	String	可选	****		备注
order_source	String	可选	210		订单来源 201 淘宝，202 1688，203 苏宁，204 亚马逊中国，205 当当，206 ebay，207 唯品会，208 1号店，209 国美，210 拍拍，211 聚美优品，212 乐峰，214 京东，301 其他
order_type	String	可选	501		订单类型 501 销退入库
owner_user_id	String	可选	韩都衣舍		货主ID
order_create_time	Date	可选	2015-07-08 22:06:39		ERP订单创建时间
tms_service_name	String	可选	顺丰		快递公司名称

名称	类型	示例值	描述
create_time	Date	2016-01-18 12:00:00	订单创建时间
store_order_code	String	仓储中心订单编码	LBX929829111
wl_success	Boolean	true	是否成功
wl_error_code	String	S12	错误编码
wl_error_msg	String	服务不可用	错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
WlbWmsReturnOrderNotifyRequest req = new WlbWmsReturnOrderNotifyRequest();
req.setOrderCode("282101027203");
req.setStoreCode("WANGXIANG-001");
req.setOrderFlag("VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL");
req.setPrevOrderCode("LBX29028228999");
req.setTmsServiceCode("SF");
req.setTmsOrderCode("3392029022");
req.setReturnReason("七天无理由退货");
req.setBuyerNick("天涯再见");
Senderinfowlbwmsreturnordernotify obj1 = new Senderinfowlbwmsreturnordernotify();
obj1.setSenderZipCode("644302");
obj1.setSenderProvince("浙江");
obj1.setSenderCity("杭州");
obj1.setSenderArea("余杭");
obj1.setSenderTown("余杭");
obj1.setSenderAddress("浙江省杭州市余杭镇文一西路969号");
obj1.setSenderName("李勇");
obj1.setSenderMobile("15884486732");
obj1.setSenderPhone("0571-22908683");
req.setSenderInfo(obj1);
Receiverinfowlbwmsreturnordernotify obj2 = new Receiverinfowlbwmsreturnordernotify();
obj2.setReceiverZipCode("637229");
obj2.setReceiverProvince("四川");
obj2.setReceiverCity("成都");
obj2.setReceiverArea("金牛");
obj2.setReceiverTown("虹桥");
obj2.setReceiverAddress("四川省成都市金牛区西苑小区245号");
obj2.setReceiverName("红红");
obj2.setReceiverMobile("18738281892");
obj2.setReceiverPhone("028-92191779");
obj2.setReceiverNick("小小熊");
req.setReceiverInfo(obj2);
List<Orderitemlistwlbwmsreturnordernotify> list4 = new ArrayList<Orderitemlistwlbwmsreturnordernotify>();
Orderitemlistwlbwmsreturnordernotify obj5 = new Orderitemlistwlbwmsreturnordernotify();
list4.add(obj5);
Orderitemwlbwmsreturnordernotify obj7 = new Orderitemwlbwmsreturnordernotify();
obj7.setOrderItemId("ERP28922927233");
obj7.setOrderSourceCode("89288110018181008");
obj7.setSubSourceCode("ERP171919119222");
obj7.setItemId("2829272822");
obj7.setItemQuantity(12L);
obj7.setExtendFields("key1:value1;key2:value2");
obj7.setItemName("冰箱");
list6.setOrderItem(obj7);
req.setOrderItemList(list4);
req.setExtendFields("key1:value1;key2:value2");
req.setRemark("****");
req.setOrderSource("210");
req.setOrderType("501");
req.setOwnerUserId("韩都衣舍");
req.setOrderCreateTime(StringUtils.parseDateTime("2015-07-08 22:06:39"));
req.setTmsServiceName("顺丰");
WlbWmsReturnOrderNotifyResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
WlbWmsReturnOrderNotifyRequest req = new WlbWmsReturnOrderNotifyRequest();
req.OrderCode = "282101027203";
req.StoreCode = "WANGXIANG-001";
req.OrderFlag = "VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL";
req.PrevOrderCode = "LBX29028228999";
req.TmsServiceCode = "SF";
req.TmsOrderCode = "3392029022";
req.ReturnReason = "七天无理由退货";
req.BuyerNick = "天涯再见";
Senderinfowlbwmsreturnordernotify obj1 = new Senderinfowlbwmsreturnordernotify();
obj1.SenderZipCode = "644302";
obj1.SenderProvince = "浙江";
obj1.SenderCity = "杭州";
obj1.SenderArea = "余杭";
obj1.SenderTown = "余杭";
obj1.SenderAddress = "浙江省杭州市余杭镇文一西路969号";
obj1.SenderName = "李勇";
obj1.SenderMobile = "15884486732";
obj1.SenderPhone = "0571-22908683";
req.SenderInfo_ = obj1;
Receiverinfowlbwmsreturnordernotify obj2 = new Receiverinfowlbwmsreturnordernotify();
obj2.ReceiverZipCode = "637229";
obj2.ReceiverProvince = "四川";
obj2.ReceiverCity = "成都";
obj2.ReceiverArea = "金牛";
obj2.ReceiverTown = "虹桥";
obj2.ReceiverAddress = "四川省成都市金牛区西苑小区245号";
obj2.ReceiverName = "红红";
obj2.ReceiverMobile = "18738281892";
obj2.ReceiverPhone = "028-92191779";
obj2.ReceiverNick = "小小熊";
req.ReceiverInfo_ = obj2;
List<Orderitemlistwlbwmsreturnordernotify> list4 = new List<Orderitemlistwlbwmsreturnordernotify>();
Orderitemlistwlbwmsreturnordernotify obj5 = new Orderitemlistwlbwmsreturnordernotify();
list4.Add(obj5);
Orderitemwlbwmsreturnordernotify obj6 = new Orderitemwlbwmsreturnordernotify();
obj6.OrderItemId = "ERP28922927233";
obj6.OrderSourceCode = "89288110018181008";
obj6.SubSourceCode = "ERP171919119222";
obj6.ItemId = "2829272822";
obj6.ItemQuantity = 12L;
obj6.ExtendFields = "key1:value1;key2:value2";
obj6.ItemName = "冰箱";
obj5.OrderItem= obj6;
req.OrderItemList_ = list4;
req.ExtendFields = "key1:value1;key2:value2";
req.Remark = "****";
req.OrderSource = "210";
req.OrderType = "501";
req.OwnerUserId = "韩都衣舍";
req.OrderCreateTime = DateTime.Parse("2015-07-08 22:06:39");
req.TmsServiceName = "顺丰";
WlbWmsReturnOrderNotifyResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new WlbWmsReturnOrderNotifyRequest;
$req->setOrderCode("282101027203");
$req->setStoreCode("WANGXIANG-001");
$req->setOrderFlag("VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL");
$req->setPrevOrderCode("LBX29028228999");
$req->setTmsServiceCode("SF");
$req->setTmsOrderCode("3392029022");
$req->setReturnReason("七天无理由退货");
$req->setBuyerNick("天涯再见");
$sender_info = new Senderinfowlbwmsreturnordernotify;
$sender_info->sender_zip_code="644302";
$sender_info->sender_province="浙江";
$sender_info->sender_city="杭州";
$sender_info->sender_area="余杭";
$sender_info->sender_town="余杭";
$sender_info->sender_address="浙江省杭州市余杭镇文一西路969号";
$sender_info->sender_name="李勇";
$sender_info->sender_mobile="15884486732";
$sender_info->sender_phone="0571-22908683";
$req->setSenderInfo(json_encode($sender_info));
$receiver_info = new Receiverinfowlbwmsreturnordernotify;
$receiver_info->receiver_zip_code="637229";
$receiver_info->receiver_province="四川";
$receiver_info->receiver_city="成都";
$receiver_info->receiver_area="金牛";
$receiver_info->receiver_town="虹桥";
$receiver_info->receiver_address="四川省成都市金牛区西苑小区245号";
$receiver_info->receiver_name="红红";
$receiver_info->receiver_mobile="18738281892";
$receiver_info->receiver_phone="028-92191779";
$receiver_info->receiver_nick="小小熊";
$req->setReceiverInfo(json_encode($receiver_info));
$order_item_list = new Orderitemlistwlbwmsreturnordernotify;
$order_item = new Orderitemwlbwmsreturnordernotify;
$order_item->order_item_id="ERP28922927233";
$order_item->order_source_code="89288110018181008";
$order_item->sub_source_code="ERP171919119222";
$order_item->item_id="2829272822";
$order_item->item_quantity="12";
$order_item->extend_fields="key1:value1;key2:value2";
$order_item->item_name="冰箱";
$order_item_list->order_item = $order_item;
$req->setOrderItemList(json_encode($order_item_list));
$req->setExtendFields("key1:value1;key2:value2");
$req->setRemark("****");
$req->setOrderSource("210");
$req->setOrderType("501");
$req->setOwnerUserId("韩都衣舍");
$req->setOrderCreateTime("2015-07-08 22:06:39");
$req->setTmsServiceName("顺丰");
$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=taobao.wlb.wms.return.order.notify' \
-d 'partner_id=apidoc' \
-d 'session=517f71f3-a5f2-4e7b-8491-09316cfa220d' \
-d 'sign=3E6B4BC72B7D656DFF07D44BAAE83D41' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+13%3A55%3A49' \
-d 'v=2.0' \
-d 'buyer_nick=%E5%A4%A9%E6%B6%AF%E5%86%8D%E8%A7%81' \
-d 'extend_fields=key1%3Avalue1%3Bkey2%3Avalue2' \
-d 'order_code=282101027203' \
-d 'order_create_time=2015-07-08+22%3A06%3A39' \
-d 'order_flag=VISIT%5E+SELLER_AFFORD%5ESYNC_RETURN_BILL' \
-d 'order_item_list=null' \
-d 'order_source=210' \
-d 'order_type=501' \
-d 'owner_user_id=%E9%9F%A9%E9%83%BD%E8%A1%A3%E8%88%8D' \
-d 'prev_order_code=LBX29028228999' \
-d 'receiver_info=null' \
-d 'remark=****' \
-d 'return_reason=%E4%B8%83%E5%A4%A9%E6%97%A0%E7%90%86%E7%94%B1%E9%80%80%E8%B4%A7' \
-d 'sender_info=null' \
-d 'store_code=WANGXIANG-001' \
-d 'tms_order_code=3392029022' \
-d 'tms_service_code=SF' \
-d 'tms_service_name=%E9%A1%BA%E4%B8%B0'

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

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

req.order_code="282101027203"
req.store_code="WANGXIANG-001"
req.order_flag="VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL"
req.prev_order_code="LBX29028228999"
req.tms_service_code="SF"
req.tms_order_code="3392029022"
req.return_reason="七天无理由退货"
req.buyer_nick="天涯再见"
req.sender_info="数据结构示例JSON格式"
req.receiver_info="数据结构示例JSON格式"
req.order_item_list="null"
req.extend_fields="key1:value1;key2:value2"
req.remark="****"
req.order_source="210"
req.order_type="501"
req.owner_user_id="韩都衣舍"
req.order_create_time="2015-07-08 22:06:39"
req.tms_service_name="顺丰"
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,"taobao.wlb.wms.return.order.notify");
add_param(pRequest,"order_code","282101027203");
add_param(pRequest,"store_code","WANGXIANG-001");
add_param(pRequest,"order_flag","VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL");
add_param(pRequest,"prev_order_code","LBX29028228999");
add_param(pRequest,"tms_service_code","SF");
add_param(pRequest,"tms_order_code","3392029022");
add_param(pRequest,"return_reason","七天无理由退货");
add_param(pRequest,"buyer_nick","天涯再见");
add_param(pRequest,"sender_info","数据结构JSON示例");
add_param(pRequest,"receiver_info","数据结构JSON示例");
add_param(pRequest,"order_item_list","数据结构JSON示例");
add_param(pRequest,"extend_fields","key1:value1;key2:value2");
add_param(pRequest,"remark","****");
add_param(pRequest,"order_source","210");
add_param(pRequest,"order_type","501");
add_param(pRequest,"owner_user_id","韩都衣舍");
add_param(pRequest,"order_create_time","2015-07-08 22:06:39");
add_param(pRequest,"tms_service_name","顺丰");
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('taobao.wlb.wms.return.order.notify', {
	'order_code':'282101027203',
	'store_code':'WANGXIANG-001',
	'order_flag':'VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL',
	'prev_order_code':'LBX29028228999',
	'tms_service_code':'SF',
	'tms_order_code':'3392029022',
	'return_reason':'七天无理由退货',
	'buyer_nick':'天涯再见',
	'sender_info':'数据结构JSON示例',
	'receiver_info':'数据结构JSON示例',
	'order_item_list':'数据结构JSON示例',
	'extend_fields':'key1:value1;key2:value2',
	'remark':'****',
	'order_source':'210',
	'order_type':'501',
	'owner_user_id':'韩都衣舍',
	'order_create_time':'2015-07-08 22:06:39',
	'tms_service_name':'顺丰'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<wlb_wms_return_order_notify_response>
    <create_time>2016-01-18 12:00:00</create_time>
    <store_order_code>仓储中心订单编码</store_order_code>
    <wl_success>true</wl_success>
    <wl_error_code>S12</wl_error_code>
    <wl_error_msg>服务不可用</wl_error_msg>
</wlb_wms_return_order_notify_response>

{
    "wlb_wms_return_order_notify_response":{
        "create_time":"2016-01-18 12:00:00",
        "store_order_code":"仓储中心订单编码",
        "wl_success":true,
        "wl_error_code":"S12",
        "wl_error_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"
	}
}

错误码	错误描述	解决方案

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

菜鸟仓配API

taobao.wlb.wms.return.order.notify (销售退货通知)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈