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

qimen.alibaba.tcls.aelophy.delivery.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输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
deliveryCancelRequest	DeliveryCancelRequest	必须			配送
└ deliveryNo String 可选 131312312 配送单号 └ merchantCode String 必须 CSSJ 商家编码 └ deliveryShopId String 必须 112233 isv配送店ID └ orderFrom Number 必须饿了么订单来源 └ outOrderId String 必须 123123213213 外部订单号 └ cancelReasonText String 必须超时取消原因类型 └ cancelReasonType String 必须等太久取消原因文本

响应参数

名称	类型	示例值	描述
deliveryResult	DeliveryResult		配送结果
└ success Boolean false 调用接口返回成功失败 └ errCode String SYSTEM_ERROR 调用接口返回错误编码 └ errMsg String 系统异常调用接口返回错误信息

请求示例

{"deliveryCancelRequest":{"deliveryShopId":"112233","cancelReasonText":"超时","merchantCode":"CSSJ","cancelReasonType":"等太久","outOrderId":"123123213213","deliveryNo":"131312312","orderFrom":0}}

响应示例

{
    "deliveryResult":{
        "success":false,
        "errCode":"SYSTEM_ERROR",
        "errMsg":"系统异常"
    }
}

验签示例

{"deliveryResult":{"success":"false","errCode":"sign-check-failure","errMsg":"Illegal request"}}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

淘宝开放平台

五道口API

qimen.alibaba.tcls.aelophy.delivery.cancel (配送订单取消)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ