oTMS logo 开放平台
Documentation Help

订单撤销

通过订单撤销接口,可以撤回分配到下游承运商的订单。

配置说明

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

接口说明

公共参数

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

请求参数

字段名 位置 是否必填 描述 Schema
body body 订单撤销请求 OrderRevokeRequest

响应参数

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

详细描述

OrderRevoke

字段名 类型 是否必填 描述 示例
sequence integer (int32) 序列数
erpNumber string 外部系统号
orderNumber string oTMS订单号

OrderRevokeRequest

字段名 类型 是否必填 描述 示例
version string 请求的版本号
login string 用户名。用于 API 调用者身份认证。
password string 密码。用于 API 调用者身份认证。
orders array[OrderRevoke] 待撤销分配的订单列表。一次请求最多可以撤销100条订单

OrderRevokeResponse

字段名 类型 是否必填 描述 示例
version string 响应版本号
responseCode string 全局的反馈代码
orders array[OrderRevokeResult] -

OrderRevokeResult

字段名 类型 是否必填 描述 示例
sequence integer (int32) 序列数
erpNumber string 外部系统号
orderNumber string oTMS订单号
status string 响应状态
code string 响应码
msg string 响应信息

报文示例

请求示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderRevokeRequest version="0.1" login="username" password="password">
    <orders>
        <order sequence="1">
            <erpNumber>erp000001</erpNumber>
        </order>
        <order sequence="2">
            <orderNumber>SH00105000002</orderNumber>
        </order>
    </orders>
</orderRevokeRequest>

响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderRevokeResponse version="0.1">
    <orders>
        <order sequence="1">
            <erpNumber>erp000001</erpNumber>
            <status>SUCCEED</status>
            <code>100</code>
            <msg>Success</msg>
        </order>
        <order sequence="2">
            <orderNumber>SH00105000002</orderNumber>
            <status>FAILED</status>
            <code>102</code>
            <msg>Order not found</msg>
        </order>
    </orders>
</orderRevokeResponse>

API工具