阿里大于 -

请求地址：

环境	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输入参数签名结果，签名算法介绍请点击这里。

名称	类型	是否必须	示例值	更多限制	描述
request	ReturnOrderCreateRequest	可选			请求
└ extendProps String 可选 {"key":"value"} 扩展属性;json序列化格式 returnOrder ReturnOrder 可选退货单信息 └ actionType String 可选 add 操作类型 └ buyerNick String 可选淘宝买家昵称 └ earliestArrivalTime String 可选 2024-01-01 12:00:00 最早到达时间 └ expressCode String 可选 YD1234 运单号 └ logisticsCode String 必须 SF 物流公司编码(SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通、ZTO=中通(ZTO)、HTKY=百世汇通、UC=优速、STO=申通、TTKDEX=天天快递、QFKD=全峰、FAST=快捷、POSTB=邮政小包、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、AMAZON=亚马逊物流、OTHER=其他;只传英文编码) └ logisticsName String 可选顺丰物流公司名称 └ orderConfirmTime String 可选 2024-01-01 12:00:00 订单确认时间 └ orderFlag String 可选 VISIT 订单标记列表(多个用^隔开;VISIT=上门;SELLER_AFFORD=是否卖家承担运费;SYNC_RETURN_BILL=同时退回发票) └ orderType String 可选 THRK 单据类型(THRK=退货入库;HHRK=换货入库;只传英文编码) └ outBizCode String 可选 OB123 外部业务编码 └ ownerCode String 可选 HZ123 货主编码 └ planArrivalTime String 可选 2024-01-01 12:00:00 计划到达时间 └ preDeliveryOrderCode String 必须 PD1234 原出库单号(ERP分配) └ preDeliveryOrderId String 可选 PDI1234 原出库单号(WMS分配) └ refOrderCode String 可选 RO123 关联订单编码 └ remark String 可选备注信息备注 └ returnOrderCode String 必须 R1234 ERP的退货入库单编码 └ returnOrderId String 可选 RID123 退货单ID └ returnOrderStatus String 可选 NEW 退货单状态 └ returnReason String 可选破损退货退货原因 └ sellerNick String 可选卖家名称卖家名称 senderInfo SenderInfo 可选发件人信息 └ area String 可选余杭区域 └ birthDate String 可选 1990-01-01 出生日期 └ carNo String 可选 XA1234 车牌号 └ career String 可选 IT 职业 └ city String 必须杭州城市 └ company String 可选淘宝公司名称 └ countryCode String 可选 051532 国家二字码 └ countryCodeCiq String 可选 CN 国检国家编码 └ countryCodeCus String 可选 CN 海关国家编码 └ detailAddress String 必须杭州市余杭区989号详细地址 └ email String 可选 345@gmail.com 电子邮箱 └ fax String 可选 0571-88888 传真 └ gender String 可选 M 性别 └ id String 可选 476543213245733 证件号 └ idNumber String 可选 330106199001011234 身份证号 └ idType String 可选 1 证件类型 └ mobile String 必须 13214567869 移动电话 └ name String 必须老王姓名 └ nick String 可选小王昵称 └ province String 必须浙江省省份 └ remark String 可选备注信息备注 └ tel String 可选 81020340 固定电话 └ town String 可选横加桥村镇 └ zipCode String 可选 043300 邮编 └ extendProps String 可选 {"key":"value"} 发件人扩展信息;json序列化格式 └ shopNick String 可选店铺名称店铺名称 └ sourceOrderCode String 可选 SO123 来源订单编码 └ sourcePlatformCode String 可选 TB 订单来源平台编码(TB=淘宝;TM=天猫;JD=京东;DD=当当;PDD=拼多多;OTHERS=其他) └ sourcePlatformName String 可选淘宝订单来源平台名称 └ supplierCode String 可选 GY123 供应商编码 └ supplierName String 可选淘宝供应商名称 └ warehouseCode String 必须 W1234 仓库编码(统仓统配等无需ERP指定仓储编码的情况填OTHER) └ extendProps String 可选 {"key":"value"} 退货单信息扩展字段;json序列化格式 itemList Item [] 可选商品信息列表 └ actualAmount String 可选 100.00 实际金额 └ actualQty String 可选 100 实际数量 └ adventLifecycle Number 可选 1 保质期临期预警天数 └ amount String 可选 100.00 金额 └ approvalNumber String 可选 PB123 批准文号 └ barCode String 可选 T1;T2 条形码(可多个;用分号;隔开) └ batchCode String 可选 P1234 批次代码 └ batchRemark String 可选备注信息批次备注 batchs Batch [] 可选批次信息 └ actualQty String 可选 100 实际数量 └ batchCode String 可选 B20240101 批次代码 └ expireDate String 可选 2025-01-01 过期日期 └ inventoryType String 可选 ZP 库存类型 └ produceCode String 可选 SC20240101 生产编码 └ productDate String 可选 2024-01-01 生产日期 └ quantity String 可选 100 数量 └ extendProps String 可选 {"key":"value"} 扩展属性;json序列化格式 └ brandCode String 可选 LAL 品牌代码 └ brandName String 可选 HM 品牌名称 └ categoryId String 可选 LB123 商品类别ID └ categoryName String 可选手机商品类别名称 └ changeTime String 可选 2024-01-01 12:00:00 变更时间 └ channelCode String 可选 123 渠道变量 └ color String 可选红色颜色 └ costPrice String 可选 12.0 成本价 └ defectiveQty String 可选 5 残次品数量 └ diffQuantity String 可选 5 差异数量 └ discount String 可选 0.85 折扣 └ discountPrice String 可选 85.00 折扣价 └ englishName String 可选 EN123 英文名 └ exCode String 可选 EX123 扩展编码 └ expireDate String 可选 2016-09-09 过期日期(YYYY-MM-DD) └ extCode String 可选 EC123 扩展编码 └ goodsCode String 可选 H1234 货号 └ grossWeight String 可选 12.0 毛重(单位：千克) └ height String 可选 12.0 高(单位：厘米) └ inventoryType String 可选 ZP 库存类型 └ isAreaSale String 可选 N 是否区域销售 └ isBatchMgmt String 可选 N 是否需要批次管理(Y/N;默认为N) └ isFragile String 可选 N 是否易碎品(Y/N;默认为N) └ isHazardous String 可选 N 是否危险品(Y/N;默认为N) └ isSNMgmt String 可选 N 是否需要串号管理(Y/N;默认为N) └ isShelfLifeMgmt String 可选 N 是否需要保质期管理(Y/N;默认为N) └ isSku String 可选 N 是否sku(Y/N;默认为N) └ itemCode String 可选 I1234 商品编码 └ itemId String 可选 WI1234 仓储系统商品编码 └ itemName String 可选 SN123 商品名称 └ itemType String 可选 ZC 商品类型(ZC=正常商品;FX=分销商品;ZH=组合商品;ZP=赠品;BC=包材;HC=耗材;FL=辅料;XN=虚拟品;FS=附属品;CC=残次品;OTHER=其它) └ lackQty String 可选 0 缺货数量 └ latestUpdateTime String 可选 2024-01-01 12:00:00 最近更新时间 └ length String 可选 12.0 长(单位：厘米) └ lockQuantity String 可选 10 锁定数量 └ lockupLifecycle Number 可选 1 保质期禁售天数 └ netWeight String 可选 12.0 净重(单位：千克) └ normalQty String 可选 90 正常数量 └ orderCode String 可选 ORD123 订单编码 └ orderLineNo String 可选 1 订单行号 └ orderType String 可选 JYCK 订单类型 └ originAddress String 可选 HK 商品的原产地 └ originCode String 可选 CN 原产地编码 └ outBizCode String 可选 OB123 外部业务编码 └ ownerCode String 可选 HZ123 货主编码 └ packCode String 可选 B12 包装代码 └ packageMaterial String 可选 BX123 商品包装材料类型 └ paperQty String 可选 1 纸质单证数量 └ pcs String 可选 XG123 箱规 └ planQty String 可选 100 计划数量 └ price String 可选 100.00 价格 priceAdjustment PriceAdjustment 可选价格优惠 └ discount String 可选 0.85 折扣 └ endDate String 可选 2025-12-31 结束日期 └ remark String 可选备注备注 └ standardPrice String 可选 100.00 标准价格 └ startDate String 可选 2025-01-01 开始日期 └ type String 可选 FIXED 价格调整类型 └ pricingCategory String 可选手机类计价货类 └ produceCode String 可选 SC20240101 生产编码 └ productCode String 可选 PC123 产品编码 └ productDate String 可选 2016-09-09 生产日期(YYYY-MM-DD) └ purchasePrice String 可选 12.0 采购价 └ quantity String 可选 100 数量 └ reason String 可选入库原因 └ receiveQty String 可选 95 收货数量 └ referencePrice String 可选 99.00 参考价格 └ rejectLifecycle Number 可选 1 保质期禁收天数 └ remark String 可选备注信息备注 └ retailPrice String 可选 12.0 零售价 └ safetyStock Number 可选 12 安全库存 └ seasonCode String 可选 CHUN 季节编码 └ seasonName String 可选春季季节名称 └ shelfLife Number 可选 1 保质期(单位：小时) └ shortName String 可选 JC123 商品简称 └ size String 可选 5英尺尺寸 └ skuProperty String 可选红色商品属性(如红色;XXL) └ sn String 可选 SN123456 序列号 └ snCode String 可选 SN123456 串号编码 └ sourceOrderCode String 可选 SO123 来源订单编码 └ standardPrice String 可选 100.00 标准价格 └ stockStatus String 可选 NORMAL 库存状态 └ stockUnit String 可选个商品计量单位 └ subSourceOrderCode String 可选 SSO123 子来源订单编码 └ supplierCode String 可选 GY123 供应商编码 └ supplierName String 可选淘宝供应商名称 └ tagPrice String 可选 12.0 吊牌价 └ tareWeight String 可选 0.5 皮重 └ tempRequirement String 可选常温温度要求 └ title String 可选淘公仔渠道中的商品标题 └ unit String 可选个单位 └ volume String 可选 12.0 体积(单位：升) └ warehouseCode String 可选 CK1234 仓库编码 └ width String 可选 12.0 宽(单位：厘米) └ extendProps String 可选 {"key":"value"} 扩展属性;json序列化格式 orderLines OrderLine [] 可选订单信息 └ actualPrice String 可选 100.00 实际价格 └ actualQty String 可选 10 实际数量 └ amount String 可选 100.00 金额 └ batchCode String 可选 P123 批次编码 batchs Batch [] 可选批次信息 └ actualQty String 可选 100 实际数量 └ batchCode String 可选 B20240101 批次代码 └ expireDate String 可选 2025-01-01 过期日期 └ inventoryType String 可选 ZP 库存类型 └ produceCode String 可选 SC20240101 生产编码 └ productDate String 可选 2024-01-01 生产日期 └ quantity String 可选 100 数量 └ extendProps String 可选 {"key":"value"} 扩展属性;json序列化格式 └ color String 可选红色颜色 └ deliveryOrderId String 可选 DI123 发货单ID └ discount String 可选 0.85 折扣 └ discountAmount String 可选 15.00 折扣金额 └ discountPrice String 可选 85.00 折扣价 └ exceptionQty String 可选 0 异常数量 └ expireDate String 可选 2016-09-09 过期日期(YYYY-MM-DD) └ extCode String 可选 EC123 扩展编码 └ inventoryType String 可选 ZP 库存类型(ZP=正品;CC=残次;JS=机损;XS=箱损;默认为ZP) └ itemCode String 必须 I1234 商品编码 └ itemId String 可选 CK1234 仓储系统商品编码 └ itemName String 可选淘公仔商品名称 └ locationCode String 可选 L123 库位编码 └ moveInLocation String 可选 L234 移入库位 └ moveOutLocation String 可选 L123 移出库位 └ orderFlag String 必须 visit 订单标记列表(多个用^隔开;VISIT=上门;SELLER_AFFORD=是否卖家承担运费;SYNC_RETURN_BILL=同时退回发票) └ orderLineNo String 可选 D1234 单据行号 └ orderSourceCode String 可选 OS123 订单来源编码 └ outBizCode String 可选 OB123 外部业务编码 └ ownerCode String 必须 HZ1234 货主编码 └ payNo String 可选 PN123 支付单号 └ planQty Number 必须 12 应收商品数量 └ produceCode String 可选 P1234 生产批号 └ productCode String 可选 PC123 产品编码 └ productDate String 可选 2016-09-09 生产日期(YYYY-MM-DD) └ purchasePrice String 可选 12.0 采购价 └ qrCode String 可选 QR123 二维码 └ quantity String 可选 10 数量 └ referencePrice String 可选 99.00 参考价格 └ remark String 可选备注信息备注 └ retailPrice String 可选 12.0 零售价 └ returnReason String 必须破损退货退货原因 └ settlementAmount String 可选 100.00 结算金额 └ size String 可选 5英尺尺寸 └ skuProperty String 可选红色商品属性(如红色;XXL) snList SnList 可选 sn编码列表 └ sn String [] 可选 SN123456 sn编码 └ sourceOrderCode String 可选 PD1224 交易平台订单 └ standardAmount String 可选 100.00 标准金额 └ standardPrice String 可选 100.00 标准价格 └ status String 可选 NEW 状态 └ stockInQty String 可选 10 入库数量 └ stockOutQty String 可选 10 出库数量 └ subDeliveryOrderId String 可选 SDI123 子发货单ID └ subSourceCode String 可选 SS123 子来源编码 └ subSourceOrderCode String 可选 PL1234 交易平台子订单编码 └ taobaoItemCode String 可选 TB123 淘宝商品编码 └ warehouseCode String 可选 CK1234 仓库编码 └ extendProps String 可选 {"key":"value"} 订单信息扩展字段;json序列化格式

名称	类型	示例值	描述
response	ReturnOrderCreateResponse		返回
└ success Boolean true 是否成功: true-成功; false-失败 └ bizErrorCode String E0001 错误编码 └ bizErrorMsg String invalid app key 错误描述 └ returnOrderId String RID1234 仓储系统退货单编码

{"request":{"orderLines":[{"itemCode":"I1234","discount":"0.85","discountAmount":"15.00","purchasePrice":"12.0","itemName":"淘公仔","qrCode":"QR123","orderSourceCode":"OS123","deliveryOrderId":"DI123","inventoryType":"ZP","stockInQty":"10","subSourceCode":"SS123","productDate":"2016-09-09","batchs":[{"produceCode":"SC20240101","inventoryType":"ZP","quantity":"100","batchCode":"B20240101","extendProps":"{\"key\":\"value\"}","expireDate":"2025-01-01","actualQty":"100","productDate":"2024-01-01"}],"itemId":"CK1234","extCode":"EC123","size":"5英尺","sourceOrderCode":"PD1224","locationCode":"L123","status":"NEW","planQty":12,"color":"红色","actualPrice":"100.00","ownerCode":"HZ1234","discountPrice":"85.00","remark":"备注信息","stockOutQty":"10","actualQty":"10","warehouseCode":"CK1234","skuProperty":"红色","payNo":"PN123","produceCode":"P1234","referencePrice":"99.00","taobaoItemCode":"TB123","returnReason":"破损退货","extendProps":"{\"key\":\"value\"}","expireDate":"2016-09-09","amount":"100.00","orderLineNo":"D1234","quantity":"10","exceptionQty":"0","batchCode":"P123","standardPrice":"100.00","subDeliveryOrderId":"SDI123","subSourceOrderCode":"PL1234","moveOutLocation":"L123","standardAmount":"100.00","productCode":"PC123","outBizCode":"OB123","moveInLocation":"L234","snList":{"sn":["SN123456"]},"orderFlag":"visit","settlementAmount":"100.00","retailPrice":"12.0"}],"extendProps":"{\"key\":\"value\"}","returnOrder":{"orderType":"THRK","buyerNick":"淘宝","ownerCode":"HZ123","remark":"备注信息","supplierCode":"GY123","sourcePlatformName":"淘宝","warehouseCode":"W1234","shopNick":"店铺名称","preDeliveryOrderId":"PDI1234","returnReason":"破损退货","expressCode":"YD1234","returnOrderId":"RID123","extendProps":"{\"key\":\"value\"}","planArrivalTime":"2024-01-01 12:00:00","sellerNick":"卖家名称","supplierName":"淘宝","refOrderCode":"RO123","preDeliveryOrderCode":"PD1234","logisticsCode":"SF","orderConfirmTime":"2024-01-01 12:00:00","returnOrderStatus":"NEW","logisticsName":"顺丰","actionType":"add","earliestArrivalTime":"2024-01-01 12:00:00","senderInfo":{"zipCode":"043300","career":"IT","gender":"M","city":"杭州","countryCodeCus":"CN","remark":"备注信息","idNumber":"330106199001011234","nick":"小王","province":"浙江省","carNo":"XA1234","countryCode":"051532","extendProps":"{\"key\":\"value\"}","company":"淘宝","tel":"81020340","id":"476543213245733","fax":"0571-88888","email":"345@gmail.com","area":"余杭","idType":"1","town":"横加桥","mobile":"13214567869","birthDate":"1990-01-01","name":"老王","detailAddress":"杭州市余杭区989号","countryCodeCiq":"CN"},"outBizCode":"OB123","returnOrderCode":"R1234","sourcePlatformCode":"TB","sourceOrderCode":"SO123","orderFlag":"VISIT"},"itemList":[{"orderType":"JYCK","reason":"入库","originAddress":"HK","discount":"0.85","pricingCategory":"手机类","itemName":"SN123","packCode":"B12","price":"100.00","brandCode":"LAL","height":"12.0","safetyStock":12,"seasonCode":"CHUN","paperQty":"1","productDate":"2016-09-09","stockUnit":"个","itemId":"WI1234","size":"5英尺","rejectLifecycle":1,"shortName":"JC123","planQty":"100","ownerCode":"HZ123","defectiveQty":"5","diffQuantity":"5","supplierCode":"GY123","tempRequirement":"常温","skuProperty":"红色","referencePrice":"99.00","exCode":"EX123","normalQty":"90","seasonName":"春季","packageMaterial":"BX123","expireDate":"2016-09-09","sn":"SN123456","shelfLife":1,"orderLineNo":"1","actualAmount":"100.00","latestUpdateTime":"2024-01-01 12:00:00","costPrice":"12.0","tagPrice":"12.0","isSku":"N","changeTime":"2024-01-01 12:00:00","productCode":"PC123","width":"12.0","goodsCode":"H1234","retailPrice":"12.0","tareWeight":"0.5","priceAdjustment":{"endDate":"2025-12-31","discount":"0.85","remark":"备注","standardPrice":"100.00","type":"FIXED","startDate":"2025-01-01"},"snCode":"SN123456","itemCode":"I1234","lockQuantity":"10","purchasePrice":"12.0","lackQty":"0","stockStatus":"NORMAL","originCode":"CN","brandName":"HM","inventoryType":"ZP","receiveQty":"95","barCode":"T1;T2","volume":"12.0","batchs":[{"produceCode":"SC20240101","inventoryType":"ZP","quantity":"100","batchCode":"B20240101","extendProps":"{\"key\":\"value\"}","expireDate":"2025-01-01","actualQty":"100","productDate":"2024-01-01"}],"netWeight":"12.0","unit":"个","extCode":"EC123","sourceOrderCode":"SO123","isSNMgmt":"N","lockupLifecycle":1,"englishName":"EN123","itemType":"ZC","color":"红色","adventLifecycle":1,"discountPrice":"85.00","remark":"备注信息","title":"淘公仔","actualQty":"100","categoryName":"手机","warehouseCode":"CK1234","produceCode":"SC20240101","isShelfLifeMgmt":"N","isAreaSale":"N","extendProps":"{\"key\":\"value\"}","isFragile":"N","channelCode":"123","supplierName":"淘宝","isHazardous":"N","pcs":"XG123","amount":"100.00","quantity":"100","batchCode":"P1234","length":"12.0","standardPrice":"100.00","subSourceOrderCode":"SSO123","approvalNumber":"PB123","grossWeight":"12.0","isBatchMgmt":"N","batchRemark":"备注信息","outBizCode":"OB123","orderCode":"ORD123","categoryId":"LB123"}]}}

{
    "response":{
        "success":true,
        "bizErrorCode":"E0001",
        "bizErrorMsg":"invalid app key",
        "returnOrderId":"RID1234"
    }
}

{"response":{"bizErrorMsg":"Illegal request","success":"false","bizErrorCode":"sign-check-failure"}}

错误码	错误描述	解决方案

错误码查询工具 SDK下载

阿里健康API

qimen.alibaba.alihealth.wms.returnorder.create (销退入库单下发)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ