跳到主要内容

批量订阅轨迹

请求

POST /openapi/tracking-subscriptions/batch

请求参数

字段类型必填说明
itemsarray订阅项数组,最小 1 条
items[].carrierCodestring承运商代码
items[].trackingNumberstring运单号
items[].callbackUrlstring回调 URL
items[].externalReferenceNostring外部业务单号

请求示例

{
"items": [
{
"carrierCode": "FEDEX",
"trackingNumber": "123456789012",
"callbackUrl": "https://example.com/webhook/tracking",
"externalReferenceNo": "ORDER-001"
},
{
"carrierCode": "UPARCEL",
"trackingNumber": "987654321098",
"callbackUrl": "https://example.com/webhook/tracking",
"externalReferenceNo": "ORDER-002"
}
]
}

响应参数

字段类型说明
resultsarray每项订阅结果
results[].indexint原始数组索引
results[].trackingNumberstring运单号
results[].carrierCodestring承运商代码
results[].taskIduint订阅任务 ID
results[].resultstring操作结果:created / reused / validation_error / unsupported_carrier
results[].messagestring提示信息

响应示例

{
"code": 200,
"data": {
"results": [
{
"index": 0,
"trackingNumber": "123456789012",
"carrierCode": "FEDEX",
"taskId": 1001,
"result": "created",
"message": "success"
},
{
"index": 1,
"trackingNumber": "987654321098",
"carrierCode": "UPARCEL",
"taskId": 1002,
"result": "reused",
"message": "success"
}
]
},
"msg": "success"
}

业务逻辑

  1. 批量大小上限由配置项 MaxBatchSize 控制(默认 100)
  2. 逐项调用订阅逻辑,单条失败不影响其他项
  3. 已存在的订阅返回 reused(而非 updated
  4. 校验失败返回 validation_error,不支持的承运商返回 unsupported_carrier