提送货点导入

通过提送货点导入接口，可以将不同外部系统如ERP系统、WMS系统的提送货点数据进行批量的导入或者更新。

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

配置说明

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

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

目前对该接口的调用限制为每个公司每秒最多3个请求（如需增加可选购增值服务）。

接口说明

公共参数

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

请求参数

字段名	位置	是否必填	描述	Schema
body	body	是	提送货点导入请求	ShipPointImportRequest

错误码解释

全局反馈代码

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

单个请求反馈代码

反馈代码	说明
1000	客户代码未找到。
1001	无效的数据类型。
1002	备用。
1009	发货方外部代码重复。
1010	收货方外部代码重复。
1013	发货方oTMS邮政编码匹配到乡镇。
1014	发货方oTMS邮政编码只与6位邮政编码匹配。
1015	发货方oTMS邮政编码不匹配。
1016	发货方oTMS邮政编码与6位和乡镇的都匹配。
1017	收货方oTMS邮政编码只与乡镇匹配。
1018	收货方邮政编码只与6位邮政编码匹配。
1019	收货方oTMS邮政编码不匹配。
1020	收货方oTMS邮政编码与6位和乡镇匹配。
1030	自定义字段不能识别；公司设置已关闭自定义字段，或自定义字段设置错误。
1040	地区不存在。
1043	分公司未识别，或用户权限不匹配。
1045	没有匹配的提送货点。
1046	集散点外部代码重复。
1050	不支持XTT——公司设置已关闭XTT选项。
1051	选择XTT支持但未提供Email地址。
1052	发货方oTMS邮政编码只与乡镇匹配。
1053	收货方oTMS邮政编码只与乡镇匹配。
1055	不支持短信通知——公司设置已关闭短信通知选项。
1056	选择短信通知但未提供手机号码。
1060	已禁用分公司——忽略分公司设置。
1100	其他错误。

请求参数

Header 参数

Body 参数application/xml

示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointImportRequest version="0.1" login="username" password="password">
    <shipPoints>
        <shipPoint sequence="1">
            <clientReferenceNumber>sh00105001</clientReferenceNumber>
            <type>0</type>
            <companyName>上海</companyName>
            <myLocation></myLocation>
            <selectType>1</selectType>
            <externalId>11223344</externalId>
            <province>上海</province>
            <town>上海</town>
            <county/>
            <address>上海浦东新区峨山路100号</address>
            <zipcode>200020</zipcode>
            <contact>
                <name>张先生</name>
                <phone>12345678</phone>
                <phoneAreaCode>021</phoneAreaCode>
                <mobile>13812345678</mobile>
                <email>123456@163.com</email>
            </contact>
            <loading>true</loading>
            <supportXtt>true</supportXtt>
            <supportSms>true</supportSms>
            <remark/>
            <customFields>
                <customText1>sh</customText1>
                <customNum1>100</customNum1>
            </customFields>
        </shipPoint>
        <shipPoint sequence="2">
            <clientReferenceNumber>sh00105002</clientReferenceNumber>
            <type>1</type>
            <companyName>杭州</companyName>
            <myLocation></myLocation>
            <selectType>1</selectType>
            <externalId>22334455</externalId>
            <province>浙江</province>
            <town>杭州</town>
            <county/>
            <address>浙江省杭州市西湖景区</address>
            <zipcode>311010</zipcode>
            <contact>
                <name>Johnny</name>
                <phone>87654321</phone>
                <phoneAreaCode>0571</phoneAreaCode>
                <mobile>13887654321</mobile>
                <email>654321@163.com</email>
            </contact>
            <loading>false</loading>
            <supportXtt>true</supportXtt>
            <supportSms>true</supportSms>
            <remark/>
            <customFields>
                <customText1>hz</customText1>
                <customNum1>50</customNum1>
            </customFields>
        </shipPoint>
    </shipPoints>
</shipPointImportRequest>

返回响应

🟢200成功

application/xml

successful operation

Body

示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointImportResponse version="0.1">
    <responseCode></responseCode>
    <processedShipPoints>2</processedShipPoints>
    <shipPoints>
        <shipPoint sequence="1">
            <clientReferenceNumber>sh00105001</clientReferenceNumber>
            <importStatus>ADDED</importStatus>
            <responseCodes>
                <responseCode>
                    <code>1014</code>
                </responseCode>
                <responseCode>
                    <code>1031</code>
                </responseCode>
            </responseCodes>
        </shipPoint>
        <shipPoint sequence="2">
            <clientReferenceNumber>sh00105002</clientReferenceNumber>
            <importStatus>ADDED</importStatus>
            <responseCodes>
                <responseCode>
                    <code>1018</code>
                </responseCode>
                <responseCode>
                    <code>1031</code>
                </responseCode>
            </responseCodes>
        </shipPoint>
    </shipPoints>
</shipPointImportResponse>

提送货点导入

提送货点导入#

配置说明#

接口说明#

公共参数#

请求参数#

错误码解释#

全局反馈代码#

单个请求反馈代码#

请求参数

返回响应

提送货点导入

配置说明

接口说明

公共参数

请求参数

错误码解释

全局反馈代码

单个请求反馈代码