oTMS-openapi
  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
    • 拒收导出
      POST
    • 收货码查询
      POST
    • 便携式设备导入
      POST
  1. oTMS API

运输单事件推送

PUT
https://login.otms.cn

运输单事件推送#

通过运输单事件推送接口，oTMS系统将运输单的各类事件（如状态更新、位置信息等）主动推送到客户预先配置的指定接收服务中。对方系统在接收到推送请求后，应按照约定的响应格式返回相应的确认或处理结果。
注意: 此接口是由 oTMS 作为客户端主动发起调用，向外部系统的服务器发送数据，而非由外部系统调用 oTMS 的API。

配置说明#

oTMS同时在生产环境和测试环境中提供此事件推送功能。需要由oTMS系统管理员为您的公司配置目标接收服务的URL地址，并分配必要的认证信息（如需）。两种环境下都需要进行相应配置方可使用。
注意: 请确保您提供的接收服务能够稳定、及时地处理oTMS的推送请求。如果发现接收方存在异常响应或对系统性能造成影响等情况，oTMS可能会对推送频率进行调整或暂停推送。

接口说明#

公共参数#

由于此接口是 oTMS 向外推送，因此没有固定的 oTMS 端 HTTPS 请求地址。接收方需要提供一个可供 oTMS 访问的公网 URL。
环境HTTP请求方法HTTPS请求地址 (由接收方提供)请求主体MIME类型响应主体MIME类型
正式环境PUTapplication/xmlapplication/xml
沙箱环境PUTapplication/xmlapplication/xml

请求参数#

字段名位置是否必填描述Schema
bodybody是运输单消息推送请求，包含具体的事件类型和相关数据event

错误码解释#

当接收方系统处理完推送请求后，需要返回以下代码以告知 oTMS 处理结果：

单个请求反馈代码#

反馈代码说明
0成功。接收方已成功处理事件。
11运输单不存在。接收方无法识别该运输单。
99未知错误。接收方处理过程中发生未预期的错误。

请求参数

Body 参数application/json

示例
{
  "events": [
    {
      "eventId": 1,
      "jobSheetNumber": "JSYBLHQYHD001209",
      "externalShipmentId": "2508201",
      "eventType": 10,
      "eventTime": "2025-08-20 17:30:00"
    },
    {
      "eventId": 2,
      "jobSheetNumber": "JSYBLHQYHD001208",
      "eventType": 20,
      "eventTime": "2025-08-20 17:30:00",
      "truck": {
        "truckPlate": "A111111",
        "driverName": "AA",
        "driverMobile": "13211112222"
      },
      "orders": [
        {
          "erpNumber":"250818003",
          "orderNumber": "YBLHQYHD018244",
          "sequence": 1
        },
        {
          "erpNumber":"250818004",
          "orderNumber": "YBLHQYHD018245",
          "sequence": 2
        }
      ]
    }
  ]
}

返回响应

🟢200成功
application/json
Body

示例
{
    "results": [
        {
            "eventId": 1,
            "responseCode": 0
        },
        {
            "eventId": 2,
            "responseCode": 11
        }
    ]
}
上一页
订单事件推送
下一页
拒收导出
Built with