订阅轨迹
基础信息
- Base URL:
api.tms-anmeiancang.com - 认证方式: API Token
- Content-Type:
application/json
请求
POST /openapi/tracking-subscriptions
请求参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| carrierCode | string | 是 | 承运商代码,如 FEDEX、UPARCEL |
| trackingNumber | string | 是 | 运单号 |
| callbackUrl | string | 是 | 回调 URL,需符合 URL 格式 |
| externalReferenceNo | string | 否 | 外部业务单号 |
请求示例
{
"carrierCode": "FEDEX",
"trackingNumber": "123456789012",
"callbackUrl": "https://example.com/webhook/tracking",
"externalReferenceNo": "ORDER-001"
}
响应参数
| 字段 | 类型 | 说明 |
|---|---|---|
| taskId | uint | 订阅任务 ID |
| carrierCode | string | 承运商代码 |
| trackingNumber | string | 运单号 |
| externalReferenceNo | string | 外部业务单号 |
| standardStatus | string | 标准状态:pending / in_transit / exception / delivered / returned / cancelled / expired |
| result | string | 操作结果:created(新建)/ updated(更新) |
| message | string | 提示信息 |
响应示例
{
"code": 200,
"data": {
"taskId": 1001,
"carrierCode": "FEDEX",
"trackingNumber": "123456789012",
"externalReferenceNo": "ORDER-001",
"standardStatus": "pending",
"result": "created",
"message": "success"
},
"msg": "success"
}
业务逻辑
carrierCode会自动转为大写并去除首尾空格- 系统校验承运商是否支持(当前支持
FEDEX、UPARCEL) - 根据
(apiUserID, carrierCode, trackingNumber)唯一索引判断:- 已存在:更新
callbackUrl、externalReferenceNo,返回updated - 不存在:创建新任务,返回
created
- 已存在:更新