1. oTMS API
oTMS-openapi
  • oTMS API
    • 订单导入
      PUT
    • 订单导出/追踪
      POST
    • 提送货点导入
      PUT
    • 提送货点删除
      DELETE
    • 卡车和司机导入
      PUT
    • 订单分配司机
      POST
    • 运输单导入
      PUT
    • 运输单删除
      PUT
    • 订单外部追踪
      POST
    • 订单召回
      POST
    • 订单分享链接
      PUT
    • 承运商导出
      POST
    • h5链接
      PUT
    • 订单更新
      PUT
    • 订单费用更新
      POST
    • 订单分配
      POST
    • 车辆信息
      POST
    • 订单撤销
      PUT
    • 运输单分配司机
      PUT
    • 订单评分
      POST
    • 订单交接创建
      PUT
    • 订单自定义文本字段更新
      POST
    • 订单快速交接
      POST
    • 价格文件匹配
      POST
    • 收货方/发货方导出
      POST
    • 运输单导出/追踪
      POST
    • 运输单召回
      PUT
    • 文件上传
      POST
    • 订单事件推送
      PUT
    • 运输单事件推送
      PUT
    • 账单事件推送
      PUT
    • 拒收导出
      POST
    • 收货码查询
      POST
    • 便携式设备导入
      POST
    • 签收单导出
      POST
  1. oTMS API

账单事件推送

PUT
https://login.otms.cn

账单事件推送#

通过账单事件推送接口,oTMS 系统将账单相关的事件(如账单生成、状态变更等)主动推送到客户预先配置的指定服务中。接收系统在接收到推送请求后,应按照 oTMS 要求的响应格式返回处理结果。
说明:账单事件推送接口为 反向调用接口,即由 oTMS 作为客户端发起请求,外部系统作为服务端接收数据。

配置说明#

oTMS 同时在生产环境和测试环境中提供账单事件推送功能,其中测试环境用于集成测试。
两种环境下均需由 oTMS 系统管理员为客户分配 API 账号及密码,并配置接收服务的 URL 地址后方可启用推送。

接口说明#

公共参数#

环境HTTP 请求方法HTTPS 请求地址请求主体 MIME 类型响应主体 MIME 类型
正式环境PUT(由客户系统提供)application/jsonapplication/json
沙箱环境PUT(由客户系统提供)application/jsonapplication/json
注意:HTTPS 请求地址不是固定的 otms.cn 地址,而是由客户系统提供并配置在 oTMS 中的公网可访问 URL。

请求参数#

字段名位置是否必填描述Schema
Authorizationheader否事件推送用户验证。若接收系统需要身份校验,可要求 oTMS 在 Header 中携带 Basic Auth 凭据。需提前向 oTMS 提供用户名/密码。string
bodybody是账单事件推送请求体,包含一个或多个账单事件对象array[OrderForBillingEventDto]

响应参数#

HTTP 状态码描述响应模型
200successful operationPushBillingEventResponse
接收系统必须返回符合 PushBillingEventResponse 格式的 JSON 响应,以告知 oTMS 处理结果(例如是否成功、失败原因等)。具体字段结构需与 oTMS 官方文档对齐。

重要提示#

本接口为 服务端推送(Server Push) 模式,依赖客户提供的稳定、高可用的接收端点。
若推送失败(如超时、非 200 响应、响应格式错误等),oTMS 可能会根据内部策略进行重试。
如需启用 Authorization 验证,请务必提前与 oTMS 技术支持协调认证方式及凭证配置。

错误码解释#

全局反馈代码#

反馈代码说明
—(无全局错误码定义,以单个请求反馈为准)
注:当前接口未定义独立的全局反馈代码,主要依赖单个请求的反馈结果进行判断。

单个请求反馈代码#

反馈代码说明
S成功。
E失败。
O其他。
S:表示该账单事件已由接收系统成功处理。
E:表示处理过程中发生明确错误,事件未被接受或处理失败。
O:表示非标准状态(如部分成功、待人工干预、状态未知等),需结合业务上下文进一步判断。
建议:接收系统在返回 E 或 O 时,应在响应体中提供详细的错误描述或日志 ID,便于问题排查。

请求参数

Body 参数application/json

示例
                    {
                      "orderType": "1",
                      "billingId": "650",
                      "billingName": ".D",
                      "billingCreator": "Li Na",
                      "billAcceptedAt": "2016-11-11T23:59:00.000",
                      "customFields": {
                        "customEnum1": "2",
                        "customEnum2": "3",
                        "customEnum3": "5",
                        "customEnum4": "4",
                        "customText1": "li",
                        "customNum1": "1"
                      },
                      "partnerCode": "WH",
                      "partnerName": "物流有限公司-武汉公司",
                      "partnerHeadOfficeCode": "SP",
                      "partnerHeadOfficeName": "ch",
                      "orderNumber": "WH12793490",
                      "erpNumber": "234",
                      "allocateTime": "2016-11-11T23:59:00.000",
                      "pickupSla": "2016-11-11T23:59:00.000",
                      "deliverySla": "2016-11-14T23:59:00.000",
                      "actualDelivery": "2016-11-14T23:59:00.000",
                      "totalVolume": "100cbm",
                      "totalWeight": "100kg",
                      "vat": "11",
                      "totalRate": "100",
                      "finalRate": "100",
                      "consolidated": "false",
                      "shipFromExternalId": "0506",
                      "shipToExternalId": "8S67",
                      "rateDetail": [
                        {
                          "rateName": "base",
                          "rate": "80",
                          "description": "base rate"
                        },
                        {
                          "rateName": "pickup",
                          "rate": "10",
                          "description": "pickup rate"
                        }
                      ],
                      "adjustmentRate": [
                        {
                          "adjustment_type": "1",
                          "rate": "-10",
                          "description": "compensation"
                        },
                        {
                          "adjustment_type": "2",
                          "rate": "9",
                          "description": "special fee"
                        },
                        {
                          "adjustment_type": "3",
                          "rate": "19",
                          "description": "manually change"
                        }
                      ],
                      "billingTotal":3244598.22,
                      "billingRecalculationMethod":"BY_RMB",
                      "billingRecalculationAmount":0.00,
                      "billingRemarks":"备注"
                    }

返回响应

🟢200成功
application/json
Bodyapplication/json

示例
{
    "type": "S"
}
上一页
运输单事件推送
下一页
拒收导出
Built with