简要描述:

  • 退货入库单确认

接口说明:

  • 1.1接口描述:WMS调用接口,回传退货入库单信息
  • 1.2接口说明:货品退货入库后,WMS将状态回传给 ERP, ERP 自行决定如何处理。
  • 1.3接口方法: taobao.qimen.returnorder.confirm

接口版本:

版本号 制定人 制定日期 修订日期
1.0.0 黄会准 2020-08-07 2020-08-07

请求URL:

环境 HTTP地址
测试环境 http://apitest.yptcgroup.com/thirdpart/dispatcher
预发布环境 http://apiuat.yptcgroup.com/thirdpart/dispatcher
正式环境 http://api.yptcgroup.com/thirdpart/dispatcher

请求头:

参数名 是否必须 类型 说明
Content-Type 是 string 请求类型,统一是 application/xml

请求参数:

公共请求参数

参数名 字段 是否必须 类型 长度 说明
WMS 的appkey app_key 是 String 应用接入时申请的 appkey
接口方法 method 是 String ERP 相关的业务接口名称,method= taobao.qimen.returnorder.confirm
协议版本号 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 格式

request

参数名 字段 是否必须 类型 说明
退货单信息 returnOrder 否 data 退货单信息
订单信息 orderLines 否 data[] 订单信息
扩展属性 extendProps 否 data 扩展属性

returnOrder

参数名 字段 是否必须 类型 说明
ERP的退货入库单编码 returnOrderCode 是 String ERP的退货入库单编码
仓库系统订单编码 returnOrderId 否 String 仓库系统订单编码
仓库编码 warehouseCode 否 String 仓库编码(统仓统配等无需ERP指定仓储编码的情况填OTHER)
外部业务编码 outBizCode 是 String 外部业务编码(消息ID;用于去重;ISV对于同一请求;分配一个唯一性的编码。用来保证因为网络等原因导致重复传输;请求不会 被重复处理)
单据类型 orderType 否 String 单据类型(THRK=退货入库;HHRK=换货入库;只传英文编码)
确认入库时间 orderConfirmTime 否 String 确认入库时间(YYYY-MM-DD HH:MM:SS)
物流公司编码 logisticsCode 是 String 物流公司编码(SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通、ZTO=中通(ZTO)、HTKY=百世汇通、 UC=优速、STO=申通、TTKDEX=天天快递、QFKD=全峰、FAST=快捷、POSTB=邮政小包、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、 AMAZON=亚马逊物流、OTHER=其他;只传英文编码)
支持出库单多次发货的状态位 confirmType 否 String 支持出库单多次发货的状态位
物流公司名称 logisticsName 否 String 物流公司名称
运单号 expressCode 否 String 运单号
退货原因 returnReason 否 String 退货原因
备注 remark 否 String 备注
发件人信息 senderInfo 否 data 发件人信息,节点下数据字段详见下述“senderInfo”

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

参数名 字段 是否必须 类型 说明
备注 remark 否 String 备注
单据行号 orderLineNo 否 String 单据行号
交易平台订单 sourceOrderCode 否 String 交易平台订单
交易平台子订单编码 subSourceOrderCode 否 String 交易平台子订单编码
货主编码 ownerCode 是 String 货主编码
商品编码 itemCode 否 String 商品编码
仓储系统商品编码 itemId 否 String 仓储系统商品编码(条件为提供后端(仓储系统)商品编码的仓储系统)
库存类型 inventoryType 否 String 库存类型(ZP=正品;CC=残次;JS=机损;XS=箱损;默认为ZP)
应收商品数量 planQty 是 long 应收商品数量
批次编码 batchCode 否 String 批次编码
商品生产日期 productDate 否 String 商品生产日期(YYYY-MM-DD)
商品过期日期 expireDate 否 String 商品过期日期(YYYY-MM-DD)
生产批号 produceCode 否 String 生产批号
批次信息 batchs 否 String 批次信息,节点下数据字段详见下述“batch”
商品的二维码 qrCode 否 String 商品的二维码(类似电子产品的SN码;用来进行商品的溯源;多个二维码之间用分号;隔开)
实收商品数量 actualQty 是 long 实收商品数量
sn编码列表 snList 否 data sn编码列表,节点下数据字段详见下述“snList”

batch

参数名 字段 是否必须 类型 说明
备注 remark 否 String 备注
批次编号 batchCode 否 String 批次编号
商品生产日期 productDate 否 String 商品生产日期(YYYY-MM-DD)
商品过期日期 expireDate 否 String 商品过期日期(YYYY-MM-DD)
生产批号 produceCode 否 String 生产批号
库存类型 inventoryType 否 String 库存类型
实发数量 actualQty 否 long 实发数量

snList

参数名 字段 是否必须 类型 说明
sn编码 sn 否 String[] sn编码

返回参数:

response

参数名 类型 说明
flag String 响应结果:success
code String 响应码
message String 响应信息
requestId String 查询返回的唯一编码

请求示例(xml)

<?xml version="1.0" encoding="UTF-8" ?>
<request>
    <returnOrder>
        <returnOrderCode>R1234</returnOrderCode>
        <returnOrderId>R1234</returnOrderId>
        <warehouseCode>W1234</warehouseCode>
        <outBizCode>OZ1234</outBizCode>
        <orderType>THRK</orderType>
        <orderConfirmTime>2016-09-09 12:00:00</orderConfirmTime>
        <logisticsCode>SF</logisticsCode>
        <logisticsName>顺丰</logisticsName>
        <expressCode>YD1234</expressCode>
        <returnReason>破损退货</returnReason>
        <remark>备注信息</remark>
        <senderInfo>
            <name>老王</name>
            <province>浙江省</province>
            <mobile>13214567869</mobile>
            <city>杭州</city>
            <detailAddress>杭州市余杭区989号</detailAddress>
        </senderInfo>
    </returnOrder>
    <orderLines>
        <orderLine>
            <remark>备注信息</remark>
            <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>
            <qrCode>1;1;1</qrCode>
            <actualQty>12</actualQty>
            <batchs>
                <batch>
                    <remark>备注信息</remark>
                    <batchCode>P123</batchCode>
                    <productDate>2016-09-09</productDate>
                    <expireDate>2016-09-09</expireDate>
                    <produceCode>P1234</produceCode>
                    <inventoryType>ZP</inventoryType>
                    <actualQty>2</actualQty>
                </batch>
                <batch>
                    <remark>备注信息</remark>
                    <batchCode>P123</batchCode>
                    <productDate>2016-09-09</productDate>
                    <expireDate>2016-09-09</expireDate>
                    <produceCode>P1234</produceCode>
                    <inventoryType>ZP</inventoryType>
                    <actualQty>7</actualQty>
                </batch>
                <batch>
                    <remark>备注信息</remark>
                    <batchCode>P123</batchCode>
                    <productDate>2016-09-09</productDate>
                    <expireDate>2016-09-09</expireDate>
                    <produceCode>P1234</produceCode>
                    <inventoryType>ZP</inventoryType>
                    <actualQty>3</actualQty>
                </batch>
            </batchs>
            <snList>
                <sn>S1</sn>
                <sn>C2</sn>
                <sn>X3</sn>
            </snList>
        </orderLine>
        <orderLine>
            <remark>备注信息</remark>
            <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>
            <qrCode>1;1;1</qrCode>
            <actualQty>12</actualQty>
            <batchs>
                <batch>
                    <remark>备注信息</remark>
                    <batchCode>P123</batchCode>
                    <productDate>2016-09-09</productDate>
                    <expireDate>2016-09-09</expireDate>
                    <produceCode>P1234</produceCode>
                    <inventoryType>ZP</inventoryType>
                    <actualQty>2</actualQty>
                </batch>
                <batch>
                    <remark>备注信息</remark>
                    <batchCode>P123</batchCode>
                    <productDate>2016-09-09</productDate>
                    <expireDate>2016-09-09</expireDate>
                    <produceCode>P1234</produceCode>
                    <inventoryType>ZP</inventoryType>
                    <actualQty>7</actualQty>
                </batch>
                <batch>
                    <remark>备注信息</remark>
                    <batchCode>P123</batchCode>
                    <productDate>2016-09-09</productDate>
                    <expireDate>2016-09-09</expireDate>
                    <produceCode>P1234</produceCode>
                    <inventoryType>ZP</inventoryType>
                    <actualQty>3</actualQty>
                </batch>
            </batchs>
            <snList>
                <sn>S1</sn>
                <sn>C2</sn>
                <sn>X3</sn>
            </snList>
        </orderLine>
    </orderLines>
    <extendProps>
        <xzz>111</xzz>
        <hhz>222</hhz>
    </extendProps>
</request>

返回示例(xml):

正确时返回:

<?xml version="1.0" encoding="utf-8"?>
<response>
 <flag>success|failure</flag>
 <code>响应码</code>
 <message>响应信息</message>
</response>'

错误时返回:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
    <flag>failure</flag>
    <code>failure</code>
    <message>请求奇门接口失败</message>
    <subCode>100002</subCode>
    <subMessage>请求奇门接口失败,错误原因:{"code":"TOP29","flag":"failure","message":"Invalid app Key","success":false}</subMessage>
    <requestId>ace95ef4cb9a4b42b2e6812a50745b64</requestId>
</response>

备注:

  • 更多返回错误代码请看首页的错误代码描述
文档更新时间: 2026-06-17 09:44   作者:黄会准