文档中心 > API类目 > 魅力惠API

qimen.tmall.luxury.order.stock.out (天猫奢品出库通知单下发)

天猫奢品出库通知单下发到wms通过该API将退仓单出库的信息下发

公共参数

请求地址：

环境	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	最大长度：20	货主ID
ownerUserName	String	可选	天猫奢品	最大长度：64	货主名称
storeCode	String	必须	4563	最大长度：64	仓储编码
orderCode	String	必须	1255	最大长度：64	仓储中心入库订单编码
wlbOrderCode	String	可选	230293	最大长度：64	用于分批控制；分批下发第一次留空，接下来几次都填第一次返回的LBX订单
orderType	Number	必须	301		操作类型：301 调拨出库单 901 普通出库单 (如货主拉走一部分货) 305 B2B出库单 703 库存状态调整出库 701 (大家电)盘点出库
isFinished	Boolean	可选	TRUE		用于分批控制；如果是分批下发前几次都是false 最后一次传true
outboundTypeDesc	String	可选	加工领料	最大长度：2000	自定义文本透传至WMS 加工领料委外领料借出领用内部领用
orderFlag	String	可选	9	最大长度：64	仓库订单需要履行服务标识
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	必须	2018-01-01 00:00:00	默认值：YYYY-MM-DD HH:MM:SS 最大长度：19	订单创建时间(格式为 YYYY-MM-DD HH:mm:ss)
sendTime	String	可选	2020-01-01 00:00:00	默认值：YYYY-MM-DD HH:MM:SS 最大长度：19	要求出库时间(格式为 YYYY-MM-DD HH:mm:ss)
tmsServiceCode	String	可选	ZTO	最大长度：64	配送公司编码适用如下场景：销退买家拒签：原发货单的配送公司编码；销退上门取件消费者退货商家下单：新生成的运单号所属配送公司的编码
tmsServiceName	String	可选	中通	最大长度：64	配送公司名称适用如下场景：销退买家拒签：原发货单的配送公司名称销退上门取件消费者退货商家下单：新生成的运单号所属配送公司的名称
supplierCode	String	可选	379272010	最大长度：64	供应商编码，往来单位编码适用如下场景：退仓出库单
supplierName	String	可选	上海魅力惠贸易有限公司	最大长度：64	供应商名称，往来单位名称适用如下场景：退仓出库单
prevOrderCode	String	可选	18202833002	最大长度：64	前置订单号
transportMode	String	可选	自提	最大长度：64	出库方式（自提 /非自提）
pickName	String	可选	王老五	最大长度：64	取件人姓名
pickCall	String	可选	13888888888	最大长度：64	取件人电话
pickTel	String	可选	021-11211121	最大长度：64	取件人固定电话
pickCompany	String	可选	魅力惠上海贸易有限公司	最大长度：64	取件公司名称
carriersName	String	可选	顺丰快递	最大长度：64	承运商名称
pickId	String	可选	121111111111111	最大长度：64	取件人身份证
carNo	String	可选	沪A88888	最大长度：64	车牌号
receiverInfo	ReceiverInfo	可选			收货人信息
└ receiverZipCode String 可选 100010 收件方邮编 └ receiverCountry String 可选中国收件方国家 └ receiverProvince String 可选北京市收件方省份国际地址可能没有 └ receiverCity String 可选北京市收件方城市市与区不会同时为空 └ receiverArea String 可选朝阳区收件方区县市与区不会同时为空 └ receiveTown String 可选紫禁城收件方镇 └ receiverDivisionId String 可选 3232323 收件方最小区划ID 四级地址ID └ receiverAddress String 必须宣武门3212号收件方详情地址不包含省、市、区、街道信息 └ receiverName String 必须老王收件人名称 └ receiverMobile String 可选 13888888888 收件人手机手机和电话不会同时为空 └ receiverPhone String 可选 010-88888888 收件人电话手机和电话不会同时为空
senderInfo	SenderInfo	可选			发货人信息
└ senderZipCode String 可选 938900 发件方邮编 └ senderCountry String 可选中国发件方国家 └ senderProvince String 可选四川发件方省份国际地址可能没有 └ senderCity String 可选成都发件方城市 └ senderArea String 可选金牛发件方区县 └ senderTown String 可选未央区发件方镇 └ senderAddress String 必须溪望路888号发件方地址 └ senderDivisionId String 可选 32320323 发件方最小区划ID └ senderName String 必须张三发件方名称（采购入库放供应商名称）（销退入库填买家名称）（调拨入库填写调拨出库仓库联系人名称） └ senderMobile String 可选 13988003833 发件方手机手机和电话不能同时为空 └ senderPhone String 可选 028-28200288 发件方电话手机和电话不能同时为空
reasonType	String	可选	7天无理由退货	最大长度：64	原因
timeZone	String	可选	+0800	最大长度：16	时区
currency	String	可选	CNY	最大长度：8	币种
extendFields	String	可选	{aa:bb}	最大长度：2000	拓展属性数据 JSON字符串
driverInfo	DriverInfo	可选			送货人信息
└ driverName String 可选老张送货人 └ driverIdentityId String 可选 100100101011100101 身份证号 └ driverPhone String 可选 13888888888 电话 └ vehicleType Number 可选 0 车辆类型 0:普通货车 1:平板车 2:箱式货车 3:冷藏车 └ vehicleLoad Number 可选 3000 车辆最大负荷 └ licensePlate String 可选沪A88888 车牌号
remark	String	可选	7天无理由退货	最大长度：2000	备注:销退时留言备注填充到此字段
batchSendCtrlParam	BatchSendCtrlParam	可选			分批下发控制信
└ totalOrderItemCount Number 必须 1688 下发总共ITEM数 └ distributeType Number 必须 1 是否分批下发: 0 最后一次下发 1 多次发送
orderItemList	WmsStockOutOrderItem []	必须		最大列表长度：999999	出库单明细列表
└ orderItemId String 必须 5642 出库单明细ID └ itemId String 必须 4729200 商品ID └ orderSourceCode String 可选 8302 平台交易编码 └ subSourceCode String 可选 470302 平台子交易编码 └ itemName String 可选 iPhone4S 移动3G版商品名称 └ itemCode String 可选 137903 商家对商品的编码 └ barCode String 可选 480323 条形码多条码请用”;”分隔；仓库入库扫码使用 └ inventoryType Number 必须 1 库存类型（1 可销售库存(正品) 101 残次 102 机损 103 箱损301 在途库存 201 冻结库存）注意：采购入库单下发的库存类型是301 └ itemQuantity Number 必须 12 商品数量 └ itemVersion Number 必须 122 商品版本如果版本和WMS系统中的版本不一致需要CP使用商品抓取接口将最新的商品信息抓取下来 └ batchCode String 可选 4 批次号 └ dueDate String 可选 2020-01-01 到效日期保质期商品信息如果商品启用了保质期管理需要仓库按指定保质期生产格式为 YYYY-MM-DD └ produceDate String 可选 2018-01-01 生产日期保质期商品信息如果商品启用了保质期管理需要仓库按指定保质期生产格式为 YYYY-MM-DD └ produceCode String 可选 739300 生产编码同一商品可能因商家不同有不同编码 └ purchaseOrderCode String 可选 PO19040113243435434343 采购单号 └ batchRemark String 可选 **** 批次备注 └ itemPrice Number 可选 3232323 价格 └ extendFields String 可选 {aa:bb} 拓展属性数据 JSON字符串

响应参数

名称	类型	示例值	描述
result	ResultDO		结果
└ success Boolean true 是否成功 └ errorCode String 200 错误码 └ errorMessage String xxx错误信息错误信息 └ data String 成功了返回数据

请求示例

{"batchSendCtrlParam":{"distributeType":1,"totalOrderItemCount":1688},"orderType":301,"orderItemList":[{"inventoryType":1,"itemQuantity":12,"orderItemId":"5642","itemCode":"137903","itemVersion":122,"batchCode":"4","dueDate":"2020-01-01","subSourceCode":"470302","barCode":"480323","itemId":"4729200","produceCode":"739300","itemName":"iPhone4S 移动3G版","produceDate":"2018-01-01","purchaseOrderCode":"PO19040113243435434343","batchRemark":"****","orderSourceCode":"8302","extendFields":"{aa:bb}","itemPrice":3232323}],"receiverInfo":{"receiverAddress":"宣武门3212号","receiverDivisionId":"3232323","receiverZipCode":"100010","receiverCountry":"中国","receiverPhone":"010-88888888","receiveTown":"紫禁城","receiverName":"老王","receiverMobile":"13888888888","receiverProvince":"北京市","receiverArea":"朝阳区","receiverCity":"北京市"},"pickId":"121111111111111","remark":"7天无理由退货","supplierCode":"379272010","reasonType":"7天无理由退货","tmsServiceCode":"ZTO","driverInfo":{"licensePlate":"沪A88888","vehicleLoad":3000,"driverName":"老张","driverIdentityId":"100100101011100101","driverPhone":"13888888888","vehicleType":0},"carNo":"沪A88888","extendFields":"{aa:bb}","ownerUserName":"天猫奢品","currency":"CNY","carriersName":"顺丰快递","supplierName":"上海魅力惠贸易有限公司","orderSource":201,"orderCreateTime":"2018-01-01 00:00:00","pickName":"王老五","timeZone":"+0800","tmsServiceName":"中通","isFinished":true,"wlbOrderCode":"230293","sendTime":"2020-01-01 00:00:00","pickTel":"021-11211121","outboundTypeDesc":"加工领料","senderInfo":{"senderPhone":"028-28200288","senderTown":"未央区","senderAddress":"溪望路888号","senderName":"张三","senderMobile":"13988003833","senderProvince":"四川","senderDivisionId":"32320323","senderZipCode":"938900","senderCountry":"中国","senderCity":"成都","senderArea":"金牛"},"ownerUserId":"14544","orderFlag":"9","transportMode":"自提","orderCode":"1255","pickCall":"13888888888","prevOrderCode":"18202833002","pickCompany":"魅力惠上海贸易有限公司","storeCode":"4563"}

响应示例

{
    "result":{
        "success":true,
        "errorCode":"200",
        "errorMessage":"xxx错误信息",
        "data":"成功了"
    }
}

验签示例

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

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

开放平台

魅力惠API

qimen.tmall.luxury.order.stock.out (天猫奢品出库通知单下发)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ