文档中心 > API类目 > 千帆计划

qimen.alibaba.ovs.logistic.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	LogisticOrderCancelRequest	必须			请求参数
└ traceId String 必须 242534242423 平台日志id 用于平台排查问题 └ openUserId String 必须 dgagdw243424df 平台买家id(已加密，不可逆) └ platformOrderId String 可选 9546353546663 业务主键平台物流单id , 在用户支付运费后，通过该主键做取消 └ providerUserCode String 可选 64634g352455 在非集运场景时候使用，物流服务商的用户编码，已废弃 └ ticketId String 可选 T4536363 业务主键针对远洋地区使用，在用户支付运费前下发该字段做取消

响应参数

名称	类型	示例值	描述
data	LogisticOrderCancelResponse		响应业务参数
└ orderId String 534634356 物流商的物流单id └ success Boolean true 成功失败 true/false
success	Boolean	true	接口成功失败 true/false
failMessage	String	系统异常	错误信息
failCode	String	1100	错误码

请求示例

{"request":{"traceId":"242534242423","providerUserCode":"64634g352455","openUserId":"dgagdw243424df","platformOrderId":"9546353546663","ticketId":"T4536363"}}

响应示例

{
    "data":{
        "orderId":"534634356",
        "success":true
    },
    "success":true,
    "failMessage":"系统异常",
    "failCode":"1100"
}

验签示例

{"success":"false","failCode":"sign-check-failure","failMessage":"Illegal request"}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

千帆计划

qimen.alibaba.ovs.logistic.order.cancel (物流单取消)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ

用户导航

用户反馈

用户反馈

用户反馈