文档中心 > API类目 > 淘宝物流API

qimen.taobao.order.batchcancel (作业单批量取消接口)

订单批量取消接口，区分是否事务执行

公共参数

请求地址：

环境	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	Request	可选			请求
orders Order [] 必须单据列表 └ cancelReason String 可选 xx原因取消取消原因 └ orderCode String 必须 YS8877623 单据编码 └ orderId String 可选 LBX001 单据号 └ orderType String 必须 JYCK 订单类型（JYCK=一般交易出库单） └ ownerCode String 必须 AX766232 物流货主编码（物流订阅商ID） └ warehouseCode String 可选 AX001 仓库编码 └ extendProps Map 可选扩展属性

响应参数

名称	类型	示例值	描述
response	Response		返回
└ success Boolean false 是否成功，true-成功; false-失败 └ biz_error_code String E0001 错误编码 └ biz_error_msg String invalid app key 错误描述 orders Order [] 单据列表 └ ownerCode String AX766232 物流货主编码（物流订阅商ID） └ orderCode String YS8877623 单据编码 └ orderId String LBX001 单据号 └ subSuccess Boolean true 请求成功标志 └ subBizErrorMsg String 作业取消成功请求结果

请求示例

{"request":{"extendProps":"","orders":[{"orderType":"JYCK","orderId":"LBX001","ownerCode":"AX766232","orderCode":"YS8877623","cancelReason":"xx原因取消"}],"warehouseCode":"AX001"}}

响应示例

{
    "response":{
        "success":false,
        "biz_error_code":"E0001",
        "biz_error_msg":"invalid app key",
        "orders":[
            {
                    "ownerCode":"AX766232",
                    "orderCode":"YS8877623",
                    "orderId":"LBX001",
                    "subSuccess":true,
                    "subBizErrorMsg":"作业取消成功"
            }
        ]
    }
}

验签示例

{"response":{"biz_error_msg":"Illegal request","success":"不等于true","biz_error_code":"sign-check-failure"}}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部