收货码查询

通过收货码相关信息查询接口，客户系统可以接入 oTMS 系统，查询 oTMS 订单的收货码相关信息和状态。

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

配置说明

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

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

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

接口说明

公共参数

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

请求参数

字段名	位置	是否必填	描述	Schema
body	body	是	收货码查询请求	OrderRequest

错误码解释

全局反馈代码

反馈代码	说明
0	客户验证失败。
1	不支持的请求版本。

单个请求反馈代码

反馈代码	说明
1000	成功。
2000	失败。
1001	未找到订单。

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

Body 参数application/json

示例

{
    "orderNumber": "YBLHQYHD017876",
    "erpNumber": "",
    "clientCode": ""
}

返回响应

🟢200成功

application/json

Body

示例

{
    "version": "0.1",
    "responseCode": "1000",
    "detail": {
        "truckPlate": "苏B67565",
        "driverName": "liang",
        "driverMobile": "18000000000",
        "deliveryCode": "5606",
        "codeUpdateTime": 1752485122087
    }
}

收货码查询

收货码查询#

配置说明#

接口说明#

公共参数#

请求参数#

错误码解释#

全局反馈代码#

单个请求反馈代码#

请求参数

返回响应

收货码查询

配置说明

接口说明

公共参数

请求参数

错误码解释

全局反馈代码

单个请求反馈代码