文档中心 > API类目 > 阿里健康API

qimen.alibaba.alihealth.wms.order.cancel (通用-作业单取消)

发起取消作业单，服务商可以回告是否允许取消。举例：健康取消仓储入库作业单；健康发起仓拦截会调用服务商取消销售发货单。

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
request	OrderCancelRequest	可选			请求
└ cancelReason String 可选已经退货取消原因 └ extendProps String 可选 {"key":"value"} 扩展属性;json序列化格式 └ orderCode String 必须 O1234 单据编码 └ orderId String 可选 WQ1234 仓储系统单据编码 └ orderType String 可选 JYCK 单据类型(JYCK=一般交易出库单;HHCK=换货出库;BFCK=补发出库;PTCK=普通出库单;DBCK=调拨出库;B2BRK=B2B入库;B2BCK=B2B出库;QTCK=其他出库;SCRK=生产入库;LYRK=领用入库;CCRK=残次品入库;CGRK=采购入库;DBRK=调拨入库;QTRK=其他入库;XTRK=销退入库;THRK=退货入库;HHRK=换货入库;CNJG=仓内加工单;CGTH=采购退货出库单) └ ownerCode String 可选 H1234 货主编码 └ remark String 可选备注备注 └ warehouseCode String 必须 W1234 仓库编码(统仓统配等无需ERP指定仓储编码的情况填OTHER) subSourceOrders SubSourceOrder [] 可选交易平台子订单信息 └ subSourceOrderCode String 可选 21324234 交易平台子订单编码

响应参数

名称	类型	示例值	描述
response	OrderCancelResponse		返回
└ success Boolean true 是否成功: true-成功; false-失败 └ bizErrorCode String E0001 错误编码 └ bizErrorMsg String invalid app key 错误描述

请求示例

{"request":{"subSourceOrders":[{"subSourceOrderCode":"21324234"}],"orderType":"JYCK","orderId":"WQ1234","ownerCode":"H1234","extendProps":"{\"key\":\"value\"}","orderCode":"O1234","remark":"备注","cancelReason":"已经退货","warehouseCode":"W1234"}}

响应示例

{
    "response":{
        "success":true,
        "bizErrorCode":"E0001",
        "bizErrorMsg":"invalid app key"
    }
}

验签示例

{"response":{"bizErrorMsg":"Illegal request","success":"false","bizErrorCode":"sign-check-failure"}}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部