oTMS logo 开放平台
Documentation Help

订单导出/追踪

通过运输单导出/追踪接口,客户系统接入 oTMS 系统,查询 oTMS 运输单信息和状态。

版本号 文档 说明
0.1 当前版本文档

配置说明

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

注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况,会对API账号的调用进行限制,甚至停用。

目前对该接口的调用限制为每个公司每秒最多20个请求

接口说明

公共参数

环境 HTTP请求方法 HTTPS请求地址 请求主体MIME类型 响应主体MIME类型
正式环境 POST https://login.otms.cn/ws/jobSheetOutbound application/xml application/xml
沙箱环境 POST https://demo.otms.cn/ws/jobSheetOutbound application/xml application/xml

请求参数

字段名 位置 是否必填 描述 Schema
body body 运单查询请求 JAXBElementJobSheetOutboundRequest
Authorization header Basic Authorization。如果不为空,则优先使用该值作身份认证。否则使用请求报文中的用户名与密码 string
body body 运输单查询请求。包含用以筛选运输单的查询条件 JobSheetOutboundRequest

响应参数

状态码 描述 响应模型
200 successful operation JobSheetOutboundResponse

详细描述

AssignedDriver

字段名 类型 是否必填 描述 示例
driverName string 司机姓名
realName string 司机真实姓名
mobile string 司机手机号码
idCard string 司机身份证号码
truckPlate string 车牌号
truckDeviceNumber string 车载设备号

CustomFieldsInfo

字段名 类型 是否必填 描述 示例
customText1 string 自定义文本字段1
customText2 string 自定义文本字段2
customText3 string 自定义文本字段3
customText4 string 自定义文本字段4
customText5 string 自定义文本字段5
customText6 string 自定义文本字段6
customText7 string 自定义文本字段7
customText8 string 自定义文本字段8
customText9 string 自定义文本字段9
customText10 string 自定义文本字段10
customText11 string 自定义文本字段11
customText12 string 自定义文本字段12
customText13 string 自定义文本字段13
customText14 string 自定义文本字段14
customText15 string 自定义文本字段15
customText16 string 自定义文本字段16
customText17 string 自定义文本字段17
customText18 string 自定义文本字段18
customText19 string 自定义文本字段19
customText20 string 自定义文本字段20
customText21 string 自定义文本字段21
customText22 string 自定义文本字段22
customText23 string 自定义文本字段23
customText24 string 自定义文本字段24
customText25 string 自定义文本字段25
customText26 string 自定义文本字段26
customText27 string 自定义文本字段27
customText28 string 自定义文本字段28
customText29 string 自定义文本字段29
customText30 string 自定义文本字段30
customNum1 number 自定义小数字段1 -- 精确到18位数、6位小数
customNum2 number 自定义小数字段2 -- 精确到18位数、6位小数
customNum3 number 自定义小数字段3 -- 精确到18位数、6位小数
customNum4 number 自定义小数字段4 -- 精确到18位数、6位小数
customNum5 number 自定义小数字段5 -- 精确到18位数、6位小数
customNum6 number 自定义小数字段6 -- 精确到18位数、6位小数
customNum7 number 自定义小数字段7 -- 精确到18位数、6位小数
customNum8 number 自定义小数字段8 -- 精确到18位数、6位小数
customNum9 number 自定义小数字段9 -- 精确到18位数、6位小数
customNum10 number 自定义小数字段10 -- 精确到18位数、6位小数
customEnum1 string 自定义字段中定义并激活的枚举变量1的逻辑名
customEnum2 string 自定义字段中定义并激活的枚举变量2的逻辑名
customEnum3 string 自定义字段中定义并激活的枚举变量3的逻辑名
customEnum4 string 自定义字段中定义并激活的枚举变量4的逻辑名
customEnum5 string 自定义字段中定义并激活的枚举变量5的逻辑名
customEnum6 string 自定义字段中定义并激活的枚举变量6的逻辑名
customEnum7 string 自定义字段中定义并激活的枚举变量7的逻辑名
customEnum8 string 自定义字段中定义并激活的枚举变量8的逻辑名
customEnum9 string 自定义字段中定义并激活的枚举变量9的逻辑名
customEnum10 string 自定义字段中定义并激活的枚举变量10的逻辑名
customEnum1Zh string 自定义字段中定义并激活的枚举变量1的中文名
customEnum2Zh string 自定义字段中定义并激活的枚举变量2的中文名
customEnum3Zh string 自定义字段中定义并激活的枚举变量3的中文名
customEnum4Zh string 自定义字段中定义并激活的枚举变量4的中文名
customEnum5Zh string 自定义字段中定义并激活的枚举变量5的中文名
customEnum6Zh string 自定义字段中定义并激活的枚举变量6的中文名
customEnum7Zh string 自定义字段中定义并激活的枚举变量7的中文名
customEnum8Zh string 自定义字段中定义并激活的枚举变量8的中文名
customEnum9Zh string 自定义字段中定义并激活的枚举变量9的中文名
customEnum10Zh string 自定义字段中定义并激活的枚举变量10的中文名
customEnum1En string 自定义字段中定义并激活的枚举变量1的英文名
customEnum2En string 自定义字段中定义并激活的枚举变量2的英文名
customEnum3En string 自定义字段中定义并激活的枚举变量3的英文名
customEnum4En string 自定义字段中定义并激活的枚举变量4的英文名
customEnum5En string 自定义字段中定义并激活的枚举变量5的英文名
customEnum6En string 自定义字段中定义并激活的枚举变量6的英文名
customEnum7En string 自定义字段中定义并激活的枚举变量7的英文名
customEnum8En string 自定义字段中定义并激活的枚举变量8的英文名
customEnum9En string 自定义字段中定义并激活的枚举变量9的英文名
customEnum10En string 自定义字段中定义并激活的枚举变量10的英文名

In

字段名 类型 是否必填 描述 示例
value array[string] 属性值

JAXBElementJobSheetOutboundRequest

字段名 类型 是否必填 描述 示例
name QName -
value JobSheetOutboundRequest -
nil boolean -
globalScope boolean -
typeSubstituted boolean -

JobSheetDetail

字段名 类型 是否必填 描述 示例
jobSheetNumber string 运单号
externalShipmentId string 外部单号
quantity integer (int32) 总数量
totalVolume number 总体积
totalWeight number 总重量
remark string 备注
transportType string 运输模式, 包括如下常量:
FTL - 整车
LTL - 零担
AIR - 空运
EXPRESS - 快递
RAIL - 铁路
WATER - 水运
cargoType integer (int32) 货物类型,考虑到oTMS用户存在共识的运输订单交易的性质。包括如下常量:
1 - 普通货物
2 - 温控货物
3 - 危险品
4 - 危险品和温控货物
packageType string 包装类型,包括如下常量:
A - 散箱,可堆叠,人工装卸货。已有的卡车容量可以被充分利用,运输提供商不需要特别的装货设备
B - 托盘或者木箱,可堆叠,需叉车装卸货。通常卡车利用率高,可以双重叠加托盘,运输提供商需要叉车装卸货
C - 托盘,木箱或不规则形状,不可堆叠,需叉车装卸货。卡车不能被充分利用,建议货物各方根据LDM而不是CBM/MT来协定零担价格
D - 不允许配货,包车运输。这些货主创建的只能整车收费 (根据卡车尺寸付款) 的订单无论大小都是整车装运
E - 保温箱,可堆叠,人工装卸货
location string 地区
truckType integer (int32) 车辆类型,包括如下常量:
0 - 敞篷车
1 - 厢式车
2 - 任意
3 - 轿运车
4 - 油罐车
5 - 飞翼车
6 - 高栏车
7 - 平板车
8 - 罐车
9 - 冷藏车
pickupSla string (date-time) 要求的提货日期
deliverySla string (date-time) 要求的送货日期
vendorShortCode string 承运商代码
state string 运单状态,包括如下常量:
INBOX - 新建
RELEASED - 释放
DISPATCHED - 分配
ALLOCATING - 预分配
PICKUP - 提货
DELIVERY - 送达
vendorName string 承运商名称
shipFrom JobSheetLocationInfo 发货点信息
shipTo JobSheetLocationInfo 收货点信息
portableDevices array[PortableDevice] 订单的便携式设备,按设备编号排序
assignedDriver AssignedDriver 订单分配的司机
customFields CustomFieldsInfo 自定义字段。这适用于启用并且正确配置了自定义字段的公司。
orders array[JobSheetOrderInfo] 订单

JobSheetLocationInfo

字段名 类型 是否必填 描述 示例
name string 该收/发货点的公司名
province string 省份名
town string 城市名
county string 区/县名

JobSheetOrderBy

字段名 类型 是否必填 描述 示例
asc|desc array[string] 元素名可以是"asc"或者"desc",分别表示升序和降序。查询结果的排序方式 ()

JobSheetOrderInfo

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

JobSheetOutboundRequest

字段名 类型 是否必填 描述 示例
version string 请求的版本号
login string 用户名。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。
password string 密码。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。
queries Queries 用以筛选订单的查询条件
orderBy JobSheetOrderBy 查询结果的排序方式
start integer (int32) 返回订单的起始索引,最小为1。默认值是1。
count integer (int32) 返回的最大订单数量。默认值是100。
includeOrderInfo boolean 运单订单是否应包含在返回中。默认值是false。

JobSheetOutboundResponse

字段名 类型 是否必填 描述 示例
jobSheets JobSheets 返回的运单列表
start integer (int32) 返回运单的起始索引
count integer (int32) 实际返回的运单数量
total integer (int32) 该次查询中筛选出的所有运单的数量

JobSheetQuery

字段名 类型 是否必填 描述 示例
attribute string 查询条件的属性名。可以取下列值:
client - 客户在oTMS中的公司代码
vendor - 承运商在oTMS中的公司代码
jobSheetNumber - oTMS订单号
externalShipmentId - ERP单号
eq string 属性值等于该值
ge string 属性值大于或等于该值
le string 属性值小于或等于该值
in In 属性值包含于该列表中。不支持日期/时间类型的属性
lk string 属性值模糊匹配该值

JobSheets

字段名 类型 是否必填 描述 示例
jobSheet array[JobSheetDetail] 运单信息

PortableDevice

字段名 类型 是否必填 描述 示例
portableDevice string 订单的便携式设备

QName

字段名 类型 是否必填 描述 示例
namespaceURI string -
localPart string -
prefix string -

Queries

字段名 类型 是否必填 描述 示例
query array[JobSheetQuery] 查询条件。至少须提供一个查询条件,多个查询条件以逻辑‘与’的方式连接。

报文示例

请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetOutboundRequest version="0.1" login="username" password="password">
    <queries>
        <query>
            <attribute>jobSheetNumber</attribute>
            <eq>ssss</eq>
        </query>
    </queries>
    <includeOrderInfo>true</includeOrderInfo>
    <orderBy>
        <desc>jobSheetNumber</desc>
    </orderBy>
    <start>1</start>
    <count>10</count>
</jobSheetOutboundRequest>

响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetOutboundResponse>
    <jobSheets>
        <jobSheet>
            <jobSheetNumber>222</jobSheetNumber>
            <quantity>3</quantity>
            <totalVolume>448.065000</totalVolume>
            <totalWeight>5115.000</totalWeight>
            <transportType>LTL</transportType>
            <cargoType>1</cargoType>
            <packageType>A</packageType>
            <truckType>2</truckType>
            <pickupSla>2017-01-09T00:00:00.000</pickupSla>
            <deliverySla>2017-01-09T00:00:00.000</deliverySla>
            <state>DISPATCHED</state>
            <vendorName>33</vendorName>
            <shipFrom>
                <province>上海市</province>
                <town>上海市</town>
            </shipFrom>
            <shipTo>
                <province>上海市</province>
                <town>上海市</town>
            </shipTo>
            <portableDevices>
                <portableDevice>123123123</portableDevice>
            </portableDevices>
            <portableDevices>
                <portableDevice>105d1</portableDevice>
            </portableDevices>
            <assignedDriver/>
            <orders>
                <sequence>1</sequence>
                <orderNumber>33</orderNumber>
            </orders>
            <orders>
                <sequence>-1</sequence>
                <orderNumber>44</orderNumber>
            </orders>
            <orders>
                <sequence>-1</sequence>
                <orderNumber>55</orderNumber>
            </orders>
        </jobSheet>
    </jobSheets>
    <start>1</start>
    <count>1</count>
    <total>1</total>
</jobSheetOutboundResponse>

API工具