基础物料管理 API
1. 接口概述
基础物料管理API用于管理系统中的基础物料信息，包括查询、添加和修改基础物料。通过这些接口可以实现物料信息的维护，支持成品、半成品和礼盒等不同类型的物料管理。
2. 接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
basicmaterial.getList | POST | 获取基础物料列表 |
basicmaterial.getDetail | POST | 获取基础物料详情 |
3. 系统级参数
系统级参数是调用所有接口都必须提供的参数：
| 参数名 | 类型 | 必填 | 名称 | 描述 |
|---|---|---|---|---|
flag | string | 是 | 应用标识 | 用于标识调用方身份 |
method | string | 是 | 接口方法名 | 例如：basicmaterial.getList |
ver | number | 是 | 版本号 | 固定为1 |
charset | string | 是 | 字符集 | 固定为utf-8 |
type | string | 是 | 返回格式 | 固定为json |
timestamp | string | 是 | 时间戳 | 格式：yyyyMMddHHmmss |
sign | string | 是 | 签名 | 用于验证请求的合法性 |
4. 接口详细说明
4.1 获取基础物料列表
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
item_name | string | 否 | 物料名称，模糊匹配 |
item_id | int | 否 | 物料ID |
page_no | int | 是 | 页码，默认1 |
page_size | int | 是 | 每页条数，默认50，最大1000 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | int | 总记录数 |
lists | array | 基础物料列表 |
lists 数组中的每个对象包含以下字段：
| 参数名 | 类型 | 描述 |
|---|---|---|
item_id | int | 物料ID |
item_name | string | 物料名称 |
item_code | string | 物料编码 |
item_spec | string | 物料规格 |
unit_id | int | 单位ID |
unit_name | string | 单位名称 |
disabled | string | 是否禁用（false:启用，true:禁用） |
createtime | string | 创建时间 |
last_modify | string | 最后修改时间 |
请求示例
请参考openapi.md文档中【6. 接口调用示例】。
响应示例
json
{
"count": 100,
"lists": [
{
"item_id": 1,
"item_name": "测试物料A",
"item_code": "ITEM001",
"item_spec": "规格1",
"unit_id": 1,
"unit_name": "个",
"disabled": "false",
"createtime": "2024-01-01 10:00:00",
"last_modify": "2024-01-01 10:00:00"
}
]
}4.2 获取基础物料详情
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
item_id | int | 是 | 物料ID |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
item_id | int | 物料ID |
item_name | string | 物料名称 |
item_code | string | 物料编码 |
item_spec | string | 物料规格 |
unit_id | int | 单位ID |
unit_name | string | 单位名称 |
category_id | int | 分类ID |
category_name | string | 分类名称 |
brand_id | int | 品牌ID |
brand_name | string | 品牌名称 |
description | string | 物料描述 |
disabled | string | 是否禁用（false:启用，true:禁用） |
createtime | string | 创建时间 |
last_modify | string | 最后修改时间 |
请求示例
请参考openapi.md文档中【6. 接口调用示例】。
响应示例
json
{
"item_id": 1,
"item_name": "测试物料A",
"item_code": "ITEM001",
"item_spec": "规格1",
"unit_id": 1,
"unit_name": "个",
"category_id": 1,
"category_name": "测试分类",
"brand_id": 1,
"brand_name": "测试品牌",
"description": "这是一个测试物料",
"disabled": "false",
"createtime": "2024-01-01 10:00:00",
"last_modify": "2024-01-01 10:00:00"
}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。
- 为了系统性能和稳定性，请避免短时间内发送大量请求，建议控制调用频率。
- 敏感数据（如签名、密钥等）请勿在日志中记录，确保数据安全。