提送货点删除
通过提送货点删除接口，可以将之前从外部系统导入的提送货点数据进行批量的删除
| 版本号 | 文档 | 说明 |
|---|---|---|
| 0.1 | 当前版本文档 |
oTMS同时在生产环境和测试环境中提供Web Service接口，其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
目前对该接口的调用限制为每个公司每秒最多10个请求
公共参数
| 环境 | HTTP请求方法 | HTTPS请求地址 | 请求主体MIME类型 | 响应主体MIME类型 |
|---|---|---|---|---|
| 正式环境 | DELETE | https://login.otms.cn/ws/shipPointImport | application/xml | application/xml |
| 沙箱环境 | DELETE | https://demo.otms.cn/ws/shipPointImport | application/xml | application/xml |
请求参数
| 字段名 | 位置 | 是否必填 | 描述 | Schema |
|---|---|---|---|---|
| body | body | 是 | 提送货点删除请求 | ShipPointRemoveRequest |
| Authorization | header | Basic Authorization。如果不为空，则优先使用该值作身份认证。否则使用请求报文中的用户名与密码 | string |
响应参数
| 状态码 | 描述 | 响应模型 |
|---|---|---|
| 200 | successful operation | ShipPointRemoveResponse |
RemovedShipPoint
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| sequence | integer (int32) | 是 | 序列数 | |
| clientCode | string | 否 | oTMS线下客户公司代码 (承运商帐户适用) | |
| clientReferenceNumber | string | 否 | 调用的系统订单标识符 | |
| type | string | 否 | 客户端引用识别码，可以取下列值： 0 - 提货点 1 - 送货点 2 - 集散中心 |
|
| externalId | string | 否 | 外部识别码 |
ResponseCode
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| code | string | 否 | 返回码 |
ShipPointRemoveRequest
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| version | string | 是 | 请求的版本号。当前版本号为0.1 | |
| login | string | 否 | 用户名。用于 API 调用者身份认证。如果请求头中的Authorization不为空，则该值会被忽略。 | |
| password | string | 否 | 密码。用于 API 调用者身份认证。如果请求头中的Authorization不为空，则该值会被忽略。 | |
| shipPoints | array[RemovedShipPoint] | 是 | 提送货点删除列表 |
ShipPointRemoveResponse
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| version | string | 是 | 响应版本号 | |
| responseCode | string | 否 | 全局的反馈代码 | |
| processedShipPoints | string | 否 | 处理的提送货点数量 | |
| shipPoints | array[ShipPointResponse] | 否 | 处理的提送货点列表 |
ShipPointResponse
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| sequence | integer (int32) | 否 | 序列数 | |
| clientReferenceNumber | string | 否 | 客户查询号，从收到的收发货点中获取。 | |
| importStatus | string | 否 | 收发货点导入状态，包括如下常量： ADDED UPDATED REMOVED FAILED |
|
| responseCodes | array[ResponseCode] | 否 | 订单响应代码列表，导入结果的详细说明，可能为空 | |
| responseCodeParameters | object | 否 | - |
请求示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointRemoveRequest version="0.1" login="username" password="password">
<shipPoints>
<shipPoint sequence="1">
<clientReferenceNumber>sh00105001</clientReferenceNumber>
<type>0</type>
<externalId>11223344</externalId>
</shipPoint>
<shipPoint sequence="2">
<clientReferenceNumber>sh00105002</clientReferenceNumber>
<type>1</type>
<externalId>11223344</externalId>
</shipPoint>
</shipPoints>
</shipPointRemoveRequest>
响应示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointRemoveResponse version="0.1">
<responseCode/>
<processedShipPoints>2</processedShipPoints>
<shipPoints>
<shipPoint>
<clientReferenceNumber>sh00105001</clientReferenceNumber>
<importStatus>REMOVED</importStatus>
<responseCodes/>
</shipPoint>
<shipPoint>
<clientReferenceNumber>sh00105002</clientReferenceNumber>
<importStatus>REMOVED</importStatus>
<responseCodes/>
</shipPoint>
</shipPoints>
</shipPointRemoveResponse>
全局反馈代码
| 反馈代码 | 说明 |
| 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 | 集散点外部代码重复。 |
| 1047 | 集散点上仍存在系统中维护的员工，无法删除。 |
| 1048 | 集散点上仍存在未处理完成的订单，无法删除 |
| 1050 | 不支持XTT--公司设置已关闭XTT选项。 |
| 1051 | 选择XTT支持但未提供Email地址。 |
| 1055 | 不支持短信通知--公司设置已关闭短信通知选项。 |
| 1056 | 选择短信通知但未提供手机号码。 |
| 1060 | 已禁用分公司--忽略分公司设置。 |
| 1100 | 其他错误。 |