文档中心 > API类目 > 菜鸟仓配API

qimen.alibaba.cainiao.whc.fulfill.work.order.cancel.by.unit.content (取消)

取消子单作业

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
cancelRequest	CancelRequest	必须			取消请求
└ workOrderId String 必须 42543513 作业单号 └ nodeCode String 必须 65787 作业节点编码 └ workOrderUnitId String 必须 3253425 作业单元号 └ workUnitContentIds String [] 必须作业内容号列表 └ merchantCode String 可选 DARUNFA 商户编码

响应参数

名称	类型	示例值	描述
success	Boolean	true	是否成功
respCode	String	SUCCESS	响应code
respMessage	String	下发成功	响应提示信息
data	ResultDetail []		单据取消结果列表
└ bizNo String 4565346 业务单据号（作业单元Id) └ resultCode String SUCCESS 单据操作结果：SUCCESS 已拦截（仓内作业不出库，配送作业不配送到客户）； FAILURE：未拦截 └ resultDesc String 已拦截返回码含义描述

请求示例

{"cancelRequest":{"workOrderUnitId":"3253425","workUnitContentIds":[""],"merchantCode":"DARUNFA","nodeCode":"65787","workOrderId":"42543513"}}

响应示例

{
    "success":true,
    "respCode":"SUCCESS",
    "respMessage":"下发成功",
    "data":[
        {
                "bizNo":"4565346",
                "resultCode":"SUCCESS",
                "resultDesc":"已拦截"
        }
    ]
}

验签示例

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

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

菜鸟仓配API

qimen.alibaba.cainiao.whc.fulfill.work.order.cancel.by.unit.content (取消)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ

用户导航

用户反馈

用户反馈

用户反馈