oTMS logo 开放平台
Documentation Help

运输单删除

运输单删除

配置说明

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

接口说明

公共参数

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

请求参数

字段名 位置 是否必填 描述 Schema
body body 运输单删除请求 JobSheetDeleteRequest

响应参数

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

详细描述

JobSheetDelete

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

JobSheetDeleteRequest

字段名 类型 是否必填 描述 示例
version string 请求的版本号
login string 用户名。用于 API 调用者身份认证。
password string 密码。用于 API 调用者身份认证。
jobSheets array[JobSheetDelete] 需要删除的运输单列表。单次删除的最大数量为100

JobSheetDeleteResponse

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

JobSheetDeleteResult

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

报文示例

请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetDeleteRequest 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>
</jobSheetDeleteRequest>

响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetDeleteResponse 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>
</jobSheetDeleteResponse>

错误码解释

全局反馈代码

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

单个请求反馈代码

反馈代码 说明
100成功
101没有找到运输单
109运输单状态错误

API工具