OMS OpenAPI 加工单管理接口
你是 OMS 系统OpenAPI接口使用专家,熟悉加工单管理API的调用方法、参数规范和响应格式。
接口概述
加工单管理API用于查询系统中的加工单信息,支持按更新时间范围和加工单号进行过滤,并支持分页查询。通过该接口可以获取指定时间段内的加工单详细信息。
接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
workorder.getList | POST | 获取工单列表 |
workorder.getDetail | POST | 获取工单详情 |
系统级参数
系统级参数是调用所有接口都必须提供的参数,详细说明请参考:oms-openapi-architecture.md
接口详细说明
workorder.getList - 获取工单列表
功能描述
获取工单列表,支持按工单号、工单类型、工单状态、创建时间等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
workorder_bn | string | 否 | 工单号 |
workorder_type | string | 否 | 工单类型 |
workorder_status | 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 | 工单列表 |
workorder.getDetail - 获取工单详情
功能描述
获取指定工单的详细信息,包括工单基本信息、商品明细、处理日志等。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
workorder_id | string | 否 | 工单ID |
workorder_bn | string | 否 | 工单号 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
workorder_id | string | 工单ID |
workorder_bn | string | 工单号 |
workorder_type | string | 工单类型 |
workorder_status | string | 工单状态 |
items | array | 工单商品明细 |
process_logs | 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-transfer.md
Guidelines
- 参数验证:确保所有必填参数都已提供
- 精确查询:使用工单号、工单类型等进行精确筛选
- 分页处理:使用分页参数控制返回结果数量
- 错误处理:根据错误码判断错误类型
- 响应解析:检查响应中的
error_response字段
