订单拆分
订单拆分接口供客户系统接入并可以对订单进行拆分操作，订单拆分可以根据中转站进行两段拆分或者三段拆分。
| 版本号 | 文档 | 说明 |
|---|---|---|
| 0.1 | 当前版本文档 |
oTMS同时在生产环境和测试环境中提供Web Service接口，其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
目前对该接口的调用限制为每个公司每秒最多10个请求
公共参数
| 环境 | HTTP请求方法 | HTTPS请求地址 | 请求主体MIME类型 | 响应主体MIME类型 |
|---|---|---|---|---|
| 正式环境 | POST | https://login.otms.cn/ws/splitOrder | application/xml | application/xml |
| 沙箱环境 | POST | https://demo.otms.cn/ws/splitOrder | application/xml | application/xml |
请求参数
| 字段名 | 位置 | 是否必填 | 描述 | Schema |
|---|---|---|---|---|
| Authorization | header | Basic Authorization。如果不为空，则优先使用该值作身份认证。否则使用请求报文中的用户名与密码 | string | |
| body | body | 是 | 订单查询请求中包含用以筛选订单的查询条件。 | OrderSplitWebService |
响应参数
| 状态码 | 描述 | 响应模型 |
|---|---|---|
| 200 | successful operation | OrderSplitResponse |
OrderSplitInfoDto
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| orderNumber | string | 否 | 拆分订单的oTMS订单号 | |
| erpNumber | string | 否 | 拆分订单的erp号 | |
| orderLocationName | string | 否 | 拆分订单的地区名称 |
OrderSplitResponse
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| succeedCount | integer (int32) | 否 | 订单拆分成功个数 | |
| failedCount | integer (int32) | 否 | 订单拆分失败个数 | |
| result | Result | 否 | 订单拆分返回结果 | |
| results | Results | 否 | 订单拆分返回结果 |
OrderSplitWebService
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|
Result
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| sequence | integer (int32) | 否 | 订单拆分返回结果序列 | |
| orderInfo | OrderSplitInfoDto | 否 | 被拆分订单的信息 | |
| status | string | 否 | 订单拆分状态返回 (成功／失败) | |
| errMessage | string | 否 | 订单拆分错误信息返 | |
| splitOrderNumber | SplitOrderNumber | 否 | 拆分订单成功子订单oTMS订单号 |
Results
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| result | array[Result] | 否 | - |
SplitOrderNumber
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| orderNumber | array[string] | 否 | 拆分订单成功子订单oTMS订单号 |
请求示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderSplitRequest version="0.1" login="username" password="password">
<splitOperation>SPLIT_ORDER</splitOperation>
<orderQueries>
<orderQuery>
<orderNumber>SH00105005778</orderNumber>
<orderLocationName>北京 DC</orderLocationName>
</orderQuery>
</orderQueries>
<orderSplit>
<hubInfo>
<pickupHub>
<hub>上海中转站</hub>
<deliveryToHubFrom>2013-12-10T09:00</deliveryToHubFrom>
<deliveryToHubTo>2013-12-10T17:00</deliveryToHubTo>
<pickupFromHubFrom>2013-12-10T09:00</pickupFromHubFrom>
<pickupFromHubTo>2013-12-10T17:00</pickupFromHubTo>
</pickupHub>
<deliveryHub>
<hub>南京中转场</hub>
<deliveryToHubFrom>2013-12-10T09:00</deliveryToHubFrom>
<deliveryToHubTo>2013-12-10T17:00</deliveryToHubTo>
<pickupFromHubFrom>2013-12-10T09:00</pickupFromHubFrom>
<pickupFromHubTo>2013-12-10T17:00</pickupFromHubTo>
</deliveryHub>
</hubInfo>
<transportModeInfo>
<pickupTransType>AIR</pickupTransType>
<deliveryTransType>EXPRESS</deliveryTransType>
<lineTransType>RAIL</lineTransType>
</transportModeInfo>
</orderSplit>
</orderSplitRequest>
响应示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderSplitResponse>
<succeedCount>1</succeedCount>
<failedCount>0</failedCount>
<results>
<result sequence="1">
<orderInfo>
<orderNumber>SH00105005778</orderNumber>
</orderInfo>
<status>SUCCEED</status>
<splitOrderNumber>
<orderNumber>SH00105005778-1</orderNumber>
<orderNumber>SH00105005778-2</orderNumber>
<orderNumber>SH00105005778-3</orderNumber>
</splitOrderNumber>
</result>
</results>
</orderSplitResponse>
全局反馈代码
| 反馈代码 | 说明 |
| 0 | 客户验证失败。 |
| 1 | 请求版本错误 |
单个请求反馈代码
| 反馈代码 | 说明 |
| 5001 | 当前角色为货主，仅支持承运商进行拆分订单。 |
| 5002 | 错误的操作类型。 |
| 5003 | 角色错误，仅支持承运商进行拆分订单，且公司具有相应权限。 |
| 5004 | 请求格式错误。 |
| 5005 | 中转站信息格式错误。 |
| 5006 | 订单未找到。 |
| 5007 | 将要操作拆分的对象不唯一。 |
| 5008 | 订单查询超时。 |
| 5009 | 查询订单时发生未知错误。 |
| 50010 | 提货中转站或送货中转站名称或外部代码错误，没有匹配到公司中转站。 |
| 50011 | 中转站不能与原始订单提货点相同。 |
| 50012 | 中转站不能与原始订单送货点相同。 |
| 50013 | 提货时间必须与提货日期处于同一天或送货时间必须与送货日期处于同一天。 |
| 50014 | 同一个中转站，pickupFromHub时间从不能在PickToHub时间之后。 |
| 50015 | 同一个中转站，deliveryFromHub时间从不能在deliveryToHub时间之后。 |
| 50016 | 提货开始日期不能在送货日期之前。 |
| 50017 | 中转站送货日期不能在原始订单提货日期之前。 |
| 50018 | 中转站送货日期与原始订单提货日期之前，中转站送货时间不能在原始订单提货时间之前。 |
| 50019 | 中转站提货日期不能在原始订单送货日期之后。 |
| 50020 | 中转站提货日期与原始订单送货日期之前，中转站提货时间不能在原始订单送货时间之前。 |
| 50021 | 送货中转站送货时间不能在提货中转站提货时间之前。 |
| 50022 | 提货中转站不能与送货中转站相同。 |
| 50023 | 运输模式为整车情况下，订单必须提供车辆长度。 |
| 50024 | 没有权限做拆分订单。 |