This commit is contained in:
wuweihua
2026-09-24 18:02:53 +08:00
2 changed files with 11 additions and 5 deletions
@@ -1,8 +1,8 @@
# TMS 订单账单状态查询接口
# TMS 订单额度欠费状态和客户状态查询接口
## 1. 接口用途
TMS 根据订单号、运单号或转单号查询 BMS 中的订单计费记录,并获取该订单关联客户的当前启用状态和订单计费记录中的欠费状态快照。
TMS 根据订单号、运单号或转单号查询 BMS 中的订单计费记录,并获取该订单关联客户的当前启用状态和订单计费记录中的欠费状态快照。其他字段返回用于TMS辅助判断。
## 2. 基本信息
@@ -11,13 +11,13 @@ TMS 根据订单号、运单号或转单号查询 BMS 中的订单计费记录
|---|---|
| 请求方式 | `GET` |
| 请求地址 | `/api/tms/order-bill/status` |
| 完整地址示例 | `http://{BMS_HOST}:{PORT}/api/tms/order-bill/status` |
| 完整地址示例 | `https://bms.lionquexpress.com/prod-api/api/tms/order-bill/status` |
| 登录要求 | 不需要登录 Token |
| 接口鉴权 | 必须携带请求头 `X-Api-Code` |
| 字符编码 | UTF-8 |
| 响应格式 | JSON |
> `X-Api-Code` 的实际值由 BMS 管理方通过安全渠道提供,不在业务代码、接口文档或工单中明文传播。
> `X-Api-Code` = BMS.TMS.ZYaOvlQzpcfau8TUaCFfO3Hp8ieHIqGw
## 3. 请求参数
@@ -47,6 +47,8 @@ OR transfer_no = identifier
## 4. 请求示例
按订单号查询:
```bash
curl --location \
'http://{BMS_HOST}:{PORT}/api/tms/order-bill/status?identifier=TMS20260918005496762601' \
@@ -258,4 +260,3 @@ curl --location \
5. `customerActiveStatus` 只返回 `ACTIVE`、`MISSING`、`DISABLED` 三种约定状态;只有 `ACTIVE` 表示客户当前启用,其他状态由 TMS 根据自身规则处理。
6. `creditArrearsStatus` 是订单计费记录中的状态快照,不代表客户当前实时额度状态。
7. 建议设置连接超时和读取超时,并对网络异常进行有限次数重试;查询接口本身是只读接口,可安全重试。
8. `X-Api-Code` 属于接口凭证,应通过配置中心或密钥管理方式保存,不要硬编码到 TMS 代码仓库或日志中。
@@ -2,6 +2,11 @@
# 启动:--spring.profiles.active=prod
# Elasticsearch:172.19.64.13:9200
# 生产环境文件存储根目录
# 上传、导入、头像及账单下载文件都会基于此目录保存
ruoyi:
profile: /www/server/bms/data
logging:
level:
com.ruoyi: info