TMS 运单开放接口-取消 运单
基本信息
- 方法：
POST - 路径：
/label/void
用途
按跟踪号取消已下单的 TMS 运单，并向承运商发起取消请求。
公共请求头
所有 TMS 运单开放接口都需要传以下请求头：
Content-Type: application/json
Apikey: {{api_key}}
Apisign: {{api_sign}}
Timestamp: {{timestamp}}
请求参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| trackingCode | string | 是 | 跟踪号 |
请求示例
{
"trackingCode": "1Z999AA10123456784"
}
成功响应示例
{
"code": 200,
"data": {
"trackingCode": "1Z999AA10123456784",
"voidResult": "success",
"message": ""
},
"message": ""
}
返回字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.trackingCode | string | 跟踪号 |
| data.voidResult | string | 取消结果，success 或 fail |
| data.message | string | 结果说明，成功时为空 |
接口说明
- 用户必须开启
APIVoidLabel权限才能调用，否则返回取消接口已关闭，请联系客服取消 - 订单不存在时返回
未查询到订单 - 已取消的订单视为成功直接返回
- 已开账单或超出账号取消时限的订单不支持取消，返回
该订单不支持取消 - 取消成功后会退还已扣费用
- 调用方应自行保证只传自己名下的跟踪号
错误响应示例
{
"code": 400,
"data": null,
"message": "该订单不支持取消"
}
| code | message | 场景 |
|---|---|---|
| 401 | 请传入API授权信息 | 缺少 Apikey |
| 401 | 请传入apiSign授权签名信息 | 缺少 Apisign |
| 400 | 由 Gin 绑定错误文本决定 | 参数绑定失败 |
| 400 | 请求参数无效,请传入trackingCode | 缺 trackingCode |
| 400 | 取消接口已关闭，请联系客服取消 | 用户未开启 APIVoidLabel |
| 400 | 未查询到订单 | 订单不存在 |
| 400 | 该订单不支持取消 | 已开账单或超出取消时限 |
响应码约定：
- 成功时响应体
code = 200 - 参数校验或业务失败时，通常返回
code = 400 - 鉴权失败时，通常返回
code = 401 - 这套开放接口的成功码不是后台私有接口常见的
0