Skip to content

OMS OpenAPI 品牌管理接口

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

接口概述

品牌管理API用于查询系统中的品牌基础信息,支持批量获取品牌数据,可根据品牌编号进行筛选。

接口列表

接口名方法功能描述
brand.getListPOST获取品牌列表
brand.getDetailPOST获取品牌详情

系统级参数

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

接口详细说明

brand.getList - 获取品牌列表

功能描述

获取品牌列表,支持按品牌名称进行模糊匹配筛选。

请求参数

参数名类型必填描述
brand_namestring品牌名称,模糊匹配
page_noint页码,默认1
page_sizeint每页条数,默认50,最大1000

响应参数

参数名类型描述
countint总记录数
listsarray品牌列表

brand.getDetail - 获取品牌详情

功能描述

获取指定品牌的详细信息,包括品牌基本信息、品牌描述等。

请求参数

参数名类型必填描述
brand_idint品牌ID

响应参数

参数名类型描述
brand_idint品牌ID
brand_namestring品牌名称
brand_initialstring品牌首字母
brand_urlstring品牌官网
logostring品牌logo
brand_descstring品牌描述
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-basicmaterial.md

Guidelines

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