TMS 物流系统 API 文档
欢迎使用 TMS 物流系统 API 文档 。
快速开始
- 获取 API 授权信息(apiKey、apiSecret、apiUserCode)
- 按照 接口鉴权 文档生成签名
- 调用相应接口
接口列表
运单服务
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 询价 | POST | /label/carrier/rate | 查询承运商报价 |
| 下单 | POST | /label/carrier/create | 创建运单 |
| 取消运单 | POST | /label/carrier/void | 取消已创建运单 |
| 轨迹查询 | POST | /label/carrier/tracking | 查询物流轨迹 |
| 地址校验 | POST | /label/carrier/verifyAddress | 校验地址 |
| 批量创建运单 | POST | /label/sync-batch-create | 批量异步创建运单 |
轨迹订阅
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 订阅轨迹 | POST | /openapi/tracking-subscriptions | 单条订阅 |
| 批量订阅 | POST | /openapi/tracking-subscriptions/batch | 批量订阅 |
| 查询订阅 | GET | /openapi/tracking-subscriptions | 查询订阅详情 |
| 轨迹回调说明 | POST | 订阅时传入的 callbackUrl | 异步回调通知格式与重试规则 |
| 取消订阅 | POST | /openapi/tracking-subscriptions/:id/cancel | 取消订阅 |
通用说明
认证方式
所有接口都需要在请求头中携带认证信息:
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| Apikey | String | 是 | API Key |
| Timestamp | String | 是 | 秒级时间戳 |
| Apisign | String | 是 | 签名值(MD5加密) |
响应格式
成功响应:
{
"code": 200,
"data": {},
"message": "success"
}
错误响应:
{
"code": 400,
"data": null,
"message": "错误原因"
}