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/ws/orderUpdate

订单更新#

通过订单更新接口，可以将不同外部系统如ERP系统、WMS系统的大量订单进行批量的更新。单次更新最大订单数为100。
版本号文档说明
0.1当前版本文档

配置说明#

oTMS同时在生产环境和测试环境中提供Web Service接口，其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多3个请求（如需增加可选购增值服务）

接口说明#

公共参数#

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

请求参数#

字段名位置是否必填描述Schema
bodybody是订单更新请求OrderUpdateRequest
Authorizationheader否Basic Authorization。如果不为空，则优先使用该值作身份认证。否则使用请求报文中的用户名与密码string

错误码解释#

全局反馈代码#

反馈代码说明
0客户验证失败。
1不支持的请求版本。
2请求中的更新订单过多。

单个请求反馈代码#

反馈代码说明
7000客户代码未找到。
7001无效的数据类型。
7002分公司未识别，或用户权限不匹配。
7003订单匹配结果不唯一。
7004用户地区权限不匹配。
7005试图更新的订单不是由导入接口导入。更新被拒绝。
7006订单不属于该公司。
7007不允许更新拆量订单的数量、重量、体积以及投保价值。
7008已入账单的订单不允许更新。
7009订单不存在。
7010存在货差的订单不允许更新。
7011地区不存在。
7012提货时间数据无效。
7013送货时间数据无效。
7014shipFromExternalId发货方外部代码未找到。
7015shipToExternalId收货方外部代码未找到。
7016发货方订阅外部订单追踪，必须提供邮箱或手机号码。
7017收货方订阅外部订单追踪，必须提供邮箱或手机号码。
7018发货方外部代码重复。
7019收货方外部代码重复。
7020取货地址和送货地址相同。
7021运输信息不完整（1.缺少运输模式，2.零担/整车运输模式时缺少卡车类型，3.整车运输模式时缺少车长）。
7022truckType车辆类型不匹配。
7023truckType车辆类型匹配结果不唯一。
7024产品类别无效。
7025缺少货物/产品信息。订单明细中至少需提供externalId或cargoDescription之一。
7026externalId货物(产品)外部代码未找到。
7027货物(产品)外部代码重复。
7028温度报警的低温阈值不得超过高温阈值。
7029订单的货物类型不支持温度报警。
7030订单的包装类型不需要温控箱。
7031收货方oTMS邮政编码只与乡镇匹配。
7032收货方邮政编码只与6位邮政编码匹配。
7033收货方oTMS邮政编码不匹配。
7034收货方oTMS邮政编码与6位和乡镇匹配。
7035收货方oTMS邮政编码只与区县匹配。
7036发货方oTMS邮政编码匹配到乡镇。
7037发货方oTMS邮政编码只与6位邮政编码匹配。
7038发货方oTMS邮政编码不匹配。
7039发货方oTMS邮政编码与6位和乡镇的都匹配。
7040发货方oTMS邮政编码只与区县匹配。
7041订单的重量或体积超过公司限定。
7042无效的温控箱编号。
7043自定义字段不能识别——可能公司已经取消了自定义字段。订单不能更新。
7044未定义的自定义字段枚举值。订单不能更新。
7045未启用自定义字段，将忽略更新订单中的自定义字段。
7046订单缺少必填的自定义字段。订单不能更新。
7047拒绝草稿状态订单。rejectDraft为true时，不完整订单将被拒绝而非进入草稿箱。
7048订单明细缺少必填的自定义字段。订单不能更新。
7049无效的订单类型。
7050订单的货物信息不完整。
7051承运商账户通过erpNumber更新订单时必须提供clientCode。
7052订单价格文件不匹配。
7053订单信息不完整。
7054订单优化进行中，更新被拒绝。
7100其他错误。

请求参数

Body 参数application/xml

示例
<?xml version="1.0" encoding="UTF-8"?>
<orderUpdateRequest version="0.1" login="login" password="password">
    <orders>
        <order sequence="1">
            <branch></branch>
            <columnName></columnName>
            <orderNumber>AXDHBMAV009887</orderNumber>
            <allowUpdate>true</allowUpdate>
            <cargoDetails>
                <totalWeight>900</totalWeight>
                <totalVolume>3</totalVolume>
                <cargoType>1</cargoType>
            </cargoDetails>            
            <orderLines>
                <orderLine>
                    <cargoDescription>
                        <productCode>1211</productCode>
                        <productName>wenju</productName>
                        <unitType>2</unitType>
                    </cargoDescription>
                    <customFields>
                        <customText5></customText5>
                        <customText38>12.00</customText38>
                        <customText46>LC00151</customText46>
                        <customText50>2022-10-25</customText50>
                        <customText55>Y151-1802</customText55>
                    </customFields>
                    <quantity>50</quantity>
                    <weight>900</weight>
                    <volume>3</volume>
                    <remarks></remarks>
                </orderLine>
            </orderLines>
        </order>
    </orders>
</orderUpdateRequest>

返回响应

🟢200成功
application/xml
successful operation
Body

示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderUpdateResponse version="0.1">
    <responseCode></responseCode>
    <processedOrders>1</processedOrders>
    <orders>
        <order sequence="1">
            <erpNumber>241108001</erpNumber>
            <orderNumber>AXDHBMAV009887</orderNumber>
            <updateStatus>UPDATED</updateStatus>
            <responseCodes/>
        </order>
    </orders>
</orderUpdateResponse>
上一页
h5链接
下一页
订单费用更新
Built with