承运商导出
通过承运商导出接口，客户系统接入 oTMS 系统，查询 承运商信息。
| 版本号 | 文档 | 说明 |
|---|---|---|
| 0.1 | 当前版本文档 |
oTMS同时在生产环境和测试环境中提供Web Service接口，其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
目前对该接口的调用限制为每个公司每秒最多10个请求
公共参数
| 环境 | 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 |
|---|---|---|---|---|
| Authorization | header | Basic Authorization。如果不为空，则优先使用该值作身份认证。否则使用请求报文中的用户名与密码 | string | |
| body | body | 是 | 承运商查询请求。 | VendorOutboundWebService |
响应参数
| 状态码 | 描述 | 响应模型 |
|---|---|---|
| 200 | successful operation | VendorOutboundResponse |
ContactPerson
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| name | string | 否 | 联系人名字 | |
| phone | string | 否 | 联系人电话 | |
| mobile | string | 否 | 联系人手机 | |
| 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>