跳到主要内容

GET 办公物料库存全量列表(下拉)

GET 查询。query 参数:keyword(可选)、category(可选)。

接口编码所需范围后端接口
office.material.inventory.listoffice:readGET /v1/materials/inventory/list(comap-office)

请求参数(query)

本接口的 query 参数由后端查询对象整体展开,接口规格未保留各字段的原始 类型,故类型列统一显示为 string。实际取值语义见「说明」列,按自然类型 传即可(如 "pageNum": 1),服务端会完成转换。

字段类型必填说明
keywordstring——
categorystring——

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "office.material.inventory.list",
"query": {}
}'

响应 data 字段

字段类型必填说明
idstring——
namestring——
categorystring——
specstring——
unitstring——
stockinteger(int32)——
minStockinteger(int32)——
locationstring——
unitCostnumber——
supplierstring——
purchaseChannelstring——
lastInboundDatestring(date-time)——

错误处理​

响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 office:read否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败是
92301请求过于频繁是

除此之外,comap-office 自身的业务校验失败会原样透传其业务码与提示 (如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内, 以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回综合物料搜索