Skip to main content

TMS 物流系统 API 文档

欢迎使用 TMS 物流系统 API 文档。

快速开始

  1. 获取 API 授权信息(apiKey、apiSecret、apiUserCode)
  2. 按照 接口鉴权 文档生成签名
  3. 调用相应接口

接口列表

运单服务

接口方法路径说明
询价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取消订阅

通用说明

认证方式

所有接口都需要在请求头中携带认证信息:

参数名类型是否必填说明
ApikeyStringAPI Key
TimestampString秒级时间戳
ApisignString签名值(MD5加密)

响应格式

成功响应:

{
"code": 200,
"data": {},
"message": "success"
}

错误响应:

{
"code": 400,
"data": null,
"message": "错误原因"
}