Appearance
查询库存列表
接口
/stock/selectForPage
公共参数
| 参数名称 | 参数类型 | 是否必须 | 示例值 | 参数描述 |
|---|---|---|---|---|
| name | String | 是 | stock.selectForPage | 调用的 API 接口名称 |
| appKey | String | 是 | 2w42E9JBF8hBSg3m4MmzqQ | 应用创建完成后被分配的 key |
| timestamp | String | 是 | 1742621225 | 时间戳，格式为 10 位时间戳，时区为 GMT+8 |
| version | String | 是 | 1 | API 协议版本 |
| data | String | 是 | %7b%22appKey%22%3a%22... | 标准 json 类型经 URL 编码，里面是业务参数。 |
| sign | String | 是 | 480F2F3CEC131AB0209D3C76BE1CF4B0 | 输入参数签名结果 |
| accessToken | String | 是 | eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... | 访问令牌 |
业务参数
| 参数名称 | 参数类型 | 是否必须 | 示例值 | 参数描述 |
|---|---|---|---|---|
| pageNo | Integer | 是 | 1 | 当前页码，从 1 开始 |
| pageSize | Integer | 是 | 10 | 每页显示的数据条数 |
| startTime | String | 否 | 2024-01-01 00:00:00 | 开始时间(最后更新时间) |
| endTime | String | 否 | 2024-01-31 23:59:59 | 结束时间(最后更新时间) |
| specNos | Array | 否 | ["SP001","SP002"] | 商家编码列表 |
| warehouseNo | String | 否 | WH001 | 仓库编号 |
| mask | Integer | 否 | 1 | 掩码：1: 返回销量统计数据; 2: 返回成本价数据; 3:返回销售统计数据和成本价数据，默认为 0 |
响应参数
| 参数名称 | 参数类型 | 是否必须 | 示例值 | 参数描述 |
|---|---|---|---|---|
| success | Boolean | 是 | TRUE | 表示操作是否成功 |
| message | String | 是 | 操作成功！ | 操作的结果提示信息 |
| code | Integer | 是 | 200 | 返回码，通常 200 表示成功 |
| result | Object | 是 | 库存查询结果集 | |
| timestamp | Integer | 是 | 1741780391747 | 响应生成的时间戳，单位为毫秒 |
result 对象
| 参数名称 | 参数类型 | 是否必须 | 示例值 | 参数描述 |
|---|---|---|---|---|
| totalCount | Long | 是 | 100 | 总条数 |
| detailList | Array | 是 | 库存详细信息列表 |
detailList 内对象
| 参数名称 | 参数类型 | 是否必须 | 示例值 | 参数描述 |
|---|---|---|---|---|
| recId | Integer | 是 | 1 | 明细唯一键 |
| defect | Boolean | 否 | false | 残次品，false:正品; true:残品 |
| stockNum | Double | 是 | 100.0 | 库存量 |
| wmsSyncStock | Double | 否 | 95.0 | 外部 WMS 同步时库存 |
| wmsStockDiff | Double | 否 | 5.0 | 外部 WMS 同步时,与系统库存的差 |
| specNo | String | 是 | SP001 | 商家编码 |
| specId | Integer | 是 | 123 | 单品唯一键 |
| goodsNo | String | 是 | GD001 | 货品编号 |
| goodsName | String | 是 | 测试商品 | 货品名称 |
| specCode | String | 是 | SPEC001 | 规格码 |
| brandName | String | 否 | 测试品牌 | 品牌名称 |
| specName | String | 是 | 红色 M 码 | 规格名称 |
| barcode | String | 否 | 123456789 | 条码 |
| unpayNum | Double | 否 | 10.0 | 未付款量 |
| subscribeNum | Double | 否 | 5.0 | 预订单量 |
| orderNum | Double | 否 | 3.0 | 待审核量 |
| sendingNum | Double | 否 | 8.0 | 待发货量 |
| purchaseNum | Double | 否 | 20.0 | 采购在途量 |
| transferNum | Double | 否 | 15.0 | 调拨在途量 |
| toPurchaseNum | Double | 否 | 7.0 | 待采购量 |
| purchaseArriveNum | Double | 否 | 12.0 | 采购到货量 |
| wmsPreemptyStock | Double | 否 | 2.0 | 外部 WMS 同步时占用库存 |
| weight | Double | 否 | 0.5 | 重量 |
| imgUrl | String | 否 | http://example.com/image.jpg | 图片 URL |
| warehouseNo | String | 是 | WH001 | 仓库编号 |
| warehouseId | Integer | 是 | 1 | 仓库 id，仓库唯一键 |
| warehouseName | String | 是 | 主仓库 | 仓库名称 |
| warehouseType | Integer | 是 | 0 | 仓库类型，0 为普通,非 0 为外部 WMS |
| availableSendStock | Double | 是 | 90.0 | 可发库存 |
| created | String | 是 | 2024-01-01 10:00:00 | 创建时间 |
| modified | String | 是 | 2024-01-31 15:30:00 | 修改时间 |
| partPaidNum | Double | 否 | 1.0 | 部分付款库存 |
| refundExchNum | Double | 否 | 2.0 | 销售换货在途量(卖家发给买家) |
| refundNum | Double | 否 | 3.0 | 销售退货量 |
| refundOnwayNum | Double | 否 | 1.0 | 销售换货在途量(从买家回到卖家) |
| returnExchNum | Double | 否 | 0.0 | 采购换货量 |
| returnNum | Double | 否 | 0.0 | 采购退货量 |
| returnOnwayNum | Double | 否 | 0.0 | 采购换货在途量 |
| toTransferNum | Double | 否 | 5.0 | 待调出量 |
| wmsPreemptyDiff | Double | 否 | 1.0 | 外部 WMS 同步时,占用库存差 |
| wmsSyncTime | String | 否 | 2024-01-31 12:00:00 | 与外部 wms 同步时间 |
| remark | String | 否 | 备注信息 | 单品在当前仓库记录的备注 |
| lockNum | Double | 否 | 4.0 | 库存锁定量 |
| flagId | Integer | 否 | 1 | 标记 id |
| flagName | String | 否 | 标记名称 | 标记名称 |
| brandNo | String | 否 | BR001 | 品牌编号 |
| toOtherOutNum | Double | 否 | 0.0 | 其他待出库量 |
| toOtherInNum | Double | 否 | 0.0 | 其他待入库量 |
| toProcessOutNum | Double | 否 | 0.0 | 生产待出库量 |
| toProcessInNum | Double | 否 | 0.0 | 生产待入库量 |
| waitTransferNum | Double | 否 | 2.0 | 待调拨量 |
| lastPdTime | String | 否 | 2024-01-15 10:00:00 | 上次盘点时间 |
| lastInoutTime | String | 否 | 2024-01-30 14:30:00 | 上次出入库时间 |
| sysUserDefineStock1 | Double | 否 | 0.0 | 自定义库存 1 |
| sysUserDefineStock2 | Double | 否 | 0.0 | 自定义库存 2 |
| sysUserDefineStock3 | Double | 否 | 0.0 | 自定义库存 3 |
| sysUserDefineStock4 | Double | 否 | 0.0 | 自定义库存 4 |
| sysUserDefineStock5 | Double | 否 | 0.0 | 自定义库存 5 |
| sysUserDefineStock6 | Double | 否 | 0.0 | 自定义库存 6 |
| sysUserDefineStock7 | Double | 否 | 0.0 | 自定义库存 7 |
| sysUserDefineStock8 | Double | 否 | 0.0 | 自定义库存 8 |
| sysUserDefineStock9 | Double | 否 | 0.0 | 自定义库存 9 |
| sysUserDefineStock10 | Double | 否 | 0.0 | 自定义库存 10 |
| sysUserDefineStock11 | Double | 否 | 0.0 | 自定义库存 11 |
| sysUserDefineStock12 | Double | 否 | 0.0 | 自定义库存 12 |
| sysUserDefineStock13 | Double | 否 | 0.0 | 自定义库存 13 |
| sysUserDefineStock14 | Double | 否 | 0.0 | 自定义库存 14 |
| sysUserDefineStock15 | Double | 否 | 0.0 | 自定义库存 15 |
| sysUserDefineStock16 | Double | 否 | 0.0 | 自定义库存 16 |
| sysUserDefineStock17 | Double | 否 | 0.0 | 自定义库存 17 |
| sysUserDefineStock18 | Double | 否 | 0.0 | 自定义库存 18 |
| sysUserDefineStock19 | Double | 否 | 0.0 | 自定义库存 19 |
| sysUserDefineStock20 | Double | 否 | 0.0 | 自定义库存 20 |
| costPrice | Double | 否 | 10.50 | 成本价(当 mask 包含 2 或 3 时返回) |
| sales7Days | Double | 否 | 50.0 | 7 天销量(当 mask 包含 1 或 3 时返回) |
| sales15Days | Double | 否 | 100.0 | 15 天销量(当 mask 包含 1 或 3 时返回) |
| sales30Days | Double | 否 | 200.0 | 30 天销量(当 mask 包含 1 或 3 时返回) |
| sales60Days | Double | 否 | 400.0 | 60 天销量(当 mask 包含 1 或 3 时返回) |
| sales90Days | Double | 否 | 600.0 | 90 天销量(当 mask 包含 1 或 3 时返回) |
| sales180Days | Double | 否 | 1200.0 | 180 天销量(当 mask 包含 1 或 3 时返回) |
| sales365Days | Double | 否 | 2400.0 | 365 天销量(当 mask 包含 1 或 3 时返回) |
请求示例
在线调试
API 调试工具GET/POST
响应示例
json
{
"name": "stock.selectForPage",
"appKey": "2w42E9JBF8hBSg3m4MmzqQ",
"timestamp": "1742621225",
"version": "1",
"message": "操作成功！",
"code": 200,
"result": {
"totalCount": 100,
"detailList": [
{
"recId": 1,
"defect": false,
"stockNum": 100.0,
"wmsSyncStock": 95.0,
"wmsStockDiff": 5.0,
"specNo": "SP001",
"specId": 123,
"goodsNo": "GD001",
"goodsName": "测试商品",
"specCode": "SPEC001",
"brandName": "测试品牌",
"specName": "红色M码",
"barcode": "123456789",
"unpayNum": 10.0,
"subscribeNum": 5.0,
"orderNum": 3.0,
"sendingNum": 8.0,
"purchaseNum": 20.0,
"transferNum": 15.0,
"toPurchaseNum": 7.0,
"purchaseArriveNum": 12.0,
"wmsPreemptyStock": 2.0,
"weight": 0.5,
"imgUrl": "http://example.com/image.jpg",
"warehouseNo": "WH001",
"warehouseId": 1,
"warehouseName": "主仓库",
"warehouseType": 0,
"availableSendStock": 90.0,
"created": "2024-01-01 10:00:00",
"modified": "2024-01-31 15:30:00",
"partPaidNum": 1.0,
"refundExchNum": 2.0,
"refundNum": 3.0,
"refundOnwayNum": 1.0,
"returnExchNum": 0.0,
"returnNum": 0.0,
"returnOnwayNum": 0.0,
"toTransferNum": 5.0,
"wmsPreemptyDiff": 1.0,
"wmsSyncTime": "2024-01-31 12:00:00",
"remark": "备注信息",
"lockNum": 4.0,
"flagId": 1,
"flagName": "标记名称",
"brandNo": "BR001",
"toOtherOutNum": 0.0,
"toOtherInNum": 0.0,
"toProcessOutNum": 0.0,
"toProcessInNum": 0.0,
"waitTransferNum": 2.0,
"lastPdTime": "2024-01-15 10:00:00",
"lastInoutTime": "2024-01-30 14:30:00",
"sysUserDefineStock1": 0.0,
"sysUserDefineStock2": 0.0,
"sysUserDefineStock3": 0.0,
"sysUserDefineStock4": 0.0,
"sysUserDefineStock5": 0.0,
"sysUserDefineStock6": 0.0,
"sysUserDefineStock7": 0.0,
"sysUserDefineStock8": 0.0,
"sysUserDefineStock9": 0.0,
"sysUserDefineStock10": 0.0,
"sysUserDefineStock11": 0.0,
"sysUserDefineStock12": 0.0,
"sysUserDefineStock13": 0.0,
"sysUserDefineStock14": 0.0,
"sysUserDefineStock15": 0.0,
"sysUserDefineStock16": 0.0,
"sysUserDefineStock17": 0.0,
"sysUserDefineStock18": 0.0,
"sysUserDefineStock19": 0.0,
"sysUserDefineStock20": 0.0,
"costPrice": 10.5,
"sales7Days": 50.0,
"sales15Days": 100.0,
"sales30Days": 200.0,
"sales60Days": 400.0,
"sales90Days": 600.0,
"sales180Days": 1200.0,
"sales365Days": 2400.0
}
]
},
"timestamp": 1741780916923
}