oTMS logo 开放平台
Documentation Help

订单更新

通过订单费用更新接口,可以将订单干线费用进行批量的更新。单次更新最大订单数为100。

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

配置说明

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

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

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

接口说明

公共参数

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

请求参数

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

响应参数

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

详细描述

OrderRevenueUpdateRequest

字段名 类型 是否必填 描述 示例
version string 请求的版本号。当前版本号为0.1
login string 用户名。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。
password string 密码。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。
orders array[UpdatedOrderRevenue] 待更新的订单列表。一次请求最多可以更新100条订单

OrderUpdateResponse

字段名 类型 是否必填 描述 示例
version string 响应版本号
responseCode string 全局的反馈代码
processedOrders string 处理的订单数量
orders array[UpdateResult] 处理的订单列表

UpdateResult

字段名 类型 是否必填 描述 示例
sequence integer (int32) 序列数
erpNumber string 订单erp单号
orderNumber string oTMS订单号
updateStatus string DRAFT - 订单更新后为草稿状态
UPDATED - 订单正常更新
FAILED - 订单更新失败
NOT UPDATED - 订单无更新
strResponseCodes array[string] -
strErrorMsgs array[string] -

UpdatedOrderRevenue

字段名 类型 是否必填 描述 示例
erpNumber string 外部系统的唯一的订单号
orderNumber string oTMS订单号。如果已提供erpNumber,oTMS订单号视为无效。
lineHaul string 基础费率,精确到12位,2位小数

报文示例

请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderRevenueUpdateRequest version="0.1" login="username" password="password">
    <orders>
        <order sequence="1">
            <erpNumber>ERP-2017101702</erpNumber>
            <lineHaul>11.11</lineHaul>
        </order>
    </orders>
</orderRevenueUpdateRequest>

响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderRevenueUpdateResponse version="0.1">
    <responseCode/>
    <processedOrders>1</processedOrders>
    <orders>
        <order sequence="1">
            <erpNumber>ERP-2017101702</erpNumber>
            <orderNumber>BESTSELL935000</orderNumber>
            <updateStatus>UPDATED</updateStatus>
        </order>
    </orders>
</orderRevenueUpdateResponse>

错误码解释

全局反馈代码

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

单个请求反馈代码

反馈代码 说明
7001无效的数据类型。
7008已入账单的订单不允许更新。
7009订单不存在。
7054订单优化进行中,更新被拒绝。
7055已整合的订单不允许更新。
7056已入运输单的订单不允许更新。
7100其他错误。

API工具