转储单管理 API
1. 接口概述
转储单管理API用于查询系统中的转储单信息，支持按更新时间、确认时间、转储单编号和入库状态等条件查询转储单列表。
2. 接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
stockdump.getList | POST | 获取报损单列表 |
stockdump.getDetail | POST | 获取报损单详情 |
3. 系统级参数
系统级参数是调用所有接口都必须提供的参数：
| 参数名 | 类型 | 必填 | 名称 | 描述 |
|---|---|---|---|---|
flag | string | 是 | 应用标识 | 用于标识调用方身份 |
method | string | 是 | 接口方法名 | 例如：stockdump.getList |
ver | number | 是 | 版本号 | 固定为1 |
charset | string | 是 | 字符集 | 固定为utf-8 |
type | string | 是 | 返回格式 | 固定为json |
timestamp | string | 是 | 时间戳 | 格式：yyyyMMddHHmmss |
sign | string | 是 | 签名 | 用于验证请求的合法性 |
4. 接口详细说明
4.1 获取报损单列表
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
stockdump_bn | string | 否 | 报损单编号 |
branch_bn | string | 否 | 仓库编码 |
status | string | 否 | 订单状态（1:待审核 2:已审核 3:已驳回 4:已关闭） |
start_time | string | 否 | 制单开始时间，格式：2022-01-01 |
end_time | string | 否 | 制单结束时间，格式：2022-01-31 |
page_no | int | 是 | 页码，默认1 |
page_size | int | 是 | 每页条数，默认50，最大1000 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | int | 总记录数 |
lists | array | 报损单列表 |
lists 数组中的每个对象包含以下字段：
| 参数名 | 类型 | 描述 |
|---|---|---|
stockdump_bn | string | 报损单编号 |
create_time | string | 制单时间 |
branch_bn | string | 仓库编码 |
branch_name | string | 仓库名称 |
total_amount | string | 报损总金额 |
status | string | 订单状态 |
status_text | string | 状态描述 |
creator | string | 制单人 |
请求示例
请参考openapi.md文档中【6. 接口调用示例】。
响应示例
json
{
"count": 100,
"lists": [
{
"stockdump_bn": "SD202201010001",
"create_time": "2022-01-01 10:00:00",
"branch_bn": "WARE001",
"branch_name": "测试仓库",
"total_amount": "2000.00",
"status": "2",
"status_text": "已审核",
"creator": "张三"
}
]
}4.2 获取报损单详情
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
stockdump_bn | string | 是 | 报损单编号 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
stockdump_bn | string | 报损单编号 |
create_time | string | 制单时间 |
branch_bn | string | 仓库编码 |
branch_name | string | 仓库名称 |
currency | string | 币种 |
tax_rate | string | 税率 |
total_amount | string | 报损总金额 |
total_amount_with_tax | string | 含税总金额 |
status | string | 订单状态 |
status_text | string | 状态描述 |
creator | string | 制单人 |
remark | string | 备注 |
items | array | 报损单明细 |
items 数组中的每个对象包含以下字段：
| 参数名 | 类型 | 描述 |
|---|---|---|
bn | string | 商品编码 |
name | string | 商品名称 |
spec_info | string | 规格信息 |
quantity | int | 报损数量 |
price | string | 报损单价 |
amount | string | 报损金额 |
tax_price | string | 含税单价 |
tax_amount | string | 含税金额 |
damage_reason | string | 报损原因 |
stockout_quantity | int | 已出库数量 |
请求示例
请参考openapi.md文档中【6. 接口调用示例】。
响应示例
json
{
"stockdump_bn": "SD202201010001",
"create_time": "2022-01-01 10:00:00",
"branch_bn": "WARE001",
"branch_name": "测试仓库",
"currency": "CNY",
"tax_rate": "13%",
"total_amount": "2000.00",
"total_amount_with_tax": "2260.00",
"status": "2",
"status_text": "已审核",
"creator": "张三",
"remark": "测试备注",
"items": [
{
"bn": "PROD001",
"name": "测试商品",
"spec_info": "红色,M",
"quantity": 20,
"price": "100.00",
"amount": "2000.00",
"tax_price": "113.00",
"tax_amount": "2260.00",
"damage_reason": "质量问题",
"stockout_quantity": 20
}
]
}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。
- 为了系统性能和稳定性，请避免短时间内发送大量请求，建议控制调用频率。
- 敏感数据（如签名、密钥等）请勿在日志中记录，确保数据安全。