订单召回
通过该接口,外部系统能够在oTMS系统中将订单直接召回。
版本号 | 文档 | 说明 |
---|---|---|
0.1 | 当前版本文档 |
oTMS同时在生产环境和测试环境中提供Web Service接口,其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况,会对API账号的调用进行限制,甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况,会对API账号的调用进行限制,甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
目前对该接口的调用限制为每个公司每秒最多10个请求
公共参数
环境 | HTTP请求方法 | HTTPS请求地址 | 请求主体MIME类型 | 响应主体MIME类型 |
---|---|---|---|---|
正式环境 | POST | https://login.otms.cn/ws/orderRecall | application/xml | application/xml |
沙箱环境 | POST | https://demo.otms.cn/ws/orderRecall | application/xml | application/xml |
请求参数
字段名 | 位置 | 是否必填 | 描述 | Schema |
---|---|---|---|---|
Authorization | header | Basic Authorization。如果不为空,则优先使用该值作身份认证。否则使用请求报文中的用户名与密码 | string | |
body | body | 是 | 请求体是根元素<orderRecallRequest>的子元素<orders>。<orders>元素中包含了多个<order>子元素 (最多100个) 。每个<order>子元素都代表了一个请求的召回操作。 | OrderRecallWebService |
响应参数
状态码 | 描述 | 响应模型 |
---|---|---|
200 | successful operation | OrderRecallResponse |
OrderErpNumberResponse
字段名 | 类型 | 是否必填 | 描述 | 示例 |
---|---|---|---|---|
sequence | integer (int32) | 否 | 返回结果序列号 | |
recallStatus | string | 否 | 召回操作的结果: SUCCEED - 召回成功,未发生错误 FAILED - 召回失败,发生错误 NOT_RECALLED - 不符合召回条件导致召回失败 |
|
responseCodes | array[string] | 否 | 返回码列表,描述了详细的召回结果 | |
erpNumber | string | 否 | 成功召回的订单erp单号 |
OrderRecallResponse
字段名 | 类型 | 是否必填 | 描述 | 示例 |
---|---|---|---|---|
version | string | 是 | 响应版本号 | |
responseCode | string | 否 | 全局的反馈代码 | |
successfulRecalled | integer (int32) | 否 | 成功召回的订单数 | |
orders | array[OrderErpNumberResponse] | 否 | 召回的订单erp集合 |
OrderRecallWebService
字段名 | 类型 | 是否必填 | 描述 | 示例 |
---|
请求示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderRecallRequest version="0.1" login="username" password="password">
<orders>
<order sequence="1">
<erpNumber>J3Z-001</erpNumber>
</order>
<order sequence="2">
<erpNumber>J3Z-002</erpNumber>
</order>
</orders>
</orderRecallRequest>
响应示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderRecallResponse version="0.1">
<responseCode>FAILED</responseCode>
<successfulRecalled>0</successfulRecalled>
<orders>
<order sequence="1">
<recallStatus>NOT_RECALLED</recallStatus>
<responseCodes>
<responseCode>
<code>2203</code>
</responseCode>
</responseCodes>
<erpNumber>J3Z-001</erpNumber>
</order>
<order sequence="2">
<recallStatus>FAILED</recallStatus>
<responseCodes>
<responseCode>
<code>2200</code>
</responseCode>
</responseCodes>
<erpNumber>J3Z-002</erpNumber>
</order>
</orders>
</orderRecallResponse>
全局反馈代码
反馈代码 | 说明 |
0 | 客户验证失败。 |
1 | 不支持的请求版本。 |
2 | 请求中的召回订单过多。 |
单个请求反馈代码
反馈代码 | 说明 |
2200 | 未找到请求召回的订单。 |
2201 | 不是请求召回的订单的创建者。 |
2202 | 订单已拆分。 |
2203 | 订单已合并。 |
2204 | 订单已提货。 |
2205 | 订单已分配给自有车辆。 |
2206 | 订单已由承运商分配给自有车辆。 |
2207 | 订单已分配给线上二级承运商。 |
2208 | 订单已分配给运输单。 |
2209 | 订单已整合。 |
2300 | 错误产生。 |