收货方/发货方导出

通过收货方/发货方导出，客户系统接入 oTMS 系统，查询 oTMS 收发货方信息和状态。

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

配置说明

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

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

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

接口说明

公共参数

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

请求参数

字段名	位置	是否必填	描述	Schema
Authorization	header		Basic Authorization。如果不为空，则优先使用该值作身份认证。否则使用请求报文中的用户名与密码	string
body	body	是	收发货方查询请求。包含用以筛选收发货方的查询条件	ShipPointOutboundRequest

响应参数

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

详细描述

CustomFieldsInfo

字段名	类型	是否必填	描述
customText1	string	否	自定义文本字段1
customText2	string	否	自定义文本字段2
customText3	string	否	自定义文本字段3
customText4	string	否	自定义文本字段4
customText5	string	否	自定义文本字段5
customText6	string	否	自定义文本字段6
customText7	string	否	自定义文本字段7
customText8	string	否	自定义文本字段8
customText9	string	否	自定义文本字段9
customText10	string	否	自定义文本字段10
customText11	string	否	自定义文本字段11
customText12	string	否	自定义文本字段12
customText13	string	否	自定义文本字段13
customText14	string	否	自定义文本字段14
customText15	string	否	自定义文本字段15
customText16	string	否	自定义文本字段16
customText17	string	否	自定义文本字段17
customText18	string	否	自定义文本字段18
customText19	string	否	自定义文本字段19
customText20	string	否	自定义文本字段20
customText21	string	否	自定义文本字段21
customText22	string	否	自定义文本字段22
customText23	string	否	自定义文本字段23
customText24	string	否	自定义文本字段24
customText25	string	否	自定义文本字段25
customText26	string	否	自定义文本字段26
customText27	string	否	自定义文本字段27
customText28	string	否	自定义文本字段28
customText29	string	否	自定义文本字段29
customText30	string	否	自定义文本字段30
customText31	string	否	自定义文本字段31
customText32	string	否	自定义文本字段32
customText33	string	否	自定义文本字段33
customText34	string	否	自定义文本字段34
customText35	string	否	自定义文本字段35
customText36	string	否	自定义文本字段36
customText37	string	否	自定义文本字段37
customText38	string	否	自定义文本字段38
customText39	string	否	自定义文本字段39
customText40	string	否	自定义文本字段40
customText41	string	否	自定义文本字段41
customText42	string	否	自定义文本字段42
customText43	string	否	自定义文本字段43
customText44	string	否	自定义文本字段44
customText45	string	否	自定义文本字段45
customText46	string	否	自定义文本字段46
customText47	string	否	自定义文本字段47
customText48	string	否	自定义文本字段48
customText49	string	否	自定义文本字段49
customText50	string	否	自定义文本字段50
customText51	string	否	自定义文本字段51
customText52	string	否	自定义文本字段52
customText53	string	否	自定义文本字段53
customText54	string	否	自定义文本字段54
customText55	string	否	自定义文本字段55
customText56	string	否	自定义文本字段56
customText57	string	否	自定义文本字段57
customText58	string	否	自定义文本字段58
customText59	string	否	自定义文本字段59
customText60	string	否	自定义文本字段60
customText61	string	否	自定义文本字段61
customText62	string	否	自定义文本字段62
customText63	string	否	自定义文本字段63
customText64	string	否	自定义文本字段64
customText65	string	否	自定义文本字段65
customText66	string	否	自定义文本字段66
customText67	string	否	自定义文本字段67
customText68	string	否	自定义文本字段68
customText69	string	否	自定义文本字段69
customText70	string	否	自定义文本字段70
customText71	string	否	自定义文本字段71
customText72	string	否	自定义文本字段72
customText73	string	否	自定义文本字段73
customText74	string	否	自定义文本字段74
customText75	string	否	自定义文本字段75
customText76	string	否	自定义文本字段76
customText77	string	否	自定义文本字段77
customText78	string	否	自定义文本字段78
customText79	string	否	自定义文本字段79
customText80	string	否	自定义文本字段80
customNum1	number	否	自定义小数字段1 -- 精确到18位数、6位小数
customNum2	number	否	自定义小数字段2 -- 精确到18位数、6位小数
customNum3	number	否	自定义小数字段3 -- 精确到18位数、6位小数
customNum4	number	否	自定义小数字段4 -- 精确到18位数、6位小数
customNum5	number	否	自定义小数字段5 -- 精确到18位数、6位小数
customNum6	number	否	自定义小数字段6 -- 精确到18位数、6位小数
customNum7	number	否	自定义小数字段7 -- 精确到18位数、6位小数
customNum8	number	否	自定义小数字段8 -- 精确到18位数、6位小数
customNum9	number	否	自定义小数字段9 -- 精确到18位数、6位小数
customNum10	number	否	自定义小数字段10 -- 精确到18位数、6位小数
customEnum1	string	否	自定义字段中定义并激活的枚举变量1的逻辑名
customEnum2	string	否	自定义字段中定义并激活的枚举变量2的逻辑名
customEnum3	string	否	自定义字段中定义并激活的枚举变量3的逻辑名
customEnum4	string	否	自定义字段中定义并激活的枚举变量4的逻辑名
customEnum5	string	否	自定义字段中定义并激活的枚举变量5的逻辑名
customEnum6	string	否	自定义字段中定义并激活的枚举变量6的逻辑名
customEnum7	string	否	自定义字段中定义并激活的枚举变量7的逻辑名
customEnum8	string	否	自定义字段中定义并激活的枚举变量8的逻辑名
customEnum9	string	否	自定义字段中定义并激活的枚举变量9的逻辑名
customEnum10	string	否	自定义字段中定义并激活的枚举变量10的逻辑名
customEnum1Zh	string	否	自定义字段中定义并激活的枚举变量1的中文名
customEnum2Zh	string	否	自定义字段中定义并激活的枚举变量2的中文名
customEnum3Zh	string	否	自定义字段中定义并激活的枚举变量3的中文名
customEnum4Zh	string	否	自定义字段中定义并激活的枚举变量4的中文名
customEnum5Zh	string	否	自定义字段中定义并激活的枚举变量5的中文名
customEnum6Zh	string	否	自定义字段中定义并激活的枚举变量6的中文名
customEnum7Zh	string	否	自定义字段中定义并激活的枚举变量7的中文名
customEnum8Zh	string	否	自定义字段中定义并激活的枚举变量8的中文名
customEnum9Zh	string	否	自定义字段中定义并激活的枚举变量9的中文名
customEnum10Zh	string	否	自定义字段中定义并激活的枚举变量10的中文名
customEnum1En	string	否	自定义字段中定义并激活的枚举变量1的英文名
customEnum2En	string	否	自定义字段中定义并激活的枚举变量2的英文名
customEnum3En	string	否	自定义字段中定义并激活的枚举变量3的英文名
customEnum4En	string	否	自定义字段中定义并激活的枚举变量4的英文名
customEnum5En	string	否	自定义字段中定义并激活的枚举变量5的英文名
customEnum6En	string	否	自定义字段中定义并激活的枚举变量6的英文名
customEnum7En	string	否	自定义字段中定义并激活的枚举变量7的英文名
customEnum8En	string	否	自定义字段中定义并激活的枚举变量8的英文名
customEnum9En	string	否	自定义字段中定义并激活的枚举变量9的英文名
customEnum10En	string	否	自定义字段中定义并激活的枚举变量10的英文名

In

字段名	类型	是否必填	描述	示例
value	array[string]	是	属性值

Queries

字段名	类型	是否必填	描述	示例
query	array[ShipPointQuery]	否	查询条件。多个查询条件以逻辑‘与’的方式连接。

ShipPoint

字段名	类型	是否必填	描述
name	string	否	该收/发货点的公司名
externalId	string	否	该收/发货点的外部代码。该字段可以在oTMS的基础数据模块中维护
province	string	否	省份名
town	string	否	城市名
county	string	否	区/县名
address	string	否	该收/发货点的地址
zipcode	string	否	邮编
contactName	string	否	联系人的姓名
contactMobile	string	否	联系人的手机
contactPhone	string	否	联系人的电话
contactEmail	string	否	联系人的邮箱
longitude	number (double)	否	经度
latitude	number (double)	否	纬度
locationType	integer (int32)	否	发货方：0，收货方：1
customFields	CustomFieldsInfo	否	自定义字段。这适用于启用并且正确配置了自定义字段的公司。
id	integer (int64)	否	id
updatedOn	string (date-time)	否	更新时间。仅时间，中国标准时区。格式为 HH:mm:ss

ShipPointOutboundRequest

字段名	类型	是否必填	描述
version	string	否	请求的版本号
login	string	否	用户名。用于 API 调用者身份认证。如果请求头中的Authorization不为空，则该值会被忽略。
password	string	否	密码。用于 API 调用者身份认证。如果请求头中的Authorization不为空，则该值会被忽略。
queries	Queries	否	用以筛选收发货方的查询条件
start	integer (int32)	否	返回订单的起始索引，最小为1。默认值是1。
count	integer (int32)	否	返回的最大收发货点数量。默认值是100。

ShipPointOutboundResponse

字段名	类型	是否必填	描述
shipPoints	ShipPoints	否	返回基础数据收发货方列表
start	integer (int32)	否	返回收发货方的起始索引
count	integer (int32)	否	实际返回的收发货方数量
total	integer (int32)	否	该次查询中筛选出的所有收发货方的数量

ShipPointQuery

字段名	类型	是否必填	描述
attribute	string	是	查询条件的属性名。可以取下列值： externalId - 收发货方外部代码 locationType - 基础数据类型：收货方，发货方 startDate - 查询增量数据的开始时间 endDate - 查询增量数据的结束时间
eq	string	否	属性值等于该值
ge	string	否	属性值大于或等于该值
le	string	否	属性值小于或等于该值
lk	string	否	属性值模糊匹配该值。不支持日期/时间类型的属性
in	In	否	属性值包含于该列表中。不支持日期/时间类型的属性

ShipPoints

字段名	类型	是否必填	描述	示例
shipPoint	array[ShipPoint]	否	收发货方信息

报文示例

示例0

请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointOutboundRequest version="0.1" login="userName" password="password">
    <queries>
        <query>
            <attribute>updatedOn</attribute>
            <le>2018-01-01</le>
            <ge>2017-01-01</ge>
        </query>
        <query>
            <attribute>externalId</attribute>
            <in>
                <value>111</value>
                <value>222</value>
            </in>
        </query>
        <query>
            <attribute>locationType</attribute>
            <eq>0</eq>
        </query>
    </queries>
    <start>1</start>
    <count>10</count>
</shipPointOutboundRequest>

响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointOutboundResponse>
    <shipPoints>
        <shipPoint>
            <name>Calvin</name>
            <province>河南省</province>
            <address>西华县迟营乡街道</address>
            <contactName>Calvin</contactName>
            <contactMobile>18666666666</contactMobile>
            <contactPhone>null-null</contactPhone>
            <longitude>114.5351355707259</longitude>
            <latitude>33.75685452141119</latitude>
            <locationType>0</locationType>
        </shipPoint>
        <shipPoint>
            <name>Calvin</name>
            <province>上海市</province>
            <address>浦东新区峨山路91弄100号</address>
            <contactName>Calvin</contactName>
            <contactMobile>18666666666</contactMobile>
            <contactPhone>null-null</contactPhone>
            <longitude>121.53990544590607</longitude>
            <latitude>31.22166237986258</latitude>
            <locationType>0</locationType>
        </shipPoint>
    </shipPoints>
    <start>1</start>
    <count>10</count>
    <total>2</total>
</shipPointOutboundResponse>

错误码解释

全局反馈代码

反馈代码	说明
0	客户验证失败。
1	不支持的请求版本。
2	请求中的提送货点数据过多。

单个请求反馈代码

反馈代码	说明

收货方/发货方导出

通过收货方/发货方导出，客户系统接入 oTMS 系统，查询 oTMS 收发货方信息和状态。

配置说明

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

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

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

接口说明

公共参数

请求参数

响应参数

详细描述

报文示例

请求示例

响应示例

错误码解释

全局反馈代码

单个请求反馈代码

API工具