TMS 运单开放接口-运单 详情
基本信息
- 方法:
POST - 路径:
/label/detail
用途
按跟踪号、卖家订单号或 TMS 运单号查询当前用户名下的运单基本信息(含跟踪号列表、面单地址、费用预估等)。
公共请求头
所有 TMS 运单开放接口都需要传以下请求头:
Content-Type: application/json
Apikey: {{api_key}}
Apisign: {{api_sign}}
Timestamp: {{timestamp}}
请求参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| trackingCode | string | 条件必填 | 跟踪号 |
| sellerOrderNumber | string | 条件必填 | 卖家订单号 |
| shipmentOrderNumber | string | 条件必填 | TMS 运单号 |
说明:三者至少传一个;同时传多个时按 AND 拼接条件。
请求示例
{
"trackingCode": "1Z999AA10123456784",
"sellerOrderNumber": "",
"shipmentOrderNumber": ""
}
成功响应示例
{
"code": 200,
"data": [
{
"masterTrackingNumber": "1Z999AA10123456784",
"shipmentOrderNumber": "",
"carrierCode": "UPARCEL",
"serviceCode": "GROUND",
"totalCharge": 15.67,
"currencyCode": "USD",
"labelUrl": "https://api.example.com/file/label/shipment_xxx",
"labelFileType": "pdf",
"trackingNumbers": ["1Z999AA10123456784"],
"sellerOrderNumber": "SO-20260626-001",
"createLabelTime": "2026-06-26 10:00:00"
}
],
"message": ""
}
返回字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data[].masterTrackingNumber | string | 主跟踪号 |
| data[].shipmentOrderNumber | string | TMS 运单号(当前固定为空) |
| data[].carrierCode | string | 承运商代码 |
| data[].serviceCode | string | 服务代码 |
| data[].totalCharge | float | 总费用(预估) |
| data[].currencyCode | string | 币种,当前固定为 USD |
| data[].labelUrl | string | 仅在运单已出单的状态下返回,否则为空 |
| data[].labelFileType | string | 固定为 pdf |
| data[].trackingNumbers | array[string] | 跟踪号列表 |
| data[].sellerOrderNumber | string | 卖家订单号 |
| data[].createLabelTime | string | 下单时间,格式 YYYY-MM-DD HH:mm:ss |
接口说明
- 三个查询字段至少传一个,同时传多个时按
AND拼接条件 - 仅返回当前鉴权用户名下的运单
labelUrl仅在运单已出单的状态下返回,其他状态下为空PlatformOrderNumber、ChargeItems、SurchargeItems、ShipmentLabels等字段固定为空,仅返回基础信息- 高频查询建议用
trackingCode,索引最稳
错误响应示例
{
"code": 400,
"data": null,
"message": "请求参考无数,请传入正确的单号"
}
| code | message | 场景 |
|---|---|---|
| 401 | 请传入API授权信息 | 缺少 Apikey |
| 401 | 请传入apiSign授权签名信息 | 缺少 Apisign |
| 400 | 请求参考无数 | 参数绑定失败 |
| 400 | 请求参考无数,请传入正确的单号 | 三个查询字段全部为空 |
响应码约定:
- 成功时响应体
code = 200 - 参数校验或业务失败时,通常返回
code = 400 - 鉴权失败时,通常返回
code = 401 - 这套开放接口的成功码不是后台私有接口常见的
0