仓库管理 API
1. 接口概述
仓库管理API用于管理系统中的仓库信息，包括查询仓库列表、获取仓库货位详情以及进行货位整理等功能。通过这些接口可以实现仓库基础信息的查询和货位管理操作。
2. 接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
branch.getList | POST | 获取仓库列表 |
branch.getDetail | POST | 获取仓库详情 |
3. 系统级参数
系统级参数是调用所有接口都必须提供的参数：
| 参数名 | 类型 | 必填 | 名称 | 描述 |
|---|---|---|---|---|
flag | string | 是 | 应用标识 | 用于标识调用方身份 |
method | string | 是 | 接口方法名 | 例如：branch.getList |
ver | number | 是 | 版本号 | 固定为1 |
charset | string | 是 | 字符集 | 固定为utf-8 |
type | string | 是 | 返回格式 | 固定为json |
timestamp | string | 是 | 时间戳 | 格式：yyyyMMddHHmmss |
sign | string | 是 | 签名 | 用于验证请求的合法性 |
4. 接口详细说明
4.1 获取仓库列表
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
branch_bn | string | 否 | 仓库编号 |
branch_name | string | 否 | 仓库名称 |
region | string | 否 | 地区 |
page_no | int | 是 | 页码，默认1 |
page_size | int | 是 | 每页条数，默认50，最大1000 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | int | 总记录数 |
lists | array | 仓库列表 |
lists 数组中的每个对象包含以下字段：
| 参数名 | 类型 | 描述 |
|---|---|---|
branch_bn | string | 仓库编号 |
branch_name | string | 仓库名称 |
branch_type | string | 仓库类型 |
area | string | 地区 |
address | string | 地址 |
zip | string | 邮政编码 |
phone | string | 电话 |
uname | string | 联系人姓名 |
mobile | string | 手机号 |
sex | string | 性别 |
cutoff_time | string | 截单时间 |
latest_delivery_time | string | 最晚发货时间 |
ability | string | 能力 |
owner | string | 负责人 |
is_deliv_branch | string | 是否发货仓库 |
weight | decimal | 重量 |
attr | string | 属性 |
b_status | string | 状态 |
请求示例
请参考openapi.md文档中【6. 接口调用示例】。
响应示例
json
{
"count": 10,
"lists": [
{
"branch_bn": "WARE001",
"branch_name": "测试仓库",
"branch_type": "1",
"area": "华东地区",
"address": "上海市浦东新区XX路XX号",
"zip": "200000",
"phone": "021-12345678",
"uname": "张三",
"mobile": "13800138000",
"sex": "男",
"cutoff_time": "18:00",
"latest_delivery_time": "20:00",
"ability": "标准",
"owner": "李四",
"is_deliv_branch": "true",
"weight": 0,
"attr": "",
"b_status": "1"
}
]
}4.2 获取仓库详情
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
branch_bn | string | 是 | 仓库编号 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
branch_id | int | 仓库ID |
branch_bn | string | 仓库编号 |
branch_name | string | 仓库名称 |
region | string | 地区 |
address | string | 地址 |
contacts | string | 联系人 |
tel | string | 电话 |
status | string | 状态 |
created_time | string | 创建时间 |
updated_time | string | 更新时间 |
remark | string | 备注 |
请求示例
请参考openapi.md文档中【6. 接口调用示例】。
响应示例
json
{
"branch_id": 1,
"branch_bn": "WARE001",
"branch_name": "测试仓库",
"region": "华东地区",
"address": "上海市浦东新区XX路XX号",
"contacts": "张三",
"tel": "13800138000",
"status": "启用",
"created_time": "2024-01-01 10:00:00",
"updated_time": "2024-01-05 15:30:00",
"remark": "测试用仓库"
}5. 错误码说明
| 错误码 | 错误信息 | 解决方案 |
|---|---|---|
| 0 | 成功 | - |
| 1 | 参数错误 | 检查参数格式是否正确，所有必填参数是否都已提供 |
| 400 | 参数错误 | 检查参数格式是否正确，所有必填参数是否都已提供 |
| 401 | 未授权访问 | 检查flag和sign是否正确 |
| 403 | 禁止访问 | 联系管理员获取权限 |
| 500 | 服务器内部错误 | 检查请求参数或联系技术支持 |
| 1001 | 非法的flag | 请检查flag是否正确 |
| 1002 | 请求已过期 | 请检查timestamp是否正确，请求有效期为5分钟 |
| 1003 | 签名错误 | 请检查签名算法和参数是否正确 |
| 1004 | 不支持的type格式 | 请使用json格式 |
| 2001 | 缺少必要的参数 | 请检查请求参数是否完整 |
| 2002 | 非法的请求参数 | 请检查参数格式和范围是否正确 |
| 2003 | 接口不存在 | 请检查接口方法名是否正确 |
6. 注意事项
- 时间格式必须为
yyyy-MM-dd HH:mm:ss，否则可能导致查询失败。 page_size参数最大支持 1000，默认50，超过100将被限制为 100。- 对于大数据量的查询，建议使用地区进行精确筛选，以提高查询效率。
- 时间戳必须与服务器时间保持同步，误差不超过3600秒。
- 每个请求必须生成唯一的签名，避免重复提交。
- 请妥善保管接口密钥，避免泄露。
- 所有请求参数中的特殊字符必须进行 URL 编码，特别是在使用 GET 方法时。
- 请确保在请求头中设置正确的 Content-Type，对于 POST 请求建议使用 application/json。
- 为了系统性能和稳定性，请避免短时间内发送大量请求，建议控制调用频率。
- 敏感数据（如签名、密钥等）请勿在日志中记录，确保数据安全。