收货码查询
通过收货码相关信息查询接口，客户系统接入 oTMS 系统，查询 oTMS 订单收货码相关信息和状态。
| 版本号 | 文档 | 说明 |
|---|---|---|
| 0.1 | 当前版本文档 |
oTMS同时在生产环境和测试环境中提供Web Service接口，其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
目前对该接口的调用限制为每个公司每秒最多10个请求
公共参数
| 环境 | 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 |
| Authorization | header | 是 | Basic Authorization。如果不为空，则优先使用该值作身份认证。否则使用请求报文中的用户名与密码 | string |
响应参数
| 状态码 | 描述 | 响应模型 |
|---|---|---|
| 200 | successful operation | DeliveryCodeQueryResponse |
DeliveryCodeDetail
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| truckPlate | string | 否 | 车牌 | |
| driverName | string | 否 | 司机姓名 | |
| driverMobile | string | 否 | 司机电话 | |
| deliveryCode | string | 否 | 收货码 | |
| codeUpdateTime | string (date-time) | 否 | 收货码更新时间 |
DeliveryCodeQueryResponse
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| version | string | 是 | 响应版本号 | |
| responseCode | string | 否 | 全局的反馈代码 | |
| detail | DeliveryCodeDetail | 否 | 拒收 |
OrderRequest
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| orderNumber | string | 否 | oTMS单号 | |
| erpNumber | string | 否 | ERP#, 与oTMS单号不能同时为空 | |
| clientCode | string | 否 | 客户代码 |
请求示例
{
"orderNumber": "YBLHQYHD000420"
}响应示例
{
"version": "0.1",
"responseCode": "1000",
"detail": {
"deliveryCode": "123456"
}
}全局反馈代码
| 反馈代码 | 说明 |
| 0 | 客户验证失败。 |
| 1 | 不支持的请求版本。 |
单个请求反馈代码
| 反馈代码 | 说明 |
| 1000 | 成功。 |
| 2000 | 失败。 |
| 1001 | 未找到订单。 |