# Get inventory levels (for stocked items)

Endpoint: GET /inventoryLevels
Security: BearerAuth

## Query parameters:

  - `companyId` (string, required)
    The company identifier used to scope the query.

  - `locationId` (string)
    Identifier for the location.

  - `restockLevel` (string)
    Filters items based on their restock threshold status.
  • above — Returns items with quantities above their defined restock level.  
  • below — Returns items with quantities below their defined restock or minimum quantity level.  
  • If omitted, all items are returned.
    Enum: "above", "below"

  - `sort` (string)
    Property to sort by.

  - `sortDirection` (string)
    Sort direction
    Enum: "ASC", "DESC"

  - `size` (integer)
    Number of records per page (max 100).

  - `page` (integer)
    Page number (1-based).

## Response 200 fields (application/json):

  - `itemId` (string)
    Example: "ITEM123"

  - `companyId` (string)
    Example: "SHOP5678"

  - `itemType` (string)
    Example: "tire"

  - `itemNumber` (string)
    Example: "GY12345"

  - `itemName` (string)
    Example: "Goodyear Eagle F1"

  - `itemTitle` (string)

  - `stockDetails` (array)
    Example: [{"locationId":"LOC001","qtyOnHand":20,"qtyAvailable":18,"qtyOnEstimates":2,"qtyInTransit":5,"qtyOrdered":10,"minimumQtyLevel":5,"maximumQtyLevel":20,"stockLocationName":"Warehouse 1 - Aisle 2 - Bin 3"}]

  - `stockDetails.locationId` (string)

  - `stockDetails.qtyOnHand` (number)

  - `stockDetails.qtyAvailable` (number)

  - `stockDetails.qtyOnEstimates` (number)

  - `stockDetails.qtyInTransit` (number)

  - `stockDetails.qtyOrdered` (number)

  - `stockDetails.minimumQtyLevel` (number)

  - `stockDetails.maximumQtyLevel` (number)

  - `stockDetails.stockLocationName` (string)