跳到主要内容

订阅轨迹

基础信息

  • Base URL: api.tms-anmeiancang.com
  • 认证方式: API Token
  • Content-Type: application/json

请求

POST /openapi/tracking-subscriptions

请求参数

字段类型必填说明
carrierCodestring承运商代码,如 FEDEXUPARCEL
trackingNumberstring运单号
callbackUrlstring回调 URL,需符合 URL 格式
externalReferenceNostring外部业务单号

请求示例

{
"carrierCode": "FEDEX",
"trackingNumber": "123456789012",
"callbackUrl": "https://example.com/webhook/tracking",
"externalReferenceNo": "ORDER-001"
}

响应参数

字段类型说明
taskIduint订阅任务 ID
carrierCodestring承运商代码
trackingNumberstring运单号
externalReferenceNostring外部业务单号
standardStatusstring标准状态:pending / in_transit / exception / delivered / returned / cancelled / expired
resultstring操作结果:created(新建)/ updated(更新)
messagestring提示信息

响应示例

{
"code": 200,
"data": {
"taskId": 1001,
"carrierCode": "FEDEX",
"trackingNumber": "123456789012",
"externalReferenceNo": "ORDER-001",
"standardStatus": "pending",
"result": "created",
"message": "success"
},
"msg": "success"
}

业务逻辑

  1. carrierCode 会自动转为大写并去除首尾空格
  2. 系统校验承运商是否支持(当前支持 FEDEXUPARCEL
  3. 根据 (apiUserID, carrierCode, trackingNumber) 唯一索引判断:
    • 已存在:更新 callbackUrlexternalReferenceNo,返回 updated
    • 不存在:创建新任务,返回 created