文档中心 > API类目 > 银泰开放平台

qimen.alibaba.mos.order.retrun.create (银泰-履约-退货入仓)

场景：用户拒收后，快递原路返回仓库时，通知仓库进行收货。一笔订单可能有多笔退款，以returnOrderCode作为业务唯一标识。

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	更多限制	描述
returnOrder	ReturnOrder	必须		退款信息
└ orderType String 必须 THRK 单据类型(THRK=退货入库;HHRK=换货入库;只传英文编码) └ orderFlag String 可选 VISIT 用字符串格式来表示订单标记列表(比如VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL等;中间用“^”来隔开订单标记list (所有字母全部大写) VISIT=上门；SELLER_AFFORD=是否卖家承担运费(默认是)SYNC_RETURN_BILL=同时退回发票) └ orderConfirmTime String 可选 2021 提交时间 └ logisticsName String 可选顺丰物流公司名称 └ logisticsCode String 可选 SF 物流公司编码 └ expressCode String 必须 YD1234 运单号 └ returnOrderCode String 必须 R1234 ERP的退货入库单编码 └ remark String 可选备注信息备注信息（一般为空） └ preDeliveryOrderCode String 必须 PD1234 发货单号 └ returnReason String 可选破损退货退货原因 └ warehouseCode String 必须 W1234 仓库编码 senderInfo Sender 可选发送人信息 └ detailAddress String 必须杭州市余杭区989号地址 └ city String 必须杭州城市 └ area String 可选余杭区域 └ name String 必须老王姓名 └ mobile String 必须电话移动电话 └ email String 可选邮箱邮箱 └ town String 可选镇村镇 └ tel String 可选 0951XXXXXX 电话 └ province String 必须浙江省省 └ zipCode String 可选 100000 邮编 └ refOrderCode String 可选 XXX ERP的订单号 └ preDeliveryOrderId String 可选 XXX 原出库单号(WMS分配) └ sourceOrderCode String 必须 WZ0179198740004 交易平台-订单查询-渠道订单号 └ supplierCode String 必须 124121 供应商编码
orderLines	OrderLine []	必须	最大列表长度：999	记录
└ warehouseCode String 可选 W1234 仓库编码 └ quantity String 必须 12 数量 └ planQty String 可选 12 应收商品数量 └ ownerCode String 可选 HZ1234 货主编码（门店-专柜) └ orderLineNo String 可选 D1234 单据行号 └ itemName String 可选 XXX 商品名称 └ itemId String 可选 CK1234 供应商商品编码(outId) └ itemCode String 必须 I1234 商品编码(银泰SKU） └ inventoryType String 可选 ZP 库存类型(ZP=正品;CC=残次;JS=机损;XS=箱损;默认为ZP) └ actualPrice String 可选 1200 正向销售金额，非退款金额，部分退时不会变化。

响应参数

名称	类型	示例值	描述
returnOrderId	String	111111111	仓储系统退货单编码
errorMsg	String	错误信息	错误信息
errorCode	String	错误编码	错误编码
success	Boolean	true	是否请求成功

请求示例

{"orderLines":[{"itemId":"CK1234","planQty":"12","orderLineNo":"D1234","itemName":"XXX","inventoryType":"ZP","quantity":"12","ownerCode":"HZ1234","actualPrice":"1200","itemCode":"I1234","warehouseCode":"W1234"}],"returnOrder":{"orderType":"THRK","refOrderCode":"XXX","preDeliveryOrderCode":"PD1234","logisticsCode":"SF","orderConfirmTime":"2021","remark":"备注信息","supplierCode":"124121","warehouseCode":"W1234","logisticsName":"顺丰","senderInfo":{"area":"余杭","zipCode":"100000","town":"镇","province":"浙江省","city":"杭州","name":"老王","mobile":"电话","detailAddress":"杭州市余杭区989号","tel":"0951XXXXXX","email":"邮箱"},"preDeliveryOrderId":"XXX","returnOrderCode":"R1234","returnReason":"破损退货","sourceOrderCode":"WZ0179198740004","orderFlag":"VISIT","expressCode":"YD1234"}}

响应示例

{
    "returnOrderId":"111111111",
    "errorMsg":"错误信息",
    "errorCode":"错误编码",
    "success":true
}

验签示例

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

错误码解释

错误码	错误描述	解决方案
response-body-parse-error

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部