# Get Inventory By List

Get a list of inventory items with optional filters (outlet, category, quantity, tags).
Requires the "VIEW" role in the "Inventory" group.

Endpoint: GET /api/v3/Inventory
Version: 3.1.0
Security: OAuth2_clientCredentials

## Query parameters:

  - `PageNumber` (integer, required)
    The page number of the product
    Example: 1

  - `PageSize` (integer, required)
    The page size of the product list
    Example: 500

  - `ListOutletID` (array)
    Guid outlet ID array. if not send the request, it will get from OutletName list
    Example: "3558dc76-3e32-49c4-84dd-0b3f76f02570,a5f5b2e1-2d3c-4e8f-9f4d-1c2b3a4d5e6f"

  - `ListOutlet` (array)
    List of outlet name array. if not send the request, it will get from OutletID list
    Example: "Outlet1,Outlet2"

  - `Category` (string)
    The product category
    Example: "Top"

  - `QuantityFrom` (integer)
    The minimum quantity of the product that users want to view
    Example: 1

  - `Discontinued` (boolean)
    The product discontinued status

  - `Tags` (string)
    The product tags
    Example: "Summer"

## Response 200 fields (application/json):

  - `Category` (string)
    Name of product category

  - `Product` (string)
    Name of product

  - `Variant` (string)
    The variant name

  - `Code` (string)
    The variant code

  - `I` (object)
    Inventory for the variant

  - `I.OnHand` (number)
    On Hand Quantity

  - `I.Allocated` (integer)
    Allocated Quantity

  - `I.Available` (number)
    Available Quantity

  - `I.Threshold` (integer)
    Maximum Stock

  - `I.Buffer` (integer)
    Minimum Stock


## Response 500 fields