简要描述:

  • 发货单查询接口

接口说明:

  • 1.1接口描述:向WMS查询发货单
  • 1.2接口说明:ERP调用奇门接口,奇门调用该接口,FMS调用奇门接口向WMS查询发货单
  • 1.3接口方法:taobao.qimen.deliveryorder.query

接口版本:

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

请求URL:

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

请求方式:

  • POST

请求头:

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

系统级请求参数

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

请求参数:

参数名 字段 是否必须 类型 说明
货主编码 ownerCode String 货主编码
仓库编码 warehouseCode String 仓库编码
发库单号 orderCode String 发库单号
仓储系统发库单号 orderId String 仓储系统发库单号
交易单号 orderSourceCode String 交易单号
当前页 page Number 当前页
每页条数 pageSize Number 每页orderLine条数(最多100条)
扩展属性 extendProps Map 扩展属性

请求参数示例

<?xml version="1.0" encoding="UTF-8" ?>
<request>
    <ownerCode>21</ownerCode>
    <warehouseCode>xxx</warehouseCode>
    <orderCode>2321</orderCode>
    <orderId>xxx</orderId>
    <orderSourceCode>fssa</orderSourceCode>
    <remark>remark</remark>
    <extendProps>
        <xzz>111</xzz>
        <hhz>222</hhz>
    </extendProps>
</request>

返回示例:

正确时返回:

<?xml version="1.0" encoding="utf-8"?>
<response>
    <flag>success|failure</flag>
    <code>响应码</code>
    <message>响应信息</message>
    <totalLines>orderLines 总条数,int</totalLines>
    <deliveryOrder>
        <deliveryOrderCode>出库单号, string (50) , 必填</deliveryOrderCode>
        <deliveryOrderId>仓储系统出库单号, string (50) ,条件必填</deliveryOrderId>
        <warehouseCode>仓库编码, string (50),必填 </warehouseCode>
        <orderType>出库单类型, string (50),JYCK=一般交易出库,HHCK=换货出库,BFCK=
补发出库,必填</orderType>
        <status>出库单状态, string (50) , 必填 (NEW-未开始处理, ACCEPT-仓库接单 , 
PARTDELIVERED-部分发货完成, DELIVERED-发货完成, EXCEPTION-异常, 
CANCELED-取消, CLOSED-关闭, REJECT-拒单, CANCELEDFAIL-取消失败) , (只传英
文编码) , SIGN-签收(菜鸟仓可以返回签收的状态)</status>
        <orderConfirmTime>订单完成时间, string (19) , YYYY-MM-DD HH:MM:SS 
</orderConfirmTime>
        <operatorCode>当前状态操作员编码, string (50) </operatorCode>
        <operatorName>当前状态操作员姓名, string (50) </operatorName>
        <operateTime>当前状态操作时间, string (19) , YYYY-MM-DD 
HH:MM:SS</operateTime>
        <invoices>
            <invoice>
                <header>发票抬头, string (200) </header>
                <amount>发票金额, double (18, 2) </amount>
                <content>发票内容, string(500) </content>
                <detail>
                    <!—当 contentdetail 同时存在时,优先处理 detail 的信息><items><item><itemName>商品名称, string (50)</itemName><unit>商品单位, string (50)</unit>
奇门接入白皮书<price>商品单价, double (18, 2)</price><quantity>数量, int</quantity><amount>金额, double(18,2)</amount></item>
 </items>
 </detail><code>发票代码, string(50),纳税企业的标识</code><number>发票号码, string(50),纳税企业内部的发票号</number></invoice> 
 </invoices> 
 </deliveryOrder><packages><package><logisticsCode>物流公司编码, string (50) , SF=顺丰、EMS=标准快递、EYB=经济
快件、ZJS=宅急送、YTO=圆通 、ZTO=中通 (ZTO) 、HTKY=百世汇通、BSKY=百世快
运、UC=优速、STO=申通、TTKDEX=天天快递 、QFKD=全峰、FAST=快捷、POSTB=
邮政小包 、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、AMAZON=亚
马逊物流、DBWL=德邦物流、DBKD=德邦快递、DBKY=德邦快运、RRS=日日顺、
OTHER=其他,必填, (只传英文编码) </logisticsCode><logisticsName>物流公司名称, string (200) </logisticsName><expressCode>运单号, string (50) , 必填</expressCode><packageCode>包裹编号, string (50) </packageCode><length>包裹长度 (厘米) , double (18, 2) </length><width>包裹宽度 (厘米) , double (18, 2) </width><height>包裹高度 (厘米) , double (18, 2) </height><theoreticalWeight>包裹理论重量 (千克) , double (18, 3) </theoreticalWeight><weight>包裹重量 (千克) , double (18, 3) </weight><volume>包裹体积 (升, L) , double (18, 3) </volume><invoiceNo>发票号, string (500) </invoiceNo><packageMaterialList><packageMaterial><type>包材型号, string (50) </type><quantity>包材的数量, int</quantity></packageMaterial> 
 </packageMaterialList><items><item><itemCode>商品编码, string (50) , 必填</itemCode><itemId>商品仓储系统编码, string (50)</itemId><quantity>包裹内该商品的数量, int, 必填</quantity></item> 
 </items> 
 </package> 
 </packages><orderLines><orderLine><orderLineNo>单据行号,string(50)</orderLineNo><orderSourceCode>平台交易订单编码, string (50) </orderSourceCode><subSourceCode>平台交易子订单编码, string (50) </subSourceCode><itemCode>商品编码, string (50) </itemCode><itemId>商品仓储系统编码, string (50)</itemId><inventoryType>库存类型,string (50) , ZP=正品, CC=残次,JS=机损, XS= 箱 损, ZT=在途库存,DJ=冻结,默认为查所有类型的库存</inventoryType><ownerCode>货主编码,string(50)</ownerCode><itemName>商品名称, string (200) </itemName><extCode>交易平台商品编码, string (50) </extCode><planQty>应发商品数量, int</planQty><actualQty>实发商品数量, int</actualQty><batchCode>批次编号,string(50),</batchCode><productDate>生产日期,string(10),YYYY-MM-DD</productDate><expireDate>过期日期,string(10),YYYY-MM-DD </expireDate><produceCode>生产批号,string(50),</produceCode><qrCode>商品的二维码(类似电子产品的 SN 码),用来进行商品的溯源,多个
二维码之间用分号(;)隔开</qrCode></orderLine> 
 </orderLines>
</response>

错误时返回:

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

备注:

  • 更多返回错误代码请看首页的错误代码描述
文档更新时间: 2020-08-07 14:08   作者:黄会准