跳到主要内容

查询订阅详情

请求

GET /openapi/tracking-subscriptions

查询参数

参数类型必填说明
taskIduint二选一订阅任务 ID
trackingNumberstring二选一运单号

taskIdtrackingNumber 必须且只能传其中一个。

请求示例

按任务 ID 查询:

GET /openapi/tracking-subscriptions?taskId=1001

按运单号查询:

GET /openapi/tracking-subscriptions?trackingNumber=123456789012

响应参数

字段类型说明
taskIduint订阅任务 ID
carrierCodestring承运商代码
trackingNumberstring运单号
externalReferenceNostring外部业务单号
standardStatusstring标准状态
carrierStatusstring承运商原始状态
estimatedDeliveryAtdatetime/null预计收货时间;承运商未返回或解析失败时为 null
originAddressobject发货地址;字段缺失时对象内对应字段为空字符串
originAddress.countrystring发货国家
originAddress.statestring发货州/省
originAddress.citystring发货城市
originAddress.postalCodestring发货邮编
originAddress.addressstring发货详细地址
destinationAddressobject收货地址;字段缺失时对象内对应字段为空字符串
destinationAddress.countrystring收货国家
destinationAddress.statestring收货州/省
destinationAddress.citystring收货城市
destinationAddress.postalCodestring收货邮编
destinationAddress.addressstring收货详细地址
eventsarray轨迹事件列表
events[].eventTimedatetime事件时间
events[].eventCodestring事件代码
events[].statusstring状态
events[].statusInfostring状态信息
events[].descriptionstring描述
events[].exceptionDescriptionstring异常描述
events[].countrystring国家
events[].statestring州/省
events[].citystring城市
events[].postalCodestring邮编
events[].addressstring地址
latestWebhookobject最近一次 Webhook 状态
latestWebhook.statusstring状态:pending / sending / success / retry_wait / failed
latestWebhook.attemptCountint尝试次数
latestWebhook.nextRetryAtdatetime下次重试时间
latestWebhook.lastAttemptAtdatetime上次尝试时间
latestWebhook.responseStatusCodeint响应状态码
latestWebhook.errorMessagestring错误信息

响应示例

{
"code": 200,
"data": {
"taskId": 1001,
"carrierCode": "FEDEX",
"trackingNumber": "123456789012",
"externalReferenceNo": "ORDER-001",
"standardStatus": "in_transit",
"carrierStatus": "In Transit",
"estimatedDeliveryAt": "2026-06-30T18:00:00Z",
"originAddress": {
"country": "US",
"state": "CA",
"city": "Los Angeles",
"postalCode": "90001",
"address": "123 Main St"
},
"destinationAddress": {
"country": "US",
"state": "NY",
"city": "New York",
"postalCode": "10001",
"address": "456 Broadway"
},
"events": [
{
"eventTime": "2024-01-15T10:30:00Z",
"eventCode": "PU",
"status": "in_transit",
"statusInfo": "Picked Up",
"description": "Shipment picked up",
"exceptionDescription": "",
"country": "US",
"state": "CA",
"city": "Los Angeles",
"postalCode": "90001",
"address": "123 Main St"
}
],
"latestWebhook": {
"status": "success",
"attemptCount": 1,
"nextRetryAt": null,
"lastAttemptAt": "2024-01-15T10:35:00Z",
"responseStatusCode": 200,
"errorMessage": ""
}
},
"msg": "success"
}

业务逻辑

  1. 只能查询当前 API 用户自己的订阅
  2. 查询参数 taskIdtrackingNumber 必须且只能传其中一个
  3. trackingNumber 查询时,若同一 API 用户下存在多条相同运单号订阅(不同承运商),返回最新创建的一条(id 最大)
  4. 轨迹事件按时间升序排列
  5. Webhook 状态为最新一条记录
  6. 预计收货时间、发货地址、收货地址为任务级字段,只在成功拉取且承运商返回对应信息后更新;承运商未返回时保留已有值