运输单召回

通过运输单召回接口，可以撤销已分配的运输单。

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

配置说明

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

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

目前对该接口的调用限制为每个公司每秒最多3个请求（如需增加可选购增值服务）。

接口说明

公共参数

环境	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

错误码解释

全局反馈代码

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

单个请求反馈代码

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

请求参数

Body 参数application/xml

示例

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

返回响应

🟢200成功

application/xml

successful operation

Body

示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetRecallResponse version="0.1">
    <responseCode></responseCode>
    <jobSheets>
        <jobSheet sequence="1">
            <jobSheetNumber>JSYBLHQYHD001145</jobSheetNumber>
            <externalShipmentId></externalShipmentId>
            <status>SUCCEED</status>
            <code>100</code>
            <msg>Success</msg>
        </jobSheet>
        <jobSheet sequence="2">
            <jobSheetNumber></jobSheetNumber>
            <externalShipmentId>250606001</externalShipmentId>
            <status>SUCCEED</status>
            <code>100</code>
            <msg>Success</msg>
        </jobSheet>
    </jobSheets>
</jobSheetRecallResponse>

运输单召回

运输单召回#

配置说明#

接口说明#

公共参数#

请求参数#

错误码解释#

全局反馈代码#

单个请求反馈代码#

请求参数

返回响应

运输单召回

配置说明

接口说明

公共参数

请求参数

错误码解释

全局反馈代码

单个请求反馈代码