文档中心 > API类目 > 五道口API

qimen.wdk.fulfill.dms.delivery.work.order.dispatch (配送任务下发)

下发配送作业单给对应的配送作业系统

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
workOrder	WorkOrder	必须			作业单
└ workOrderId String 必须 34354354353 作业单号 └ sourceOrderIds String [] 必须 325346554654 外部订单号 └ orderTime String 必须 2017-04-26 10:15:00 下单时间 └ merchantCode String 必须 CSDARUNFA 商户编码 └ deliveryDockCode String 必须 1234 配送站编码 └ routeAreaCode String 必须 234 区块编码 └ earliestArriveTime String 必须 2017-04-26 19:17:55 作业单最早送达时间，格式： yyyy-MM-dd HH:mm:ss └ latestArriveTime String 必须 2017-04-26 19:17:55 作业单最晚送达时间，格式： yyyy-MM-dd HH:mm:ss └ isTest Boolean 必须 true 是否测试单 workOrderDetails WorkOrderDetail [] 必须作业明细 └ workOrderDetailId String 必须 12341324234423 作业明细Id └ subSourceOrderId String 必须 2563546345 外部子订单号 └ skuCode String 必须 34523425 盒马标准商品编码 └ skuName String 必须可口可乐商品名称 └ isGift Boolean 必须 true 是否赠品 └ saleUnit String 必须件销售单位 └ stockUnit String 必须件库存单位 └ warehouseCode String 必须 8000 仓编码 └ expectSaleQuantity String 必须 1 销售单位购买数量 └ expectStockQuantity String 必须 1 库存单位购买数量 └ actualSaleQuantity String 可选 1 默认值：0 销售单位出库数量 └ actualStockQuantity String 可选 1 默认值：0 库存单位出库数量 └ status String 可选 CANCELED 状态： CANCELED("取消")，，为空该商品可以正常捡货 packages Package [] 可选包裹列表 └ packageCode String 必须 001 包裹编码 └ packageType String 必须 NORMAL_BOX 包裹类型： NORMAL_BOX（周转箱），INSULATION_BOX（保温箱），SKU_PACK（异形件sku捆绑，不能装入箱子，需要另外打包），UNKNOWN（未取到） └ containerCode String 必须 A001 容器编码 └ actualStockQuantity String 必须 1 库存单位出库数量 └ actualSaleQuantity String 必须 1 销售单位出库数量 └ barCodes String [] 必须 35435 条码 consignee Consignee 必须收货人 └ name String 必须账户姓名 └ phone String 必须 11111111111 手机号 └ address String 必须上海市长宁区新兴路1号地址 └ lngLat String 必须 posx:121.582604;posy:31.26864 经纬度 └ poi String 可选如xxx大厦、xxx科技园等收货地址POI名称 └ routeAreaName String 必须一区区块名称

响应参数

名称	类型	示例值	描述
success	Boolean	ture	是否成功：true 调用成功； false 调用失败
respCode	String	SUCCESS	返回码： SUCCESS:作业批次接收成功 SYSTEM_ERROR :系统异常(指令可重发) PARAM_ERROR :参数错误(指令不可重发，监控报警) BUSINESS_ERROR:业务异常(指令不可重发，监控报警)
respMessage	String	下发成功	响应提示信息

请求示例

{"workOrder":{"merchantCode":"CSDARUNFA","orderTime":"2017-04-26 10:15:00","consignee":{"address":"上海市长宁区新兴路1号","lngLat":"posx:121.582604;posy:31.26864","phone":"11111111111","name":"账户","poi":"如xxx大厦、xxx科技园等"},"isTest":true,"routeAreaName":"一区","sourceOrderIds":["325346554654"],"earliestArriveTime":"2017-04-26 19:17:55","latestArriveTime":"2017-04-26 19:17:55","workOrderId":"34354354353","routeAreaCode":"234","workOrderDetails":[{"actualSaleQuantity":"1","subSourceOrderId":"2563546345","actualStockQuantity":"1","packages":[{"packageCode":"001","actualSaleQuantity":"1","containerCode":"A001","actualStockQuantity":"1","packageType":"NORMAL_BOX"}],"saleUnit":"件","warehouseCode":"8000","stockUnit":"件","barCodes":["35435"],"skuName":"可口可乐","expectStockQuantity":"1","workOrderDetailId":"12341324234423","isGift":true,"expectSaleQuantity":"1","skuCode":"34523425","status":"CANCELED"}],"deliveryDockCode":"1234"}}

响应示例

{
    "success":ture,
    "respCode":"SUCCESS",
    "respMessage":"下发成功"
}

验签示例

{"respMessage":"Illegal request","success":"false","respCode":"sign-check-failure"}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

五道口API

qimen.wdk.fulfill.dms.delivery.work.order.dispatch (配送任务下发)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ

用户导航

用户反馈

用户反馈

用户反馈