Skip to content

OMS OpenAPI 销售物料管理接口

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

接口概述

销售物料管理API用于管理系统中的销售物料信息,支持查询、添加和修改销售物料功能。销售物料包括普通类型、组合类型、赠品类型、福袋类型和多选一类型等多种类型。

接口列表

接口名方法功能描述
salesmaterial.getListPOST批量获取指定条件下的销售单物料明细列表
salesmaterial.getBySalesBnPOST根据销售单号获取物料明细

系统级参数

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

接口详细说明

salesmaterial.getList - 批量获取指定条件下的销售单物料明细列表

功能描述

批量获取指定条件下的销售单物料明细列表,支持按时间范围、店铺编号、销售单号、物料编号等条件进行筛选。

请求参数

参数名类型必填描述
start_timestring创建时间开始(格式:yyyy-MM-dd HH:mm:ss)
end_timestring创建时间结束(格式:yyyy-MM-dd HH:mm:ss)
page_noint页码,默认 1
page_sizeint每页条数,默认 50,最大 1000
shop_bnstring店铺编号
sales_bnstring销售单号
material_bnstring物料编号

响应参数

参数名类型描述
countint总记录数
listsarray销售单物料明细列表

salesmaterial.getBySalesBn - 根据销售单号获取物料明细

功能描述

根据销售单号获取物料明细,获取指定销售单的所有物料明细信息。

请求参数

参数名类型必填描述
sales_bnstring销售单号

响应参数

参数名类型描述
sales_bnstring销售单号
listsarray物料明细列表

错误处理

系统级错误码请参考: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-sales.md
  • 基础物料API:oms-openapi-basicmaterial.md

Guidelines

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