简要描述:

  • 发货单创建接口

接口说明:

  • 1.1接口描述:创建发货单到WMS
  • 1.2接口说明:ERP调用奇门接口,奇门调用该接口,FMS调用奇门接口往WMS创建发货单
  • 1.3接口方法:taobao.qimen.deliveryorder.create

接口版本:

版本号 制定人 制定日期 修订日期
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.deliveryorder.create
协议版本号 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 格式

请求参数:

参数名 字段 是否必须 类型 说明
发货单信息 deliveryOrder 是 data 发货单信息,节点下数据字段详见下述“deliveryOrder”
订单列表 orderLines 是 data[] 订单列表,节点下数据字段详见下述“orderLines”
扩展属性 extendProps 否 Map 扩展属性

deliveryOrder

参数名 字段 是否必须 类型 说明
出库单号 entryOrderCode 是 String 入库单号
原出库单号 preDeliveryOrderCode 否 String 原出库单号(ERP分配)
原出库单号 preDeliveryOrderId 否 String 原出库单号(WMS分配)
出库单类型 orderType 是 String 出库单类型(JYCK=一般交易出库单;HHCK=换货出库单;BFCK=补发出库单;QTCK=其他出 库 单)
仓库编码 warehouseCode 是 String 仓库编码(统仓统配等无需ERP指定仓储编码的情况填OTHER)
订单标记 orderFlag 否 String 订单标记(用字符串格式来表示订单标记列表:例如COD=货到付款;LIMIT=限时配 送;PRESELL=预 售;COMPLAIN=已投诉;SPLIT=拆单;EXCHANGE=换货;VISIT=上门;MODIFYTRANSPORT=是否 可改配送方式;CONSIGN = 物流宝代理发货;SELLER_AFFORD=是否卖家承担运费;FENXIAO=分销订 单)
订单来源平台编码 sourcePlatformCode 否 String 订单来源平台编码(TB=淘宝、TM=天猫、JD=京东、DD=当当、PP=拍拍、YX= 易讯、 EBAY=ebay、QQ=QQ网购、AMAZON=亚马逊、SN=苏宁、GM=国美、WPH=唯品会、JM=聚美、LF=乐蜂 、MGJ=蘑菇街、 JS=聚尚、PX=拍鞋、YT=银泰、YHD=1号店、VANCL=凡客、YL=邮乐、YG=优购、1688=阿 里巴巴、POS=POS门店、 MIA=蜜芽、OTHER=其他(只传英文编码))
最迟预期到货时间 expectEndTime 否 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=其他(只传英文编码))
订单来源平台名称 sourcePlatformName 否 String 订单来源平台名称
发货单创建时间 createTime 是 String 发货单创建时间(YYYY-MM-DD HH:MM:SS)
下单时间 placeOrderTime 是 String 前台订单/店铺订单的创建时间/下单时间
订单支付时间 payTime 否 String 订单支付时间(YYYY-MM-DD HH:MM:SS)
支付平台交易号 payNo 否 String 支付平台交易号
操作员(审核员)编码 operatorCode 否 String 操作员(审核员)编码
操作员(审核员)名称 operatorName 否 String 操作员(审核员)名称
操作(审核)时间 operateTime 是 String 操作(审核)时间(YYYY-MM-DD HH:MM:SS)
店铺名称 shopNick 是 String 店铺名称
卖家名称 sellerNick 否 String 卖家名称
买家昵称 buyerNick 否 String 买家昵称
订单总金额 totalAmount 否 String 订单总金额(订单总金额=应收金额+已收金额=商品总金额-订单折扣金额+快递费用 ;单位 元)
商品总金额 itemAmount 否 String 商品总金额(元)
订单折扣金额 discountAmount 否 data 订单折扣金额(元)
快递费用 freight 否 String 快递费用(元)
应收金额 arAmount 否 String 应收金额(消费者还需要支付多少–货到付款时消费者还需要支付多少约定使用这个字 段;单位元 )
已收金额 gotAmount 否 String 已收金额(消费者已经支付多少;单位元)
COD服务费 serviceFee 否 String COD服务费
物流公司编码 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 运单号
快递区域编码 logisticsAreaCode 否 String 快递区域编码
发货要求 deliveryRequirements 否 data 发货要求,节点下数据字段详见下述“deliveryRequirements”
发件人信息 senderInfo 否 data 发件人信息,节点下数据字段详见下述“senderInfo”
收件人信息 receiverInfo 否 data 收件人信息,节点下数据字段详见下述“receiverInfo”
是否紧急 isUrgency 否 String 是否紧急(Y/N;默认为N)
是否需要发票 sellerNick 否 String 是否需要发票(Y/N;默认为N)
发票信息 invoices 否 data[] 发票信息,节点下数据字段详见下述“invoices”
是否需要保险 insuranceFlag 否 String 是否需要保险(Y/N;默认为N)
保险信息 insurance 否 data 保险信息,节点下数据字段详见下述“insurance”
买家留言 buyerMessage 否 String 买家留言
卖家留言 sellerMessage 否 String 卖家留言
备注 remark 否 String 备注
服务编码 serviceCode 否 String 服务编码
旧版本货主编码 ownerCode 否 String 旧版本货主编码

deliveryRequirements

参数名 字段 是否必须 类型 说明
投递时延要求 scheduleType 否 int 投递时延要求(1=工作日;2=节假日;101=当日达;102=次晨达;103=次日达;104=预约达;105=隔日达)
要求送达日期 scheduleDay 否 String 要求送达日期(YYYY-MM-DD)
投递时间范围要求 scheduleStartTime 否 String 投递时间范围要求(开始时间;格式:HH:MM:SS)
投递时间范围要求 scheduleEndTime 否 String 投递时间范围要求(结束时间;格式:HH:MM:SS)
发货服务类型 deliveryType 否 String 发货服务类型(PTPS:普通配送;LLPS:冷链配送;HBP:环保配)

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 详细地址

receiverInfo

参数名 字段 是否必须 类型 说明
公司名称 company 否 String 公司名称
姓名 name 是 String 姓名
邮编 zipCode 否 String 邮编
固定电话 tel 否 String 固定电话
移动电话 mobile 是 String 移动电话
电子邮箱 email 否 String 电子邮箱
国家二字码 countryCode 否 String 国家二字码
省份 province 是 String 省份
城市 city 是 String 城市
区域 area 否 String 区域
村镇 town 否 String 村镇
详细地址 tel 是 String 详细地址

invoices

参数名 字段 是否必须 类型 说明
发票类型 type 否 String 发票类型(INVOICE=普通发票;VINVOICE=增值税普通发票;EVINVOICE=电子增票;填写的 条件 是:invoiceFlag为Y)
发票抬头 header 是 String 发票抬头(填写的条件是:invoiceFlag为Y)
发票总金额 amount 否 String 发票总金额(填写的条件是:invoiceFlag为Y)
发票内容 content 否 String 发票内容(不推荐使用)
详情 detail 是 String 当content和detail同时存在时,优先处理detail的信息,节点下数据字段详见下述“detail”
税号 taxNumber 否 String 税号

detail

参数名 字段 是否必须 类型 说明
商品列表 items 否 data[] 商品列表,节点下数据字段详见下述“item”

item

参数名 字段 是否必须 类型 说明
商品名称 itemName 否 String 商品名称
商品单位 unit 否 String 商品单位
商品单价 price 否 String 商品单价
数量 quantity 否 Long 数量
金额 amount 否 String 金额

insurance

参数名 字段 是否必须 类型 说明
公司名称 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

参数名 字段 是否必须 类型 说明
单据行号 orderLineNo 否 String 单据行号
交易平台订单 sourceOrderCode 否 String 交易平台订单
交易平台子订单编码 subSourceOrderCode 否 String 交易平台子订单编码
支付平台交易号 payNo 否 String 支付平台交易号(淘系订单传支付宝交易号)
货主编码 ownerCode 是 String 货主编码
商品编码 itemCode 是 String 商品编码
仓储系统商品编码 itemId 否 String 仓储系统商品编码
库存类型 inventoryType 否 String 库存类型(ZP=正品;CC=残次;JS=机损;XS= 箱损;ZT=在途库存;默认为查所有类型的库存)
商品名称 itemName 否 String 商品名称
交易平台商品编码 extCode 否 String 交易平台商品编码
应发商品数量 planQty 是 long 应发商品数量
零售价 retailPrice 否 String 零售价(零售价=实际成交价+单件商品折扣金额)
实际成交价 actualPrice 是 String 实际成交价
单件商品折扣金额 discountAmount 否 String 单件商品折扣金额
批次编码 batchCode 否 String 批次编码
生产日期 productDate 否 String 生产日期(YYYY-MM-DD)
过期日期 expireDate 否 String 过期日期(YYYY-MM-DD)
生产批号 produceCode 否 String 生产批号

请求参数示例

<?xml version="1.0" encoding="UTF-8" ?>
<request>
    <deliveryOrder>
        <deliveryOrderCode>TB1234</deliveryOrderCode>
        <orderType>JYCK</orderType>
        <warehouseCode>OTHER</warehouseCode>
        <createTime>2016-07-06 12:00:00</createTime>
        <placeOrderTime>2016-07-06 12:00:00</placeOrderTime>
        <operateTime>2016-07-06 12:00:00</operateTime>
        <shopNick>淘宝店</shopNick>
        <logisticsCode>SF</logisticsCode>
        <deliveryRequirements>
            <scheduleType>1</scheduleType>
            <scheduleDay>2016-07-06</scheduleDay>
            <scheduleStartTime>12:00:00</scheduleStartTime>
            <scheduleEndTime>13:00:00</scheduleEndTime>
            <deliveryType>PTPS</deliveryType>
        </deliveryRequirements>
        <senderInfo>
            <name>老王</name>
            <province>浙江省</province>
            <mobile>13214567869</mobile>
            <city>杭州</city>
            <detailAddress>杭州市余杭区989号</detailAddress>
        </senderInfo>
        <receiverInfo>
            <name>李四</name>
            <province>浙江省</province>
            <mobile>12214567869</mobile>
            <city>杭州</city>
            <detailAddress>杭州市余杭区787号</detailAddress>
        </receiverInfo>
        <invoices>
            <invoice>
                <type>INVOICE</type>
                <header>天猫科技有限公司</header>
                <amount>100</amount>
                <content>增值税100元</content>
                <taxNumber>123</taxNumber>
                <detail>
                    <items>
                        <item>
                            <itemName>淘公仔</itemName>
                            <unit>个</unit>
                            <price>50</price>
                            <quantity>2</quantity>
                            <amount>100</amount>
                        </item>
                    </items>
                </detail>
            </invoice>
            <invoice>
                <type>INVOICE</type>
                <header>天猫科技有限公司</header>
                <amount>100</amount>
                <content>增值税100元</content>
                <taxNumber>123</taxNumber>
                <detail>
                    <items>
                        <item>
                            <itemName>淘公仔</itemName>
                            <unit>个</unit>
                            <price>50</price>
                            <quantity>2</quantity>
                            <amount>100</amount>
                        </item>
                        <item>
                            <itemName>淘公仔</itemName>
                            <unit>个</unit>
                            <price>50</price>
                            <quantity>2</quantity>
                            <amount>100</amount>
                        </item>
                    </items>
                </detail>
            </invoice>
        </invoices>
        <insurance>
            <type>消费险</type>
            <amount>1</amount>
        </insurance>
    </deliveryOrder>
    <orderLines>
        <orderLine>
            <ownerCode>H1234</ownerCode>
            <itemCode>I1234</itemCode>
            <planQty>1</planQty>
            <actualPrice>12.0</actualPrice>
        </orderLine>
        <orderLine>
            <ownerCode>H1234</ownerCode>
            <itemCode>I1234</itemCode>
            <planQty>1</planQty>
            <actualPrice>12.0</actualPrice>
        </orderLine>
    </orderLines>
    <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>
    <createTime>订单创建时间, string (19) , YYYY-MM-DD HH:MM:SS</createTime>
    <deliveryOrderId>出库单仓储系统编码, string (50) </deliveryOrderId>
    <warehouseCode>仓库编码(统仓统配使用),string(50)</warehouseCode>
    <logisticsCode>物流公司编码(统仓统配使用),string(50)</logisticsCode>
    <deliveryOrders>----拆单
        <deliveryOrder>
            <deliveryOrderId>出库单仓储系统编码, string (50) </deliveryOrderId>
            <warehouseCode>仓库编码(统仓统配使用),string(50)</warehouseCode>
            <logisticsCode>物流公司编码(统仓统配使用),string(50)</logisticsCode>
            <orderLines >
                <orderLine>
                    <orderLineNo> 行号,string(50)</orderLineNo>
                    <itemCode>ERP 商品编码,string(50)</itemCode>
                    <itemId>WMS 商品编码,string(50)</itemId>
                    <quantity>数量,string(50)</quantity>
                </orderLine>
            </orderLines>
            <createTime>订单创建时间, string (19) , YYYY-MM-DD HH:MM:SS</createTime>
        </deliveryOrder>
    </deliveryOrders>
</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>

备注:

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