Skip to content

OMS OpenAPI 基础物料管理接口

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

接口概述

基础物料管理API用于管理系统中的基础物料信息,包括查询、添加和修改基础物料。通过这些接口可以实现物料信息的维护,支持成品、半成品和礼盒等不同类型的物料管理。

接口列表

接口名方法功能描述
basicmaterial.getListPOST获取基础物料列表
basicmaterial.getDetailPOST获取基础物料详情

系统级参数

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

接口详细说明

basicmaterial.getList - 获取基础物料列表

功能描述

获取基础物料列表,支持按物料名称、物料ID等条件进行筛选。

请求参数

参数名类型必填描述
item_namestring物料名称,模糊匹配
item_idint物料ID
page_noint页码,默认1
page_sizeint每页条数,默认50,最大1000

响应参数

参数名类型描述
countint总记录数
listsarray基础物料列表

basicmaterial.getDetail - 获取基础物料详情

功能描述

获取指定基础物料的详细信息,包括物料基本信息、分类信息、品牌信息等。

请求参数

参数名类型必填描述
item_idint物料ID

响应参数

参数名类型描述
item_idint物料ID
item_namestring物料名称
item_codestring物料编码
item_specstring物料规格
unit_namestring单位名称
category_namestring分类名称
brand_namestring品牌名称
disabledstring是否禁用(false:启用,true:禁用)

错误处理

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

注意事项

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

参考文档

  • OpenAPI架构和使用:oms-openapi-architecture.md
  • 销售物料API:oms-openapi-salesmaterial.md
  • 品牌API:oms-openapi-brand.md

Guidelines

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