简要描述:

  • 发货单确认接口

接口说明:

  • 1.1接口描述:WMS调用奇门的接口,将订单在仓库的状态回传给ERP
  • 1.2接口说明:仓库出库单发货完成后, 把出库单和包裹信息回传给 ERP, ERP 自行决定如何处理。
  • 1.3接口方法: taobao.qimen.deliveryorder.confirm

    接口版本:

版本号 制定人 制定日期 修订日期
1.0.0 石明科 2020-08-07 2020-08-07

请求头:

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

请求参数:

公共请求参数

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

request

参数名 字段 是否必须 类型 说明
发货单信息 deliveryOrder DeliveryOrder 发货单信息
包裹信息 packages Package[] 包裹信息
单据列表 orderLines OrderLine[] 单据列表
扩展属性 extendProps Map 扩展属性

deliveryOrder

参数名 字段 是否必须 类型 说明
出库单号 deliveryOrderCode String 出库单号
仓储系统出库单号 deliveryOrderId String 仓储系统出库单号
仓库编码 warehouseCode String 仓库编码
出库单类型 orderType String 出库单类型(JYCK=一般交易出库;HHCK=换货出库;BFCK=补发出库;QTCK=其他出库单)
出库单状态 status String 出库单状态(NEW-未开始处理;ACCEPT-仓库接单;PARTDELIVERED-部分发货完成;DELIVERED-发货完成;EXCEPTION-异 常;CANCELED-取消;CLOSED-关闭;REJECT-拒单;CANCELEDFAIL-取消失败;只传英文编码)
外部业务编码 outBizCode String 外部业务编码(消息ID;用于去重;ISV对于同一请求;分配一个唯一性的编码。用来保证因为网络等原因导致重复传输;请求 不会被重复处理;条件必填;条件为一单需要多次确认时)
支持出库单多次发货 confirmType int 支持出库单多次发货(多次发货后确认时;0表示发货单最终状态确认;1表示发货单中间状态确认)
订单完成时间 orderConfirmTime String 订单完成时间(YYYY-MM-DD HH:MM:SS)
操作员编码 operatorCode String 当前状态操作员编码
操作员姓名 operatorName String 当前状态操作员姓名
操作时间 operateTime String 当前状态操作时间(YYYY-MM-DD HH:MM:SS)
仓储费用 storageFee String 仓储费用
发票信息 invoices Invoice[] 发票信息

invoice

参数名 字段 是否必须 类型 说明
发票抬头 header String 发票抬头
发票金额 amount String 发票金额
发票内容 content String 发票内容
发票代码 code String 发票代码(纳税企业的标识)
发票号码 number String 发票号码(纳税企业内部的发票号)
发货详情 detail Detail 发货详情

detail

参数名 字段 是否必须 类型 说明
商品列表 item Item[] 商品列表

item

参数名 字段 是否必须 类型 说明
商品名称 itemName String 商品名称
商品单位 unit String 商品单位
商品单价 price String 商品单价
数量 quantity int 数量
金额 amount int 金额
商品编码 itemCode String 商品编码
商品仓储系统编码 itemId String 商品仓储系统编码

package

参数名 字段 是否必须 类型 说明
物流公司编码 logisticsCode String 物流公司编码(SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通、ZTO=中通 (ZTO)、HTKY=百世汇通、 UC=优速、STO=申通、TTKDEX=天天快递、QFKD=全峰、FAST=快捷、POSTB=邮政小包、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、 AMAZON=亚马逊物流、OTHER=其他;只传英文编码)
物流公司名称 logisticsName String 物流公司名称
运单号 expressCode String 运单号
包裹编号 packageCode String 包裹编号
包裹长度 length String 包裹长度(单位:厘米)
包裹宽度 width String 包裹宽度(单位:厘米)
包裹高度 height String 包裹高度(单位:厘米)
包裹理论重量 theoreticalWeight String 包裹理论重量(单位:千克)
包裹重量 weight String 包裹重量(单位:千克)
包裹体积 volume String 包裹体积(单位:升)
发票号 invoiceNo String 发票号
包材信息 packageMaterialList PackageMaterial[] 包材信息
商品列表 items Item[] 商品列表

packageMaterial

参数名 字段 是否必须 类型 说明
包材型号 type String 包材型号
包材的数量 quantity int 包材的数量

orderLine

参数名 字段 是否必须 类型 说明
单据行号 orderLineNo String 单据行号
平台交易订单编码 orderSourceCode String 平台交易订单编码
平台交易子订单编码 subSourceCode String 平台交易子订单编码
商品编码 itemCode String 商品编码
商品仓储系统编码 itemId String 商品仓储系统编码
库存类型 itemCode String 库存类型(ZP=正品;CC=残次;JS=机损;XS=箱损;ZT=在途库存;默认为查所有类型的库存)
货主编码 ownerCode String 货主编码
商品名称 itemName String 商品名称
交易平台商品编码 extCode String 交易平台商品编码
应发商品数量 planQty int 应发商品数量
实发商品数量 actualQty int 实发商品数量
批次编号 batchCode String 批次编号
生产日期 productDate String 生产日期(YYYY-MM-DD)
过期日期 expireDate String 过期日期(YYYY-MM-DD)
生产批号 produceCode String 生产批号
批次列表 batchs Batch[] 批次列表
商品的二维码 qrCode String 商品的二维码(类似电子产品的SN码;用来进行商品的溯源;多个二维码之间用分号;隔开)
货品sn编码 snCode String 货品sn编码
sn列表 snList SnList sn列表
供应商名称 supplierName String 供应商名称
供应商编码 supplierCode String 供应商编码

snList

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

batch

参数名 字段 是否必须 类型 说明
批次编号 batchCode String 批次编号
生产日期 productDate String 生产日期(YYYY-MM-DD)
过期日期 expireDate String 过期日期(YYYY-MM-DD)
生产批号 produceCode String 生产批号
库存类型 inventoryType String 库存类型(ZP=正品;CC=残次;JS=机损;XS=箱损;ZT=在途库存;默认为查所有类型的库存)
实发数量 actualQty int 实发数量(要求batchs节点下所有的实发数量之和等于orderline中的实发数量)
货品sn编码 snCode int 货品sn编码

返回参数:

response

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

请求示例(xml)

<?xml version="1.0" encoding="utf-8"?>

<request> 
  <deliveryOrder> 
    <deliveryOrderCode>出库单号, string (50) , 必填</deliveryOrderCode>  
    <deliveryOrderId>仓储系统出库单号, string (50) ,条件必填</deliveryOrderId>  
    <warehouseCode>仓库编码, string (50),必填</warehouseCode>  
    <orderType>出库单类型, string (50),JYCK=一般交易出库,HHCK=换货出库,BFCK= 补发出库,QTCK=其他出库单,必填</orderType>  
    <status>出库单状态, string (50) (NEW-未开始处理, ACCEPT-仓库接单 , PARTDELIVERED-部分发货完成, DELIVERED-发货完成, EXCEPTION-异常, CANCELED-取消, CLOSED-关闭, REJECT-拒单, CANCELEDFAIL-取消失败) , (只传英 文编码)</status>  
    <outBizCode>string (50) , 外部业务编码, 消息 ID, 用于去重, ISV 对于同一请求,分 配一个唯一性的编码。用来保证因为网络等原因导致重复传输,请求不会被重复处理,条 件必填,条件为一单需要多次确认时</outBizCode>  
    <confirmType>支持出库单多次发货, int, 多次发货后确认时 0 表示发货单最终状态确认; 1 表示发货单中间状态确认;</confirmType>  
    <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>  
    <storageFee>仓储费用,double (18, 2)</storageFee>  
    <invoices> 
      <invoice> 
        <header>发票抬头, string (200)</header>  
        <amount>发票金额, double (18, 2)</amount>  
        <content>发票内容, string(500)</content>  
        <detail>当 content 和 detail 同时存在时,优先处理 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>  
      <ownerCode>货主编码, string (50)</ownerCode>  
      <itemCode>商品编码, string (50)</itemCode>  
      <itemId>商品仓储系统编码, string (50)</itemId>  
      <snList> 
        <sn>商品序列号, string(50)</sn> 
      </snList>  
      <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>  
      <retailPrice>零售价, double (18, 2) , 零售价=实际成交价+单件商品折扣金额</retailPrice>  
      <actualPrice>实际成交价, double (18, 2) , 必填</actualPrice>  
      <discountAmount>单件商品折扣金额, double (18, 2)</discountAmount>  
      <batchCode>批次编号,string(50),</batchCode>  
      <productDate>生产日期,string(10),YYYY-MM-DD</productDate>  
      <expireDate>过期日期,string(10),YYYY-MM-DD</expireDate>  
      <produceCode>生产批号,string(50),</produceCode>  
      <batchs>
        <!-- 同一行号下多批次支持-->  
        <batch> 
          <batchCode>批次编号,string(50)</batchCode>  
          <productDate>生产日期,string(10),YYYY-MM-DD</productDate>  
          <expireDate>过期日期,string(10),YYYY-MM-DD</expireDate>  
          <produceCode>生产批号,string(50),</produceCode>  
          <inventoryType>库存类型,string (50) , ZP=正品, CC=残次,JS=机损, XS= 箱损, ZT=在途库存,DJ=冻结,默认为查所有类型的库存</inventoryType>  
          <actualQty>实发数量, int,要求 batchs 节点下所有的实发数量之和等于 orderline 中的实发数量</actualQty> 
        </batch> 
      </batchs>  
      <qrCode>商品的二维码(类似电子产品的 SN 码),用来进行商品的溯源,多个二 维码之间用分号(;)隔开</qrCode> 
    </orderLine> 
  </orderLines> 
</request>

返回示例(xml):

正确时返回:

<response>
    <flag>success</flag>
    <code>0</code>
    <message>invalid appkey</message>
    <requestId>8bde9c225ba9436abbfae303ecde91d1</requestId>
</response>

错误时返回:

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
   <requestId>8bde9c225ba9436abbfae303ecde91d1</requestId>
</error_response>

备注:

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