oTMS logo 开放平台
Documentation Help

运输单召回

运输单召回

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

配置说明

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

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

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

接口说明

公共参数

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

请求参数

字段名 位置 是否必填 描述 Schema
body body 运输单删除请求 JobSheetRecallRequest
Authorization header Basic Authorization。如果不为空,则优先使用该值作身份认证。否则使用请求报文中的用户名与密码 string

响应参数

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

详细描述

JobSheetDelete

字段名 类型 是否必填 描述 示例
sequence integer (int32) 序列数
jobSheetNumber string 运输单号
externalShipmentId string 运输单外部识别号

JobSheetDeleteResult

字段名 类型 是否必填 描述 示例
sequence integer (int32) 序列数
jobSheetNumber string 运输单号
externalShipmentId string 运输单外部识别号
status string 响应状态
code string 响应码
msg string 响应信息

JobSheetRecallRequest

字段名 类型 是否必填 描述 示例
version string 请求的版本号
login string 用户名。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。
password string 密码。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。
jobSheets array[JobSheetDelete] 需要召回的运输单列表。单次召回的最大数量为20

JobSheetRecallResponse

字段名 类型 是否必填 描述 示例
version string 响应版本号
responseCode string 全局的反馈代码
jobSheets array[JobSheetDeleteResult] 运输单召回结果详细信息

报文示例

请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetRecallRequest version="0.1" login="login" password="password">
    <jobSheets>
        <jobSheet sequence="1">
            <jobSheetNumber>JSSH00105000025</jobSheetNumber>
            <externalShipmentId>JSSH00105000025</externalShipmentId>
        </jobSheet>
        <jobSheet sequence="2">
            <jobSheetNumber>JSSH00105000024</jobSheetNumber>
            <externalShipmentId>JSSH00105000024</externalShipmentId>
        </jobSheet>
    </jobSheets>
</jobSheetRecallRequest>

响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetRecallResponse version="0.1">
    <responseCode></responseCode>
    <jobSheets>
        <jobSheet sequence="1">
            <jobSheetNumber>JSSH00105000025</jobSheetNumber>
            <externalShipmentId>JSSH00105000025</externalShipmentId>
            <status>SUCCEED</status>
            <code>100</code>
            <msg>Success</msg>
        </jobSheet>
        <jobSheet sequence="2">
            <jobSheetNumber>JSSH00105000024</jobSheetNumber>
            <externalShipmentId>JSSH00105000024</externalShipmentId>
            <status>FAILED</status>
            <code>109</code>
            <msg>Invalid job sheet state</msg>
        </jobSheet>
    </jobSheets>
</jobSheetRecallResponse>

错误码解释

全局反馈代码

反馈代码 说明
0客户验证失败。
1不支持的请求版本。
2超过最大请求数(100)
3请求错误
4服务器繁忙

单个请求反馈代码

反馈代码 说明
100成功
101没有找到运输单
109运输单状态错误
111运输单召回失败(请检查订单状态)

API工具