oTMS logo 开放平台
Documentation Help

运输单事件推送

通过运输单事件推送接口,oTMS系统将运输单事件推到指定的服务中,对方系统应按照请求对应的响应格式返回相应的信息。

配置说明

oTMS同时在生产环境和测试环境中提供Web Service接口,其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。

接口说明

公共参数

环境 HTTP请求方法 HTTPS请求地址 请求主体MIME类型 响应主体MIME类型
正式环境 PUT -
沙箱环境 PUT -

请求参数

字段名 位置 是否必填 描述 Schema
body body 运输单消息推送请求 event

响应参数

状态码 描述 响应模型
default successful operation -

详细描述

event

字段名 类型 是否必填 描述 示例
eventId string 事件ID
jobSheetNumber string job sheet单号
externalShipmentId string 外部运输单号
eventType string 事件类型:,
10:释放
20:分配车辆
30:召回(车辆)
eventTime string (date-time) 事件产生时间
truck truck 分配的车辆信息,仅支持以下事事件:
20:分配车辆
30:召回(车辆)
orders array[order] 包含的订单信息列表,仅支持以下事件:
20:分配车辆
30:召回(车辆)

order

字段名 类型 是否必填 描述 示例
orderNumber string 订单号
erpNumber string ERP单号
sequence integer (int32) 顺序号

truck

字段名 类型 是否必填 描述 示例
truckPlate string 车牌
driverName string 司机姓名
driverMobile string 司机手机号

报文示例

请求示例

{
  "events": [
    {
      "eventId": 1,
      "jobSheetNumber": "JSSH00105000001",
      "externalShipmentId": "EXTERNAL001",
      "eventType": 10,
      "eventTime": "2017-08-24 14:01:45"
    },
    {
      "eventId": 2,
      "jobSheetNumber": "JSSH00105000028",
      "eventType": 20,
      "eventTime": "2017-11-03 17:31:09",
      "truck": {
        "truckPlate": "A111111",
        "driverName": "王师傅",
        "driverMobile": "13218893083"
      },
      "orders": [
        {
          "erpNumber":"ERP001",
          "orderNumber": "SH00105085582",
          "sequence": 1
        },
        {
          "erpNumber":"ERP002",
          "orderNumber": "SH00105085583",
          "sequence": 2
        }
      ]
    }
  ]
}

响应示例

{
  "results": [
    {
      "eventId": 1,
      "responseCode": 0
    },
    {
      "eventId": 2,
      "responseCode": 11
    }
  ]
}

错误码解释

全局反馈代码

反馈代码 说明

单个请求反馈代码

反馈代码 说明
0成功。
11运输单不存在。
99未知错误。