oTMS logo 开放平台
Documentation Help

订单导出/追踪

通过订单导出/追踪接口,客户系统接入 oTMS 系统,查询 oTMS 订单信息和状态。注意:如果订单已结账超过3个月,这个接口就查不到这个订单。

版本号 文档 说明
0.1 查看0.1版本文档
0.2 当前版本文档

配置说明

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

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

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

接口说明

公共参数

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

请求参数

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

响应参数

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

详细描述

AssignedDriver

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

AssignedDriverType

字段名 类型 是否必填 描述 示例
assignedDriver array[AssignedDriver] 否 订单分配的司机

AssignedDrivers

字段名 类型 是否必填 描述 示例
pickup AssignedDriverType 否 订单提货司机

CargoDiscrepancyFile

字段名 类型 是否必填 描述 示例
fileName string 否 文件名
fileId string 否 文件ID

CargoDiscrepancyFiles

字段名 类型 是否必填 描述 示例
eventFiles array[CargoDiscrepancyFile] 否 货差图片列表,按时间排序

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
customText31 string 否 自定义文本字段31
customText32 string 否 自定义文本字段32
customText33 string 否 自定义文本字段33
customText34 string 否 自定义文本字段34
customText35 string 否 自定义文本字段35
customText36 string 否 自定义文本字段36
customText37 string 否 自定义文本字段37
customText38 string 否 自定义文本字段38
customText39 string 否 自定义文本字段39
customText40 string 否 自定义文本字段40
customText41 string 否 自定义文本字段41
customText42 string 否 自定义文本字段42
customText43 string 否 自定义文本字段43
customText44 string 否 自定义文本字段44
customText45 string 否 自定义文本字段45
customText46 string 否 自定义文本字段46
customText47 string 否 自定义文本字段47
customText48 string 否 自定义文本字段48
customText49 string 否 自定义文本字段49
customText50 string 否 自定义文本字段50
customText51 string 否 自定义文本字段51
customText52 string 否 自定义文本字段52
customText53 string 否 自定义文本字段53
customText54 string 否 自定义文本字段54
customText55 string 否 自定义文本字段55
customText56 string 否 自定义文本字段56
customText57 string 否 自定义文本字段57
customText58 string 否 自定义文本字段58
customText59 string 否 自定义文本字段59
customText60 string 否 自定义文本字段60
customText61 string 否 自定义文本字段61
customText62 string 否 自定义文本字段62
customText63 string 否 自定义文本字段63
customText64 string 否 自定义文本字段64
customText65 string 否 自定义文本字段65
customText66 string 否 自定义文本字段66
customText67 string 否 自定义文本字段67
customText68 string 否 自定义文本字段68
customText69 string 否 自定义文本字段69
customText70 string 否 自定义文本字段70
customText71 string 否 自定义文本字段71
customText72 string 否 自定义文本字段72
customText73 string 否 自定义文本字段73
customText74 string 否 自定义文本字段74
customText75 string 否 自定义文本字段75
customText76 string 否 自定义文本字段76
customText77 string 否 自定义文本字段77
customText78 string 否 自定义文本字段78
customText79 string 否 自定义文本字段79
customText80 string 否 自定义文本字段80
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的英文名

Discussions

字段名 类型 是否必填 描述 示例
discussion array[OrderDiscussion] 否 订单的讨论列表,按时间排序

DockAppointment

字段名 类型 是否必填 描述 示例
expectedArrivalTime string (date-time) 是 预期到达时间
driverName string 是 司机姓名
truckPlate string 是 卡车车牌号
driverMobile string 是 司机手机号码

EpodFile

字段名 类型 是否必填 描述 示例
fileName string 否 文件名
fileId string 否 文件ID

EpodFiles

字段名 类型 是否必填 描述 示例
epodFile array[EpodFile] 否 订单回单图片列表

In

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

JAXBElementOrderOutboundRequest

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

OrderBasicInfo

字段名 类型 是否必填 描述 示例
orderNumber string 否 订单号
sequence string 否 序列号
erpNumber string 否 ERP单号
lastUpdateTime string (date-time) 否 订单更新日期
requestKey string 否 查询条件

OrderBy

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

OrderDetail

字段名 类型 是否必填 描述 示例
clientDetail PartnerDetail 否 与客户相关的订单明细
vendorDetail PartnerDetail 否 与承运商相关的订单明细
orderInfo OrderInfo 否 订单的基础信息。该元素只有在请求中的元素为true时才会被包含在返回中
pickupSla string (date-time) 否 要求的提货日期
deliverySla string (date-time) 否 要求的送货日期
orderStatus string 否 订单状态。
pickupDelayReason string 否 订单提货延迟原因
deliveryDelayReason string 否 订单送货延迟原因
orderEvents OrderEvents 否 订单的事件列表,按时间排序
discussions Discussions 否 订单的讨论列表,按时间排序
temperatureMonitorDevices array[TemperatureMonitorDevice] 否 订单的温控设备,按设备编号排序
portableDevices array[PortableDevice] 否 订单的便携式设备,按设备编号排序
assignedDrivers AssignedDrivers 否 订单分配的司机
orderBasicInfo OrderBasicInfo 否 订单更新日期等基础信息。该元素只有在请求中的元素为true时才会被包含在返回中
epodFiles EpodFiles 否 回单图片列表

OrderDiscussion

字段名 类型 是否必填 描述 示例
author string 否 消息的作者
time string (date-time) 否 消息发表的时间
message string 否 消息的内容

OrderEvent

字段名 类型 是否必填 描述 示例
name string 否 事件的名称/类型
time string (date-time) 否 事件的时间
operationTime string (date-time) 否 事件的操作时间
remark string 否 事件的备注
cargoDiscrepancyCategory string 否 差异类别
orderLineRejections OrderLineRejections 否 货差事件列表,按时间排序
rejectionReason string 否 事件的原因
latitude number (double) 否 事件的纬度
longitude number (double) 否 事件的经度
updateSource string 否 更新来源
userInformation string 否 更新人
discrepancyId integer (int64) 否 事件ID
cargoDiscrepancyFiles CargoDiscrepancyFiles 否 货差事件图片列表列表
orderDiscrepancys OrderLineConfirmedDiscrepancys 否 货差事件列表,按时间排序

OrderEvents

字段名 类型 是否必填 描述 示例
event array[OrderEvent] 否 订单的事件列表,按时间排序

OrderInfo

字段名 类型 是否必填 描述 示例
remark string 否 订单备注
location string 否 订单的地区名
shipFrom OrderLocationInfo 否 发货点信息
shipTo OrderLocationInfo 否 收货点信息
totalWeight number 否 订单的总重量 (单位:千克)
totalVolume number 否 订单的总体积 (单位:立方米)
totalQuantity integer (int32) 否 订单中货物的总数量
totalInsurance number 否 订单中总保值/货值
minTemperature number 否 订单要求最低温度
maxTemperature number 否 订单要求最高温度
orderLines OrderLines 否 货物/产品明细列表
customFields CustomFieldsInfo 否 自定义字段。这适用于启用并且正确配置了自定义字段的公司。
dockAppointment DockAppointment 否 预约信息。
positions array[OutboundOrderPosition] 否 订单位置信息.
cargoType integer (int32) 否 货物类型,考虑到oTMS用户存在共识的运输订单交易的性质。包括如下常量:
1 - 普通货物
2 - 温控货物
3 - 危险品
4 - 危险品和温控货物
transportType string 否 运输类型。包括如下常量:
LTL - 零担
FTL - 整车
AIR - 空运
EXPRESS - 快递
WATER - 水运
RAIL - 铁路
locationHistories array[TruckLocationHistory] 否 订单卡车的历史轨迹。
businessType string 否 订单类型
jobSheetNumber string 否 运输单号
transportMode OrderTransportMode 否 货运信息
transportDistance number 否 运输距离

OrderLineConfirmedDiscrepancy

字段名 类型 是否必填 描述 示例
cargoCode string 否 货物代码
cargoName string 否 货物名称
unit string 否 货物单位
totalLossQuantity number 否 丢失数量
totalDamageQuantity number 否 破损数量
state string 否 状态

OrderLineConfirmedDiscrepancys

字段名 类型 是否必填 描述 示例
discrepancies array[OrderLineConfirmedDiscrepancy] 否 货差确认列表,按时间排序

OrderLineConfirmedRejection

字段名 类型 是否必填 描述 示例
cargoCode string 否 货物代码
cargoName string 否 货物名称
unit string 否 货物单位
totalQuantity number 否 货物总数
totalRejectionQuantity number 否 拒收数量
state string 否 状态

OrderLineInfo

字段名 类型 是否必填 描述 示例
productCode string 否 产品代码
productName string 否 产品名称
quantity integer (int32) 否 该订单行的数量
volume number 否 该订单行的总体积(单位:立方米)
weight number 否 该订单行的总重量(单位:千克)
unitType string 否 该订单行的数量单位,包括如下常量:
1 - 托盘
2 - 箱
3 - 袋
4 - 件
cargoCategory string 否 产品类别
customFields CustomFieldsInfo 否 自定义字段。这适用于启用并且正确配置了自定义字段的公司。
remark string 否 备注

OrderLineRejections

字段名 类型 是否必填 描述 示例
orderRejections array[OrderLineConfirmedRejection] 否 拒收列表,按时间排序

OrderLines

字段名 类型 是否必填 描述 示例
orderLine array[OrderLineInfo] 否 货物/产品明细列表

OrderLocationInfo

字段名 类型 是否必填 描述 示例
name string 否 该收/发货点的公司名
externalId string 否 该收/发货点的外部代码。该字段可以在oTMS的基础数据模块中维护
province string 否 省份名
town string 否 城市名
county string 否 区/县名
address string 否 该收/发货点的地址
customFields CustomFieldsInfo 否 自定义字段。这适用于启用并且正确配置了自定义字段的公司。
contactName string 否 联系人的姓名
contactMobile string 否 联系人的手机
contactPhone string 否 联系人的电话
contactEmail string 否 联系人的邮箱
longitude number (double) 否 经度
latitude number (double) 否 纬度
loading boolean 否 发货点中的装货标志,收货点中的卸货标志
supportXtt boolean 否 外部订单追踪支持的标志
deliveryCode boolean 否 是否启用收货码
sendEpodSms boolean 否 发送EPOD信息
orderEpodUploadType string 否 回单类型,包括如下常量:
PAPERY_POD - 纸质电子回单
EPOD - 自动生成电子回单
ignoreDeliveryCode boolean 否 忽略收货码

OrderOutboundRequest

字段名 类型 是否必填 描述 示例
version string 否 请求的版本号
login string 否 用户名。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。
password string 否 密码。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。
queries Queries 否 用以筛选订单的查询条件
orderBy OrderBy 否 查询结果的排序方式 (不能以orderStatus属性排序)
start integer (int32) 否 返回订单的起始索引,最小为1。默认值是1。
count integer (int32) 否 返回的最大订单数量。默认值是100。
includeOrderInfo boolean 否 订单的收发货方,订单行,自定义字段等信息是否应包含在返回中。默认值是false。
includeOrderPosition boolean 否 是否返回订单位置信息,默认值是false
existDiscrepancy boolean 否 筛选出有注册过货损货差的订单。默认值是false。
includeLocationHistory boolean 否 返回的值是否包含车辆的历史报点。默认值是false。
includePortableDevice boolean 否 返回的值是否包含绑定的便携式设备。默认值是false。
includeLocationEvent boolean 否 返回的值是否包含订单事件的报点。默认值是false。
includeRejection boolean 否 返回的值是否包含货物拒收信息。默认值是false。
includeDiscrepancny boolean 否 返回的值是否包含货物破损信息。默认值是false。
includeTruckAndDriver boolean 否 返回的值是否包含车辆及司机信息。默认值是false。
includeMilestoneEvent boolean 否 返回的值是否包含订单的主要事件。默认值是false。
includeExceptionEvent boolean 否 返回的值是否包含订单的异常事件。默认值是false。
includeCompensation boolean 否 返回的值是否包含订单的赔偿信息。默认值是false。
includePickupDeliveryPoint boolean 否 返回的值是否包定的的提、送货点。默认值是false。
includeClient boolean 否 返回的值是否包含订单的客户信息。默认值是false。
includeVendor boolean 否 返回的值是否包含订单的承运方信息。默认值是false。
includeOrderLine boolean 否 返回的值是否包含订单明细。默认值是false。
pointsIntervalSecond integer (int64) 否 返回历史轨迹的点的最小时间间隔(秒)。默认值是600
includeOrderBasicInfo boolean 否 返回的值是否包含绑定的便携式设备。默认值是false。
includeOrderDelayReason boolean 否 订单的延迟原因是否应包含在返回中。默认值是false。
includeOrderLineRemark boolean 否 返回的值是否包含订单明细备注信息。默认值是false。
includeDiscrepancnyFiles boolean 否 返回的值是否包含货物破损图片信息。默认值是false。
includeEpodFiles boolean 否 返回的值是否包含回单图片信息。默认值是false。
includeTransportMode boolean 否 返回的值是否包含货运信息。默认值是false。生效前提:includeOrderInfo=true
includeTransportExtension boolean 否 返回的值是否包含附属货运信息,公里,柜型等。默认值是false。生效前提:includeOrderInfo=true

OrderOutboundResponse

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

OrderQuery

字段名 类型 是否必填 描述 示例
attribute string 是 查询条件的属性名。可以取下列值:
client - 客户在oTMS中的公司代码
vendor - 承运商在oTMS中的公司代码
orderNumber - oTMS订单号
erpNumber - ERP单号
mergedOrderNumber - 合并后的oTMS订单号
pickupSla - 订单要求的提货日期
deliverySla - 订单要求的送货日期
createTime - 订单创建的时间
updateTime - 订单最新更新的时间
allocateTime - 订单分配的时间
pickup - 订单实际提货时间
delivery - 订单实际送货时间
orderStatus - 订单状态;
billAcceptedAt - 账单结账时间
customText{#} - 序号{#}替换为数字1到30,分别代替自定义字段customText1到customText80
customEnum{#} - 序号{#}替换为数字1到10,分别代替自定义字段customEnum1到customEnum10
customNum{#} - 序号{#}替换为数字1到10,分别代替自定义字段customNum1到customNum10
日期类型的属性可接受格式为 yyyy-MM-dd的值
orderLineProductCode - 产品代码
orderLineCustomText{#} - 序号{#}替换为数字1到30,分别代替订单行自定义字段customText1到customText80
orderLineCustomEnum{#} - 序号{#}替换为数字1到10,分别代替订单行自定义字段customEnum1到customEnum10
orderLineCustomNum{#} - 序号{#}替换为数字1到10,分别代替订单行自定义字段customNum1到customNum10
订单状态和MILESTONE对应关系如下(closed状态与MILESTONE无关)
SR:
new - MILESTONE_1
released - MILESTONE_2
vendorReleased - MILESTONE_2_1
dispatched - MILESTONE_1_1, MILESTONE_3, MILESTONE_3_1
picked - MILESTONE_4
delivered - MILESTONE_5, MILESTONE_6, MILESTONE_6_1, MILESTONE_7, MILESTONE_7_1
clientBilled - MILESTONE_8
vendorBilled - MILESTONE_8_1
SP:
new - MILESTONE_1
released - MILESTONE_2
vendorReleased - MILESTONE_2_1
vendorDispatched - MILESTONE_3_1
dispatched - MILESTONE_1_1, MILESTONE_3
picked - MILESTONE_4
delivered - MILESTONE_5, MILESTONE_6, MILESTONE_6_1, MILESTONE_7, MILESTONE_7_1
clientBilled - MILESTONE_8
vendorBilled - MILESTONE_8_1
eq string 否 -
ge string 否 属性值大于或等于该值
le string 否 属性值小于或等于该值
in In 否 属性值包含于该列表中。不支持日期/时间类型的属性
lk string 否 属性值模糊匹配该值

OrderTransportMode

字段名 类型 是否必填 描述 示例
transportType string 否 货物运输类型,包括如下常量:
FTL - 整车
LTL - 零担
AIR - 空运
EXPRESS - 快递
RAIL - 铁路
WATER - 水运
truckType string 否 必需的卡车类型,包括如下常量:
0 - 敞篷车
1 - 厢式车
2 - 任意
3 - 轿运车
4 - 油罐车
5 - 飞翼车
6 - 高栏车
7 - 平板车
8 - 罐车
9 - 冷藏车
transportRemarks string 否 运输模式的备注
loadingMeter integer (int32) 否 卡车的装载米数
truckLength number 否 车长。如果存在,必须从已经定义好的值中选择,按公司分别设置。oTMS定义了全局支持的车长,如果车长不能被oTMS匹配到,会返回错误代码1006。
truckCbmCapacity number 否 卡车装载 (立方米) 。如果存在,必须从已经定义好的值中选择,按车长对应装载 (立方米) 。oTMS定义了全局支持的车长和对应的装载 (吨/立方米) ,如果装载 (立方米) 不能被 oTMS 匹配到,会返回错误代码1006。
truckMtCapacity number 否 卡车装载 (吨) 。如果存在,必须从已经定义好的值中选择,按车长对应装载 (吨) 。oTMS定义了全局支持的车长和对应的装载 (吨/立方米) ,如果装载 (吨) 不能被oTMS匹配到,会返回错误代码1007。
containerType string 否 箱型
containerSize number 否 箱型尺寸

Orders

字段名 类型 是否必填 描述 示例
order array[OrderDetail] 否 订单信息

OutboundOrderPosition

字段名 类型 是否必填 描述 示例
truckPlate string 否 车牌号
lng number (double) 否 经度
lat number (double) 否 纬度
address string 否 地址

PartnerDetail

字段名 类型 是否必填 描述 示例
partnerCode string 否 合作伙伴在oTMS中的公司代码
partnerName string 否 合作伙伴的公司名称
partnerHeadOfficeCode string 否 合作伙伴的总公司代码
orderNumber string 否 oTMS订单号
erpNumber string 否 ERP单号
price number 否 与该合作伙伴之间的订单价格
unitRate number 否 与该合作伙伴之间的单位价格
priceDetails PriceDetails 否 价格明细
consolidationId string 否 合并订单Id
rateAdjustments RateAdjustments 否 特殊费用/赔偿列表
discussions Discussions 否 讨论列表
billAccepted boolean 否 与该合作伙伴的账单是否已接受
billName string 否 账单名称
billCreatorFirstName string 否 账单创建者名
billCreatorFamilyName string 否 账单创建者姓
consolidated boolean 否 表示该订单是否是整合计费
finalRate number 否 最终费用
vat number (float) 否 税率
billAcceptedAt string (date-time) 否 账单被合作伙伴接受时间
vatRegisterNo string 否 公司税号

PortableDevice

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

PriceDetail

字段名 类型 是否必填 描述 示例
name string 否 价格明细的名称
rate number 否 该条明细的价格
description string 否 价格明细的描述

PriceDetails

字段名 类型 是否必填 描述 示例
priceDetail array[PriceDetail] 否 价格明细

QName

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

Queries

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

RateAdjustment

字段名 类型 是否必填 描述 示例
rate number 否 价格调整的数额
adjustmentReason string 否 手动调整的原因
time string (date-time) 否 该条特殊费用/赔偿记录的时间
remark string 否 特殊费用/赔偿的备注
adjustmentType integer (int32) 否 账单费用调整类型,包括如下常量:
1 - 赔偿
2 - 特殊费用
3 - 手动调整
categoryCode string 否 特殊费用/赔偿的自定义类别

RateAdjustments

字段名 类型 是否必填 描述 示例
rateAdjustment array[RateAdjustment] 否 特殊费用/赔偿列表

TemperatureMonitorDevice

字段名 类型 是否必填 描述 示例
temperatureMonitorDevice string 否 订单的温控设备

TruckLocationHistory

字段名 类型 是否必填 描述 示例
locationDateTime string (date-time) 否 报点时间
truck string 否 车牌号
driver string 否 司机姓名
mobile string 否 司机手机号
longitude number (double) 否 经度
latitude number (double) 否 纬度
temps array[number] 否 -

报文示例

请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderOutboundRequest version="0.2" login="username" password="password">
    <queries>
        <query>
            <attribute>orderStatus</attribute>
            <eq>delivered</eq>
        </query>
        <query>
            <attribute>pickupSla</attribute>
            <ge>2017-1-1</ge>
            <le>2018-7-31</le>
        </query>
        <query>
            <attribute>customText1</attribute>
            <eq>STANDSP</eq>
        </query>
        <query>
            <attribute>customText14</attribute>
            <eq>2600158714</eq>
        </query>
    </queries>
    <includeOrderInfo>true</includeOrderInfo>
    <includeOrderPosition>true</includeOrderPosition>
    <includeLocationHistory>true</includeLocationHistory>
    <includePortableDevice>true</includePortableDevice>
    <includeLocationEvent>true</includeLocationEvent>
    <includeRejection>true</includeRejection>
    <includeDiscrepancny>true</includeDiscrepancny>
    <includeTruckAndDriver>true</includeTruckAndDriver>
    <includeMilestoneEvent>true</includeMilestoneEvent>
    <includeExceptionEvent>true</includeExceptionEvent>
    <includeCompensation>true</includeCompensation>
    <includePickupDeliveryPoint>true</includePickupDeliveryPoint>
    <includeClient>true</includeClient>
    <includeVendor>true</includeVendor>
    <includeOrderLine>true</includeOrderLine>
    <orderBy>
        <desc>pickupSla</desc>
    </orderBy>
    <start>1</start>
    <count>10</count>
</orderOutboundRequest>

响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderOutboundResponse>
    <orders>
        <order>
            <vendorDetail>
                <partnerCode>STANDSP</partnerCode>
                <partnerName>StandardSPOtmsCompany</partnerName>
                <partnerHeadOfficeCode>sp</partnerHeadOfficeCode>
                <orderNumber>STANDSR450640</orderNumber>
                <erpNumber>cyn2017091901_1;2600158714;</erpNumber>
                <price>0.50</price>
                <priceDetails>
                    <priceDetail>
                        <name>base</name>
                        <rate>0.50</rate>
                    </priceDetail>
                </priceDetails>
                <consolidationId></consolidationId>
                <rateAdjustments/>
                <billAccepted>false</billAccepted>
                <vat>0.0</vat>
                <vatRegisterNo> </vatRegisterNo>
            </vendorDetail>
            <orderInfo>
                <location>童车_苏州昆山</location>
                <shipFrom>
                    <name>haohaizi_pingxiang</name>
                    <externalId>haohaizi_pingxiang</externalId>
                    <province>河北省</province>
                    <town>邢台市</town>
                    <county>平乡县</county>
                    <address>邢台县</address>
                    <customFields/>
                    <contactName>c</contactName>
                    <contactMobile>19999999999</contactMobile>
                    <longitude>114.16774440241458</longitude>
                    <latitude>37.15242169927538</latitude>
                </shipFrom>
                <shipTo>
                    <name>haohaizi_kunshan</name>
                    <externalId>haohaizi_kunshan</externalId>
                    <province>江苏省</province>
                    <town>苏州市</town>
                    <county>昆山市</county>
                    <address>昆山市</address>
                    <customFields/>
                    <contactName>c</contactName>
                    <contactMobile>19999999999</contactMobile>
                    <longitude>120.96580778410554</longitude>
                    <latitude>31.32893679549736</latitude>
                </shipTo>
                <totalWeight>42.000</totalWeight>
                <totalVolume>50.000000</totalVolume>
                <totalQuantity>6</totalQuantity>
                <totalInsurance>0.00</totalInsurance>
                <customFields>
                    <customText1>STANDSP</customText1>
                    <customText4>P</customText4>
                    <customText7>零担</customText7>
                    <customText8>2017-06-19 17:00</customText8>
                    <customText9>昆山市</customText9>
                    <customText10>cyn2017091901_1</customText10>
                    <customText12>童车</customText12>
                    <customText13>1</customText13>
                    <customText14>2600158714</customText14>
                    <customText15>ZH004678</customText15>
                    <customText17>1</customText17>
                    <customText18>Ware</customText18>
                </customFields>
                <dockAppointment>
                    <expectedArrivalTime>2017-06-22T23:59:59.000</expectedArrivalTime>
                    <driverName>测试</driverName>
                    <truckPlate>沪B63214</truckPlate>
                    <driverMobile>13524707589</driverMobile>
                </dockAppointment>
                <positions/>
                <cargoType>1</cargoType>
                <locationHistories>
                    <locationHistory>
                        <locationDateTime>2017-09-19T15:28:28.000</locationDateTime>
                        <longitude>121.52840424</longitude>
                        <latitude>31.21907043</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2017-09-19T15:29:28.000</locationDateTime>
                        <longitude>121.52840424</longitude>
                        <latitude>31.21907043</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2017-09-19T15:29:28.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2017-09-19T15:29:58.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2017-09-19T15:30:28.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2017-09-19T15:30:58.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2017-09-19T15:31:28.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2017-09-19T15:31:58.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2017-09-19T15:32:27.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2017-09-19T16:06:01.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2017-09-19T16:06:01.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                    <locationHistory>
                        <locationDateTime>2017-09-19T16:06:44.000</locationDateTime>
                        <longitude>121.52837372</longitude>
                        <latitude>31.21906662</latitude>
                    </locationHistory>
                </locationHistories>
            </orderInfo>
            <pickupSla>2017-06-19T23:59:59.000</pickupSla>
            <deliverySla>2017-06-22T23:59:59.000</deliverySla>
            <orderStatus>delivered</orderStatus>
            <orderEvents>
                <event>
                    <name>new</name>
                    <time>2017-09-19T15:16:12.000</time>
                </event>
                <event>
                    <name>released</name>
                    <time>2017-09-19T15:16:12.000</time>
                </event>
                <event>
                    <name>dispatched</name>
                    <time>2017-09-19T15:16:12.000</time>
                </event>
                <event>
                    <name>vendor released</name>
                    <time>2017-09-19T15:20:22.000</time>
                </event>
                <event>
                    <name>vendor dispatched</name>
                    <time>2017-09-19T15:21:58.000</time>
                </event>
                <event>
                    <name>picked</name>
                    <time>2017-09-19T15:25:41.000</time>
                </event>
                <event>
                    <time>2017-09-19T15:30:58.000</time>
                    <operationTime>2017-09-19T16:06:05.000</operationTime>
                </event>
                <event>
                    <name>delivered</name>
                    <time>2017-09-19T16:06:54.000</time>
                    <latitude>31.2230219165261</latitude>
                    <longitude>121.53920836083034</longitude>
                </event>
                <event>
                    <time>2017-09-19T16:07:14.000</time>
                    <operationTime>2017-09-19T16:11:11.000</operationTime>
                </event>
                <event>
                    <name>epod</name>
                    <time>2017-09-19T16:07:40.000</time>
                </event>
            </orderEvents>
            <assignedDrivers>
                <pickup>
                    <assignedDriver>
                        <driverName>测试</driverName>
                        <mobile>13524707589</mobile>
                        <truckPlate>沪B63214</truckPlate>
                    </assignedDriver>
                </pickup>
                <delivery>
                    <assignedDriver>
                        <driverName>测试</driverName>
                        <mobile>13524707589</mobile>
                        <truckPlate>沪B63214</truckPlate>
                    </assignedDriver>
                </delivery>
            </assignedDrivers>
        </order>
    </orders>
    <start>1</start>
    <count>1</count>
    <total>1</total>
</orderOutboundResponse>

API工具