文档中心 > API类目 > SCM WMS API

qimen.tmall.luxury.wms.order.return.send (天猫奢品消退单下发wms)

天猫奢品消退单下发wms

公共参数

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
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。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
ownerUserId	String	必须	14544		货主ID
ownerUserName	String	可选	123456789		货主名称
storeCode	String	必须	4563		仓储编码
orderCode	String	必须	1255		仓储中心销退单编码
orderType	Number	必须	302		单据类型： 302调拨入库单 501销退入库单 601采购入库单 904普通入库单306 B2B入库单 604 B2B干线退货入库 704 库存状态调整入库
inboundTypeDesc	String	可选	加工归还		自定义文本透传至WMS 加工归还委外归还借出归还内部归还
orderFlag	String	可选	9		仓库订单需要履行服务标识适用如下场景：退货入库: 8:退换货 9:上门服务 13: 退货收取发票 31：退货入库 36：退货时同时换货 41:拦截退回其他单据忽略
orderSource	Number	可选	201		适用如下场景：退货入库: 订单来源（213 天猫，201 淘宝，214 京东，202 1688 阿里中文站，203 苏宁在线，204 亚马逊中国，205 当当，208 1号店，207 唯品会，209 国美在线，210 拍拍，206 易贝ebay，211 聚美优品，212 乐蜂网，215 邮乐，216 凡客，217 优购，218 银泰，219 易讯，221 聚尚网，222 蘑菇街，223 POS门店，301 其他不在范围之内请忽略）其他单据忽略
orderCreateTime	String	必须	123456789		订单创建时间(格式为 YYYY-MM-DD HH:mm:ss)
supplierCode	String	可选	123456789		供应商编码，往来单位编码适用如下场景：采购入库单
supplierName	String	可选	123456789		供应商名称，往来单位名称适用如下场景：采购入库单
tmsServiceCode	String	可选	123456789		配送公司编码适用如下场景：销退买家拒签：原发货单的配送公司编码；销退上门取件，消费者退货，商家下单：新生成的运单号所属配送公司的编码
tmsServiceName	String	可选	123456789		配送公司名称适用如下场景：销退买家拒签：原发货单的配送公司名称销退上门取件，消费者退货，商家下单：新生成的运单号所属配送公司的名称
tmsOrderCode	String	可选	123456789		运单号适用如下场景：销退买家拒签：原发货单的运单号销退上门取件，消费者退货，商家下单：新生成的运单号
prevOrderCode	String	可选	123456789		原仓储作业单号适用如下场景：销退入库单：原发货单号，注意：原发货单可能是其他仓库发出
returnReason	String	可选	123456789		退货原因：销退场景下，如可能请提供退货的原因，多个退货原因用；号分开
batchSendCtrlParam	BatchSendCtrlParam	可选			分批下发控制参数
└ distributeType Number 可选 123456789 是否分批下发: 0 最后一次下发 1 多次发送 └ totalOrderItemCount Number 可选 123456789 下发总共ITEM数
senderInfo	SenderInfo	必须			发件方信息
└ senderPhone String 可选 123456789 发件人电话，手机和电话不会同时为空 └ senderMobile String 可选 123456789 发件人手机，手机和电话不会同时为空 └ senderEmail String 可选 123456789 发送方电子邮件 └ senderName String 必须 123456789 发件方名称 └ senderDivisionId String 可选 123456789 发件方最小区划ID └ senderAddress String 必须 123456789 发件方详情地址，不包含省、市、区、街道信息 └ senderTown String 可选 123456789 发件方镇村 └ senderArea String 可选 123456789 发件方区县，市与区不会同时为空 └ senderCity String 可选 123456789 发件方城市，市与区不会同时为空 └ senderProvince String 可选 123456789 发件方省份国际地址可能没有 └ senderCountry String 可选 123456789 发件方国家 └ senderZipCode String 可选 123456789 发件方邮编
receiverInfo	ReceiverInfo	必须			收货方信息一般是本地语言
└ receiverPhone String 可选 123456789 收件人电话，手机和电话不会同时为空 └ receiverMobile String 可选 123456789 收件人手机，手机和电话不会同时为空 └ receiverWangwang String 可选 123456789 收件人旺旺 └ buyerId String 可选 123456789 买家id └ receiverNick String 可选 123456789 收件人昵称 └ receiverName String 必须 123456789 收件人名称 └ receiverAddress String 必须 123456789 收件方详情地址，不包含省、市、区、街道信息 └ receiverDivisionId String 可选 123456789 收件方最小区划ID，四级地址ID └ receiveTown String 可选 123456789 收件方镇 └ receiverArea String 可选 123456789 收件方区县，市与区不会同时为空 └ receiverCity String 可选 123456789 收件方城市，市与区不会同时为空 └ receiverProvince String 可选 123456789 收件方省份国际地址可能没有 └ receiverCountry String 可选 123456789 收件方国家 └ receiverZipCode String 可选 123456789 收件方邮编
orderItemList	WmsStockInOrderItem []	必须		最大列表长度：999	入库单商品信息列表
└ provideUserNick String 可选 123456789 供应商昵称 └ provideUserID Number 可选 123456789 供应商id └ distributorUserNick String 可选 123456789 分销商昵称 └ distributorUserId Number 可选 123456789 分销商ID └ lgOrderId Number 可选 123456789 订单中心ID └ remark String 可选 123456789 备注信息 └ attribute String 可选 123456789 扩展字段，下发WMS └ features String 可选 123456789 商品销售属性 └ extendFields String 可选 123456789 拓展属性数据详见 └ itemPrice Number 可选 123456789 商品价格 └ pictureUrl String 可选 123456789 图片地址 └ batchRemark String 可选 123456789 批次备注 └ purchasePrice Number 可选 123456789 采购价 └ taxRate String 可选 123456789 税率，单位%，保留2位小数 └ purchaseOrderCode String 可选 123456789 采购单号 └ produceCode String 可选 123456789 生产编码，同一商品可能因商家不同有不同编码 └ produceDate String 可选 123456789 生产日期,保质期商品信息，如果商品启用了保质期管理，需要仓库按指定保质期生产 └ dueDate String 可选 123456789 到效日期,保质期商品信息，如果商品启用了保质期管理，需要仓库按指定保质期生产 └ batchCode String 可选 123456789 批次号 └ itemVersion Number 必须 123456789 商品版本，如果版本和WMS系统中的版本不一致，需要CP使用商品抓取接口，将最新的商品信息抓取下来 └ itemQuantity Number 必须 123456789 商品数量 └ inventoryType Number 必须 123456789 库存类型（1 可销售库存(正品) 101 残次 102 机损 103 箱损301 在途库存 201 冻结库存）注意：采购入库单下发的库存类型是301 └ barCode String 可选 123456789 条形码，多条码请用”;”分隔；仓库入库扫码使用 └ itemCode String 可选 123456789 商家对商品的编码 └ itemName String 可选 123456789 商品名称 └ itemId String 必须 123456789 商品ID └ subSourceCode String 可选 123456789 平台子交易编码:只在销退订单时使用，原销售订单的子交易单号 └ orderSourceCode String 可选 123456789 平台交易编码：只在销退订单时使用，原销售订单的主交易单号 └ orderItemId String 必须 123456789 入库单明细ID
caseInfoList	WmsStockInCaseInfo []	可选		最大列表长度：999	装箱列表
caseItemList WmsStockInCaseItem [] 可选装箱明细列表 └ itemVersion Number 可选 122 商品版本 └ itemQuantity Number 可选 12 商品数量 └ inventoryType Number 可选 1 库存类型（1 可销售库存(正品) 101 残次 102 机损 103 箱损301 在途库存 201 冻结库存）注意：采购入库单下发的库存类型是301 └ barCode String 可选 480399 条形码，多条码请用”;”分隔；仓库入库扫码使用 └ itemCode String 可选 137903 商家对商品的编码 └ itemName String 可选 **** 商品名称 └ itemId String 可选 4729200 商品ID └ height Number 可选 33 高单位 mm └ width Number 可选 12 宽单位 mm └ length Number 可选 44 长单位 mm └ volume Number 可选 233 体积单位立方厘米 └ weight Number 可选 34 重量单位克 └ containerNumber String 可选 4729200 集装箱编号 └ palletNumebr String 可选 470302 托盘号 └ caseSequence String 可选 8302 箱编码 └ caseNumber String 可选 8302 箱号
timeZone	String	可选	123456789		时区格式如 +0800
currency	String	可选	123456789		币种如CNY USD
extendFields	String	可选	123456789		附带透传属性列表,支持下发仓，做扩展支持
driverInfo	DriverInfo	可选			装车信息
└ licensePlate String 可选 123456789 车牌号 └ vehicleLoad Number 可选 123456789 车辆最大负荷 └ vehicleType Number 可选 123456789 车辆类型 0:普通货车，1:平板车，2:箱式货车，3:冷藏车 └ driverPhone String 可选 123456789 电话 └ driverIdentityId String 可选 123456789 身份证号 └ driverName String 可选 123456789 送货人
remark	String	可选	123456789		备注:销退时留言备注填充到此字段
properties	String	可选	123456789		公共扩展属性
privateProperties	String	可选	123456789		私有扩展属性，不会透传WMS
serviceItemId	String	可选	123456789		服务商品ID
bizLine	Number	可选	123456789		F_PL(1,"4PL") T_PL(2,"3PL") MLH(3,"魅力惠")
prevOrderCodeList	String []	可选		最大列表长度：999	原发货单列表，用于合单销退场景
serviceFee	Number	可选	123456789		服务费用
ffService	String	可选	123456789		履行服务
printFlagInfo	String	可选	123456789		打印清单备注

响应参数

名称	类型	示例值	描述
result	ResultDO		结果
└ errorMessage String 报文解析异常错误信息 └ errorCode String 1234 错误码 └ success Boolean false 是否正常 └ data String 11 返回数据

请求示例

{"batchSendCtrlParam":{"distributeType":123456789,"totalOrderItemCount":123456789},"orderType":302,"orderItemList":[{"distributorUserId":123456789,"dueDate":"123456789","itemCode":"123456789","remark":"123456789","purchasePrice":123456789,"features":"123456789","produceCode":"123456789","produceDate":"123456789","itemName":"123456789","purchaseOrderCode":"123456789","extendFields":"123456789","orderSourceCode":"123456789","attribute":"123456789","inventoryType":123456789,"itemQuantity":123456789,"orderItemId":"123456789","pictureUrl":"123456789","batchCode":"123456789","itemVersion":123456789,"provideUserNick":"123456789","subSourceCode":"123456789","distributorUserNick":"123456789","barCode":"123456789","taxRate":"123456789","itemId":"123456789","lgOrderId":123456789,"batchRemark":"123456789","provideUserID":123456789,"itemPrice":123456789}],"receiverInfo":{"receiverWangwang":"123456789","receiverName":"123456789","receiverMobile":"123456789","receiverArea":"123456789","receiverProvince":"123456789","buyerId":"123456789","receiverCity":"123456789","receiverNick":"123456789","receiverAddress":"123456789","receiverDivisionId":"123456789","receiverPhone":"123456789","receiverCountry":"123456789","receiverZipCode":"123456789","receiveTown":"123456789"},"inboundTypeDesc":"加工归还","remark":"123456789","supplierCode":"123456789","bizLine":123456789,"tmsServiceCode":"123456789","tmsOrderCode":"123456789","driverInfo":{"licensePlate":"123456789","vehicleLoad":123456789,"driverPhone":"123456789","driverIdentityId":"123456789","driverName":"123456789","vehicleType":123456789},"printFlagInfo":"123456789","returnReason":"123456789","extendFields":"123456789","ownerUserName":"123456789","prevOrderCodeList":[""],"currency":"123456789","supplierName":"123456789","serviceItemId":"123456789","serviceFee":123456789,"orderSource":201,"orderCreateTime":"123456789","timeZone":"123456789","tmsServiceName":"123456789","privateProperties":"123456789","ffService":"123456789","senderInfo":{"senderPhone":"123456789","senderName":"123456789","senderAddress":"123456789","senderTown":"123456789","senderEmail":"123456789","senderMobile":"123456789","senderProvince":"123456789","senderDivisionId":"123456789","senderZipCode":"123456789","senderCountry":"123456789","senderCity":"123456789","senderArea":"123456789"},"caseInfoList":[{"volume":233,"caseSequence":"8302","containerNumber":"4729200","caseNumber":"8302","width":12,"length":44,"weight":34,"palletNumebr":"470302","caseItemList":[{"itemId":"4729200","inventoryType":1,"itemName":"****","itemQuantity":12,"itemVersion":122,"itemCode":"137903","barCode":"480399"}],"height":33}],"ownerUserId":"14544","orderFlag":"9","orderCode":"1255","prevOrderCode":"123456789","properties":"123456789","storeCode":"4563"}

响应示例

{
    "result":{
        "errorMessage":"报文解析异常",
        "errorCode":"1234",
        "success":false,
        "data":"11"
    }
}

验签示例

{"result":{"success":"false","errorMessage":"Illegal request","errorCode":"sign-check-failure"}}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

淘宝开放平台

SCM WMS API

qimen.tmall.luxury.wms.order.return.send (天猫奢品消退单下发wms)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ