---
title: "getCurrentInventoryByPage"
method: GET
path: "/inventory/currentinventory/v1/getCurrentInventoryByPage"
tags: ["Inventory Service"]
---

# getCurrentInventoryByPage

`GET /inventory/currentinventory/v1/getCurrentInventoryByPage`

Retrieve the current inventory for a product or subset of products.

## Query parameters

- `locationCode` string
- `productNumber` string
- `lotNumber` string
- `summarizeByProduct` boolean
- `categoryName` string
- `subcategoryName` string
- `microcategoryName` string
- `pageNumber` integer
- `pageSize` integer
- `includeNull` boolean

## Headers

- `authenticationtoken` string, required
- `password` string, required
- `sitename` string, required
- `userid` string, required
- `X-B3-TraceId` string

## Response `200`

Success

- CurrentInventoryBatchResponseDto — CurrentInventoryBatchResponseDto description
  - `hasNext` boolean
  - `currentInventoryDetails` CurrentInventoryDetails[]
    - `currentInventoryDetailDetails` CurrentInventoryDetailsDto[]
      - `locationCode` string — Code for the Location.
      - `locationName` string — Name for the Location.
      - `storageName` string — Storage Name for the storage location.
      - `storageCode` string — Storage Code for the storage location.
      - `productName` string — Name for the product in inventory.
      - `productNumber` string — Number for the product in inventory.
      - `lotNumber` string — The Lot Number associated with the product in inventory.
      - `categoryName` string — The category name assigned to the product.
      - `subcategoryName` string — The subcategory name assigned to the product.
      - `microcategoryName` string — The microcategory name assigned to the product.
      - `glCode` string — General Ledger Code associated with the product's category.
      - `glDescription` string — General Ledger Description associated with the product's category.
      - `inventoryUnit` string — Inventory Unit for the product in inventory.
      - `unitPrice` number — Unit Price for the product in inventory.
      - `onHandQuantity` number — On Hand Quantity for the product in inventory.
      - `onHandValue` number — On Hand Value for the product in inventory.
      - `inTransitQuantity` number — In Transit Quantity for the product in inventory.
      - `inTransitValue` number — In Transit Value for the product in inventory.
      - `totalQuantity` number — Total Quantity for the product in inventory.
      - `totalValue` number — Total Value for the product in inventory.
      - `customerOrderQuantity` number — Customer Order Quantity for the product in inventory.
      - `vendorOrderQuantity` number — Vendor Order Quantity for the product in inventory.
  - `totalPages` integer

## Other responses

- `400` — Validation Error
- `401` — Authorization
- `404` — Current inventory not found
- `429` — Too Many Requests
- `500` — Unexpected Error
- `503` — System under maintenance
- `504` — Timeout

---

[API](https://skmtc.dev/crunchtime/apis/inventory-labor.md) · [All operations](https://skmtc.dev/crunchtime/apis/inventory-labor/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/crunchtime/inventory-labor/revisions/0af8e380ff2c/schema)