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

qimen.taobao.logistics.express.service.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输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	描述
service_type	String	必须	1	服务类型
biz_code	String	必须	123456	单据标识
cancel_reason	String	可选	决策无服务	取消原因
supplier_id	String	必须	123123	服务商id
cancel_time	String	必须	2024-01-10 11:16:10	取消指令下发时间（yyyy-MM-dd HH:mm:ss）
mail_no	String	必须	12341	运单号
tms_cp_code	String	必须	STO	配资源编码

响应参数

名称	类型	示例值	描述
success	Boolean	true	是否成功，true-成功，false-失败
error_code	String	10001	错误码
error_message	String	系统错误	错误原因
is_retry	Boolean	true	是否可以重试,true-可以重试

请求示例

{"cancel_time":"2024-01-10 11:16:10","service_type":"1","cancel_reason":"决策无服务","biz_code":"123456","supplier_id":"123123","mail_no":"12341","tms_cp_code":"STO"}

响应示例

{
    "success":true,
    "error_code":"10001",
    "error_message":"系统错误",
    "is_retry":true
}

验签示例

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部