Skip to content

OMS OpenAPI 加工单管理接口

你是 OMS 系统OpenAPI接口使用专家,熟悉加工单管理API的调用方法、参数规范和响应格式。

接口概述

加工单管理API用于查询系统中的加工单信息,支持按更新时间范围和加工单号进行过滤,并支持分页查询。通过该接口可以获取指定时间段内的加工单详细信息。

接口列表

接口名方法功能描述
workorder.getListPOST获取工单列表
workorder.getDetailPOST获取工单详情

系统级参数

系统级参数是调用所有接口都必须提供的参数,详细说明请参考:oms-openapi-architecture.md

接口详细说明

workorder.getList - 获取工单列表

功能描述

获取工单列表,支持按工单号、工单类型、工单状态、创建时间等条件进行筛选。

请求参数

参数名类型必填描述
workorder_bnstring工单号
workorder_typestring工单类型
workorder_statusstring工单状态
start_timestring创建开始时间,格式:2022-01-01
end_timestring创建结束时间,格式:2022-01-31
page_noint页码,默认1
page_sizeint每页条数,默认50,最大1000

响应参数

参数名类型描述
countint总记录数
listsarray工单列表

workorder.getDetail - 获取工单详情

功能描述

获取指定工单的详细信息,包括工单基本信息、商品明细、处理日志等。

请求参数

参数名类型必填描述
workorder_idstring工单ID
workorder_bnstring工单号

响应参数

参数名类型描述
workorder_idstring工单ID
workorder_bnstring工单号
workorder_typestring工单类型
workorder_statusstring工单状态
itemsarray工单商品明细
process_logsarray处理日志

错误处理

系统级错误码请参考:oms-openapi-architecture.md

注意事项

  1. 时间格式必须为 yyyy-MM-dd HH:mm:ssyyyy-MM-dd
  2. page_size 参数最大支持 1000,默认50,超过100将被限制为 100
  3. 建议使用工单号、工单类型等条件进行精确筛选
  4. 时间戳必须与服务器时间保持同步,误差不超过3600秒

参考文档

  • OpenAPI架构和使用:oms-openapi-architecture.md
  • 出入库单API:oms-openapi-transfer.md

Guidelines

  1. 参数验证:确保所有必填参数都已提供
  2. 精确查询:使用工单号、工单类型等进行精确筛选
  3. 分页处理:使用分页参数控制返回结果数量
  4. 错误处理:根据错误码判断错误类型
  5. 响应解析:检查响应中的error_response字段