简要描述:
接口说明:
- 1.1接口描述:创建退货入库单到WMS
- 1.2接口说明:ERP调用奇门接口,奇门调用该接口,FMS调用奇门接口往WMS创建退货入库单.该接口和入库单的区别就是该接口是从入库单接口中单独剥离出来的,专门处理退货引起的入 库操作
- 1.3接口方法:taobao.qimen.returnorder.create
接口版本:
| 版本号 |
制定人 |
制定日期 |
修订日期 |
| 1.0.0 |
黄会准 |
2020-08-04 |
2020-08-04 |
请求URL:
请求方式:
请求头:
| 参数名 |
是否必须 |
类型 |
说明 |
| Content-Type |
是 |
string |
请求类型,统一是 application/xml |
系统级请求参数
| 参数名 |
字段 |
是否必须 |
类型 |
长度 |
说明 |
| WMS 的appkey |
app_key |
是 |
String |
|
应用接入时申请的 appkey |
| 接口方法 |
method |
是 |
String |
|
WMS 相关的业务接口名称,method= taobao.qimen.returnorder.create |
| 协议版本号 |
v |
是 |
String |
|
版本号 默认请传3.0 |
| content 格式 |
format |
是 |
String |
|
目前支持 XML |
| 加密令牌 |
sign |
是 |
String |
|
根据 url 和密钥计算的结果 |
| 加密方法 |
sign_method |
是 |
String |
|
md5 |
| 用户id |
customerid |
是 |
String |
|
WMS 颁发给用户的 ID |
| 请求时间 |
timestamp |
是 |
String |
|
yyyy-MM-dd HH:mm:ss 格式 |
请求参数:
| 参数名 |
字段 |
是否必须 |
类型 |
说明 |
| 退货单信息 |
returnOrder |
是 |
data |
退货单信息,节点下数据字段详见下述“returnOrder” |
| 订单信息 |
orderLines |
是 |
data[] |
订单信息,节点下数据字段详见下述“orderLines” |
| 扩展属性 |
extendProps |
否 |
Map |
扩展属性 |
returnOrder
| 参数名 |
字段 |
是否必须 |
类型 |
说明 |
| ERP的退货入库单编码 |
returnOrderCode |
是 |
String |
ERP的退货入库单编码 |
| 仓库编码 |
warehouseCode |
是 |
String |
仓库编码(统仓统配等无需ERP指定仓储编码的情况填OTHER) |
| 单据类型 |
orderType |
否 |
String |
单据类型(THRK=退货入库;HHRK=换货入库;只传英文编码) |
| 订单标记 |
orderFlag |
是 |
String |
用字符串格式来表示订单标记列表(比如VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL等;中间用“^”来隔开订单标记list (所 有字母全部大写) VISIT=上门;SELLER_AFFORD=是否卖家承担运费(默认是)SYNC_RETURN_BILL=同时退回发票) |
| 原出库单号 |
preDeliveryOrderCode |
是 |
String |
原出库单号(ERP分配) |
| 原出库单号 |
preDeliveryOrderId |
否 |
String |
原出库单号(WMS分配) |
| 物流公司编码 |
logisticsCode |
否 |
String |
物流公司编码(SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通、ZTO=中通(ZTO)、HTKY=百世汇通、 UC=优速、STO=申通、TTKDEX=天天快递、QFKD=全峰、FAST=快捷、POSTB=邮政小包、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、 AMAZON=亚马逊物流、OTHER=其他;只传英文编码) |
| 物流公司名称 |
logisticsName |
否 |
String |
物流公司名称 |
| 运单号 |
expressCode |
否 |
String |
运单号 |
| 退货原因 |
returnReason |
否 |
String |
退货原因 |
| 买家昵称 |
buyerNick |
否 |
String |
买家昵称 |
| 发件人信息 |
senderInfo |
否 |
data |
发件人信息,节点下数据字段详见下述“senderInfo” |
| 备注 |
remark |
否 |
String |
备注 |
| 订单来源平台编码 |
sourcePlatformCode |
否 |
String |
订单来源平台编码, string (50),TB= 淘宝 、TM=天猫 、JD=京东、DD=当当、PP=拍拍、YX=易讯、EBAY=ebay、QQ=QQ网购、AMAZON=亚马逊、SN=苏宁、GM=国美、WPH=唯品会、JM=聚美、LF=乐蜂、MGJ=蘑菇街、JS=聚尚、PX=拍鞋、YT=银泰、YHD=1号店、VANCL=凡客、YL=邮乐、YG=优购、1688=阿里巴巴、POS=POS门店、MIA=蜜芽、GW=商家官网、CT=村淘、YJWD=云集微店、PDD=拼多多、OTHERS=其他, |
| 订单来源平台名称 |
sourcePlatformName |
否 |
String |
订单来源平台名称 |
| 店铺名称 |
shopNick |
否 |
String |
店铺名称 |
| 卖家名称 |
sellerNick |
否 |
String |
卖家名称 |
senderInfo
| 参数名 |
字段 |
是否必须 |
类型 |
说明 |
| 公司名称 |
company |
否 |
String |
公司名称 |
| 姓名 |
name |
是 |
String |
姓名 |
| 邮编 |
zipCode |
否 |
String |
邮编 |
| 固定电话 |
tel |
否 |
String |
固定电话 |
| 移动电话 |
mobile |
是 |
String |
移动电话 |
| 电子邮箱 |
email |
否 |
String |
电子邮箱 |
| 国家二字码 |
countryCode |
否 |
String |
国家二字码 |
| 省份 |
province |
是 |
String |
省份 |
| 城市 |
city |
是 |
String |
城市 |
| 区域 |
area |
否 |
String |
区域 |
| 村镇 |
town |
否 |
String |
村镇 |
| 详细地址 |
tel |
是 |
String |
详细地址 |
orderLines
| 参数名 |
字段 |
是否必须 |
类型 |
说明 |
| 单据行号 |
orderLineNo |
否 |
String |
单据行号 |
| 交易平台订单 |
sourceOrderCode |
否 |
String |
交易平台订单 |
| 交易平台子订单编码 |
subSourceOrderCode |
否 |
String |
交易平台子订单编码 |
| 货主编码 |
ownerCode |
是 |
String |
货主编码 |
| 商品编码 |
itemCode |
是 |
String |
商品编码 |
| 仓储系统商品编码 |
itemId |
否 |
String |
仓储系统商品编码(条件为提供后端(仓储系统)商品编码的仓储系统) |
| 库存类型 |
inventoryType |
是 |
String |
库存类型(ZP=正品;CC=残次;JS=机损;XS=箱损;默认为ZP) |
| 应收商品数量 |
planQty |
否 |
Number |
应收商品数量 |
| 批次编码 |
batchCode |
否 |
String |
批次编码 |
| 生产日期 |
productDate |
否 |
String |
生产日期(YYYY-MM-DD) |
| 过期日期 |
expireDate |
否 |
String |
过期日期(YYYY-MM-DD) |
| 生产批号 |
produceCode |
否 |
String |
生产批号 |
| 订单标记 |
orderFlag |
是 |
String |
用字符串格式来表示订单标记列表(比如VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL等;中间用“^”来隔开订单标记list (所 有字母全部大写) VISIT=上门;SELLER_AFFORD=是否卖家承担运费(默认是)SYNC_RETURN_BILL=同时退回发票) |
| 退货原因 |
returnReason |
否 |
String |
退货原因 |
| sn编码列表 |
snList |
否 |
data |
sn编码列表,节点下数据字段详见下述“snList” |
snList
| 参数名 |
字段 |
是否必须 |
类型 |
说明 |
| sn编码 |
sn |
否 |
String[] |
sn编码 |
请求参数示例
<?xml version="1.0" encoding="UTF-8" ?>
<request>
<returnOrder>
<returnOrderCode>R1234</returnOrderCode>
<warehouseCode>W1234</warehouseCode>
<orderType>THRK</orderType>
<orderFlag>VISIT</orderFlag>
<preDeliveryOrderCode>PD1234</preDeliveryOrderCode>
<preDeliveryOrderId>PDI1234</preDeliveryOrderId>
<logisticsCode>SF</logisticsCode>
<logisticsName>顺丰</logisticsName>
<expressCode>YD1234</expressCode>
<returnReason>破损退货</returnReason>
<buyerNick>淘宝</buyerNick>
<remark>备注信息</remark>
<sourcePlatformCode>TB</sourcePlatformCode>
<sourcePlatformName>淘宝</sourcePlatformName>
<shopNick>店铺名称</shopNick>
<sellerNick>卖家名称</sellerNick>
<senderInfo>
<name>老王</name>
<province>浙江省</province>
<mobile>13214567869</mobile>
<city>杭州</city>
<detailAddress>杭州市余杭区989号</detailAddress>
</senderInfo>
</returnOrder>
<orderLines>
<orderLine>
<orderLineNo>D1234</orderLineNo>
<sourceOrderCode>PD1224</sourceOrderCode>
<subSourceOrderCode>PL1234</subSourceOrderCode>
<ownerCode>HZ1234</ownerCode>
<itemCode>I1234</itemCode>
<itemId>CK1234</itemId>
<inventoryType>ZP</inventoryType>
<planQty>12</planQty>
<batchCode>P123</batchCode>
<productDate>2016-09-09</productDate>
<expireDate>2016-09-09</expireDate>
<produceCode>P1234</produceCode>
<orderFlag>visit</orderFlag>
<returnReason>破损退货</returnReason>
<snList>
<sn>S1</sn>
<sn>C2</sn>
<sn>X3</sn>
</snList>
</orderLine>
<orderLine>
<orderLineNo>D1234</orderLineNo>
<sourceOrderCode>PD1224</sourceOrderCode>
<subSourceOrderCode>PL1234</subSourceOrderCode>
<ownerCode>HZ1234</ownerCode>
<itemCode>I1234</itemCode>
<itemId>CK1234</itemId>
<inventoryType>ZP</inventoryType>
<planQty>12</planQty>
<batchCode>P123</batchCode>
<productDate>2016-09-09</productDate>
<expireDate>2016-09-09</expireDate>
<produceCode>P1234</produceCode>
<orderFlag>visit</orderFlag>
<returnReason>破损退货</returnReason>
<snList>
<sn>S1</sn>
<sn>C2</sn>
<sn>X3</sn>
</snList>
</orderLine>
</orderLines>
<extendProps>
<xzz>111</xzz>
<hhz>222</hhz>
</extendProps>
</request>
返回示例:
正确时返回:
<?xml version="1.0" encoding="utf-8"?>
<response>
<flag>success|failure</flag>
<code>响应码</code>
<message>响应信息</message>
<returnOrderId>仓储系统退货单编码, string (50) </returnOrderId>
</response>
错误时返回:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
<flag>failure</flag>
<code>failure</code>
<message>请求奇门接口失败</message>
<subCode>100002</subCode>
<subMessage>请求WMS奇门接口失败,错误原因:{"code":"TOP29","flag":"failure","message":"Invalid app Key","success":false}</subMessage>
<requestId>ace95ef4cb9a4b42b2e6812a50745b64</requestId>
</response>
备注:
文档更新时间: 2020-08-07 14:09 作者:黄会准