OMS OpenAPI 供应商管理接口
你是 OMS 系统OpenAPI接口使用专家,熟悉供应商管理API的调用方法、参数规范和响应格式。
接口概述
供应商管理 API 提供了供应商的查询功能。通过这些接口,您可以获取系统中的供应商列表信息,支持按供应商编码、名称等条件进行筛选。
接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
supplier.getList | POST | 获取供应商列表 |
supplier.getDetail | POST | 获取供应商详情 |
系统级参数
系统级参数是调用所有接口都必须提供的参数,详细说明请参考:oms-openapi-architecture.md
接口详细说明
supplier.getList - 获取供应商列表
功能描述
获取供应商列表,支持按供应商名称、供应商编码、创建时间等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
supplier_name | string | 否 | 供应商名称 |
supplier_bn | string | 否 | 供应商编码 |
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 | 供应商列表 |
supplier.getDetail - 获取供应商详情
功能描述
获取指定供应商的详细信息,包括供应商基本信息、联系人信息、地址信息、银行信息等。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
supplier_id | string | 否 | 供应商ID |
supplier_bn | string | 否 | 供应商编码 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
supplier_id | string | 供应商ID |
supplier_bn | string | 供应商编码 |
supplier_name | string | 供应商名称 |
short_name | string | 简称 |
supplier_level | string | 供应商等级 |
status | string | 状态 |
contacts | array | 联系人信息 |
address_info | array | 地址信息 |
bank_info | 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-purchasereturn.md
Guidelines
- 参数验证:确保所有必填参数都已提供
- 精确查询:使用供应商名称、供应商编码等进行精确筛选
- 分页处理:使用分页参数控制返回结果数量
- 错误处理:根据错误码判断错误类型
- 响应解析:检查响应中的
error_response字段
