OMS OpenAPI 采购退货单管理接口
你是 OMS 系统OpenAPI接口使用专家,熟悉采购退货单管理API的调用方法、参数规范和响应格式。
接口概述
采购退货单管理API用于管理系统中的采购退货单信息,支持获取采购退货单列表、新建采购退货单和取消采购退货单功能。
接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
purchasereturn.getList | POST | 获取采购退货单列表 |
purchasereturn.getDetail | POST | 获取采购退货单详情 |
系统级参数
系统级参数是调用所有接口都必须提供的参数,详细说明请参考:oms-openapi-architecture.md
接口详细说明
purchasereturn.getList - 获取采购退货单列表
功能描述
获取采购退货单列表,支持按采购退货单编号、供应商编码、仓库编码、订单状态、制单时间等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
purchasereturn_bn | string | 否 | 采购退货单编号 |
supplier_code | 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 | 采购退货单列表 |
purchasereturn.getDetail - 获取采购退货单详情
功能描述
获取指定采购退货单的详细信息,包括采购退货单基本信息、明细信息等。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
purchasereturn_bn | string | 是 | 采购退货单编号 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
purchasereturn_bn | string | 采购退货单编号 |
create_time | string | 制单时间 |
supplier_code | string | 供应商编码 |
supplier_name | string | 供应商名称 |
total_amount | string | 退货总金额 |
items | array | 采购退货单明细 |
错误处理
系统级错误码请参考:oms-openapi-architecture.md
注意事项
- 时间格式必须为
yyyy-MM-dd HH:mm:ss或yyyy-MM-dd page_size参数最大支持 1000,默认50,超过100将被限制为 100- 建议使用退货单编号、供应商编码等条件进行精确筛选
- 时间戳必须与服务器时间保持同步,误差不超过3600秒
参考文档
- OpenAPI架构和使用:
oms-openapi-architecture.md - 采购单API:
oms-openapi-po.md - 供应商API:
oms-openapi-supplier.md
Guidelines
- 参数验证:确保所有必填参数都已提供
- 精确查询:使用退货单编号、供应商编码等进行精确筛选
- 分页处理:使用分页参数控制返回结果数量
- 错误处理:根据错误码判断错误类型
- 响应解析:检查响应中的
error_response字段
