oTMS logo 开放平台
Documentation Help

订单分配

通过订单分配接口,可以将订单从上游分配给指定的下游承运商。

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

配置说明

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

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

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

接口说明

公共参数

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

请求参数

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

响应参数

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

详细描述

OrderDispatch

字段名 类型 是否必填 描述 示例
sequence integer (int32) 序列数
erpNumber string 外部系统号
orderNumber string oTMS订单号
vendorCode string 承运商公司代码
cost number 成本

OrderDispatchRequest

字段名 类型 是否必填 描述 示例
version string 请求的版本号
login string 用户名。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。
password string 密码。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。
orders array[OrderDispatch] -

OrderDispatchResponse

字段名 类型 是否必填 描述 示例
version string 响应版本号
responseCode string 全局的反馈代码
orders array[OrderDispatchResult] -

OrderDispatchResult

字段名 类型 是否必填 描述 示例
sequence integer (int32) 序列数
erpNumber string 外部系统号
orderNumber string oTMS订单号
status string 响应状态
code string 响应码
msg string 响应信息

报文示例

请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderDispatchRequest version="0.1" login="username" password="password">
    <orders>
        <order sequence="1">
            <erpNumber>erp000001</erpNumber>
            <orderNumber>SH00105000001</orderNumber>
            <vendorCode>SH00106</vendorCode>
            <cost>10</cost>
        </order>
        <order sequence="2">
            <erpNumber>erp000002</erpNumber>
            <orderNumber>SH00105000002</orderNumber>
            <vendorCode>SH00106</vendorCode>
        </order>
    </orders>
</orderDispatchRequest>

响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderDispatchResponse version="0.1">
    <responseCode/>
    <orders>
        <order sequence="1">
            <erpNumber>erp000001</erpNumber>
            <orderNumber>SH00105000001</orderNumber>
            <status>SUCCEED</status>
            <code>100</code>
            <msg>Success</msg>
        </order>
        <order sequence="2">
            <erpNumber>erp000002</erpNumber>
            <orderNumber>SH00105000002</orderNumber>
            <status>FAILED</status>
            <code>103</code>
            <msg>Order not found</msg>
        </order>
    </orders>
</orderDispatchResponse>

API工具