即时库存查询接口 ​

1. 获取耗材即时库存列表 ​

请求地址 ​

text
GET /consumable/stock

请求示例 ​

text
/consumable/stock?skip=0&take=20&include=total&InStock=1&IncludeDetail=1

参数说明 ​

耗材即时库存查询接口支持丰富的条件过滤参数，请参见支持的查询参数附录 ​

返回结果 ​

json
{
    "offset": 0,
    "total": 0,
    "results": [
        {
            "stockQuantity": 12.00,
            "warehouseName": "北京仓",
            "warehouseCode": "1001",
            "stockPrice": 3.00,
            "stockAmount": 36.0000,
            "disabled": false,
            "remark": "消耗快",
            "createdTime": "1601024239",
            "createdByName": "shangde@123.com",
            "id": 120972,
            "code": "26886859",
            "name": "牛奶",
            "barcode": "26886859",
            "logo": "蒙牛",
            "specification": "275ml",
            "measureUnit": "盒",
            "safeStockUpperLimit": 500,
            "safeStockLowerLimit": 0,
            "picturePath": "/MediaResources/4506/Consumable/20200925/f5226f30f22143d8895fcffe42eca229.jpg",
            "thumbnailPath": "/MediaResources/4506/Consumable/20200925/db8e3714f51b4e0fb85396b1be7a82a3.jpg",
            "categoryName": "二级分类",
            "categoryCode": "10010",
            "unitPrice": 3.00
        }
    ],
    "meta": {}
}
参数说明
offset当前结果对于首条结果的偏移量，指定分页查询时不为0
total所有符合查询条件的查询结果数量，指定需要结果记录数量时不为0
results符合查询条件的耗材即时库存详情集合
meta其他信息

2. 根据物品code获取物品详细信息(批次) ​

请求地址 ​

text
POST /consumable/stock/batchNo

请求示例 ​

json
{
    "Codes":
        [
            "26886859"
        ]
}

参数说明 ​

参数是否必须说明
Codes是要获取详情的物品编码合集

返回结果 ​

json
{
    "offset": 0,
    "total": 0,
    "results": [
        {
            "batchNo": "20093001",
            "id": 120972,
            "code": "26886859",
            "name": "牛奶",
            "barcode": "26886859",
            "logo": "蒙牛",
            "specification": "275ml",
            "measureUnit": "盒",
            "safeStockUpperLimit": 500,
            "safeStockLowerLimit": 0,
            "picturePath": "/MediaResources/4506/Consumable/20200925/f5226f30f22143d8895fcffe42eca229.jpg",
            "thumbnailPath": "/MediaResources/4506/Consumable/20200925/db8e3714f51b4e0fb85396b1be7a82a3.jpg",
            "categoryName": "二级分类",
            "categoryCode": "10010",
            "unitPrice": 3.00
        }
    ]
}
参数说明
offset当前结果对于首条结果的偏移量，指定分页查询时不为0
total所有符合查询条件的查询结果数量，指定需要结果记录数量时不为0
results符合查询条件的物品详情集合

附录 ​

1. 支持的查询参数 ​

如无特别说明，下列操作对于查询实体对象中的任意属性均适用。使用时只需将其追加至请求的querystring中即可。对实体对象中不存在的属性进行操作将会得到不可预期的结果。

分页

skip={数字} 跳过指定条数的记录数

take={数字} 取出指定条数的记录数（注：最大值为1500，即单页最多返回1500条数据）

include=total 需要返回记录总数

排序

orderBy=[-]{属性名称},[-]{属性名称} 返回结果按指定属性排序，在名称前加”-“表示按倒序排序。多个属性的排序可使用逗号分隔。如：orderBy=-Id,Name,-Age

条件过滤

不等于

{属性名称}!={值} 如：Id!=1

大于等于

>{属性名称}={值} 如：>Id=1

大于

{属性名称}>={值} 如：Id>=1

小于

<{属性名称}={值} 如：<Id=1

小于等于

{属性名称}<={值} 如：Id<=1

In

{属性名称}In={值，值，值} 属性的值需包含在指定的集合中，如：IdIn=1,2,3

Between

{属性名称}Between={值，值} 属性的值需处于指定的区间之间，仅支持数字，如： IdBetween=1,3

字符串包含指定字符

{属性名称}Contains={值} 如：nameContains=abc

字符串以指定字符开头

{属性名称}StartsWith={值} 如：nameStartsWith=abc

字符串以指定字符结尾

{属性名称}EndsWith={值} 如：nameEndsWith=abc

2. 数据实体格式 ​

1. 耗材即时库存数据对象格式 ​

属性名称说明
stockQuantity数量
warehouseName仓库名称
warehouseCode仓库编码
stockPrice单价
stockAmount金额
disabled是否被禁用
remark备注
createdTime创建时间（时间戳格式）
createdByName创建人
id物品id
code物品编码
name物品名称
barcode商品码
logo品牌商标
specification规格型号
measureUnit计量单位
safeStockUpperLimit安全库存上限
safeStockLowerLimit安全库存下限
picturePath物品图片路径
thumbnailPath物品缩略图路径
categoryName耗材分类名称
categoryCode耗材分类编码
unitPrice默认单价
dataJson物品扩展字段字符串合集

2. 物品数据对象格式 ​

属性名称说明
batchNo批次号
id物品id
code物品编码
name物品名称
barcode商品码
logo品牌商标
specification规格型号
measureUnit计量单位
safeStockUpperLimit安全库存上限
safeStockLowerLimit安全库存下限
picturePath物品图片路径
thumbnailPath物品图片的缩略图路径
categoryName耗材分类名称
categoryCode耗材分类编码
unitPrice默认单价