取消订阅
请求
POST /openapi/tracking-subscriptions/:id/cancel
路径参数
| 参数 | 类型 | 说明 |
|---|---|---|
| id | uint | 订阅任务 ID |
请求参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| reason | string | 否 | 取消原因 |
请求示例
{
"reason": "客户取消订单"
}
响应参数
| 字段 | 类型 | 说明 |
|---|---|---|
| taskId | uint | 订阅任务 ID |
| standardStatus | string | 标准状态 |
| queryStatus | string | 查询状态：stopped |
| message | string | 提示信息 |
响应示例
{
"code": 200,
"data": {
"taskId": 1001,
"standardStatus": "cancelled",
"queryStatus": "stopped",
"message": "success"
},
"msg": "success"
}
业务逻辑
- 只能取消当前 API 用户自己的订阅
- 取消后：
query_status设为stoppedcancelled_at记录取消时间- 清除
next_query_at、locked_until、locked_by
- 如提供
reason，会记录到stop_reason字段
附录
标准状态枚举
| 状态 | 说明 |
|---|---|
| pending | 待处理 |
| in_transit | 运输中 |
| exception | 异常 |
| delivered | 已签收 |
| returned | 已退回 |
| cancelled | 已取消 |
| expired | 已过期 |
查询状态枚举
| 状态 | 说明 |
|---|---|
| pending | 待查询 |
| querying | 查询中 |
| stopped | 已停止 |
支持的承运商
| 代码 | 名称 | 状态映射 |
|---|---|---|
| FEDEX | FedEx | 已实现 |
| UPARCEL | UParcel | 已实现 |
| UPS | UPS | 状态解析器已就绪，待接入适配器 |
| USPS | USPS | 状态解析器已就绪，待接入适配器 |
| GOFO | Gofo | 待补充轨迹状态枚举后映射 |