oTMS logo 开放平台
Documentation Help

承运商导出

通过承运商导出接口,客户系统接入 oTMS 系统,查询 承运商信息。

配置说明

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

接口说明

公共参数

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

请求参数

字段名 位置 是否必填 描述 Schema
body body 承运商查询请求。 VendorOutboundWebService

响应参数

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

详细描述

ContactPerson

字段名 类型 是否必填 描述 示例
name string 联系人名字
phone string 联系人电话
mobile string 联系人手机
email string 联系人邮箱

VendorOutbound

字段名 类型 是否必填 描述 示例
name string 公司名称
code string 公司代码
registeredAt string (date-time) 公司注册时间
contactPerson ContactPerson 公司联系人
transportTypes array[string] 承运商可承运的运输类型,包括如下常量:
FTL - 整车
LTL - 零担
AIR - 空运
EXPRESS - 快递
RAIL - 铁路
cargoTypes array[string] 承运商可承运的货物类型,包括如下常量:
1 - 普通货物
2 - 温控货物
3 - 危险品
4 - 危险品和温控货物

VendorOutboundResponse

字段名 类型 是否必填 描述 示例
vendors array[VendorOutbound] 承运商信息

VendorOutboundWebService

字段名 类型 是否必填 描述 示例

报文示例

请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vendorOutboundRequest version="0.1" login="username" password="password"/>

响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vendorOutboundResponse>
    <vendors>
        <vendor>
            <name>上海XX物流有限公司</name>
            <code>SH00104</code>
            <registeredAt>2016-08-03</registeredAt>
            <contactPerson>
                <name>王 xx</name>
                <phone>010-000000</phone>
                <email>XXX.XX@otms.cn</email>
            </contactPerson>
            <transportTypes>
                <transportTypes>LTL</transportTypes>
                <transportTypes>FTL</transportTypes>
            </transportTypes>
            <cargoTypes>
                <cargoType>1</cargoType>
            </cargoTypes>
        </vendor>
        <vendor>
            <name>大唐物流</name>
            <code>SH00404</code>
            <registeredAt>2016-08-03</registeredAt>
            <contactPerson>
                <name>唐 太宗</name>
                <phone>0138-11111111</phone>
                <email>xxxxx@163.com</email>
            </contactPerson>
            <transportTypes/>
            <cargoTypes/>
        </vendor>
    </vendors>
</vendorOutboundResponse>

API工具