# Get inventory information

This operation provides inventory information with warehouse, status, quantity on hand, quantity reserved on orders, quantity on backorder, quantity available, and quantity on an inbound PO. This operation optionally accepts a warehouse code to return related inventory records for a specific Wineshipping warehouse, if omitted the operation will return inventory records for all warehouses. The operation also accepts an array of items to query inventory records, if omitted returns inventory records for all items in the warehouse specified.

Endpoint: POST /api/Inventory/GetStatus
Version: 3.1.3
Security: Authentication

## Request fields (application/json):

  - `Authentication` (object, required)
    Credentials are required for all API operations.

  - `Authentication.UserKey` (string, required)
    Example: "C445598CB576468EA35FBB22C55584EF"

  - `Authentication.Password` (string, required)
    Example: "AF63FDAC1E704DC1AC9460F669ABF107"

  - `Authentication.CustomerNo` (string, required)
    Example: "10703"

  - `Warehouse` (string)
    See [warehouse locations](../../../../docs/codes/warehouselocations) for possible values.
    Enum: "APC01", "APC02", "COB01", "COB02", "ETC01", "MMC01", "PRB02", "PRB04", "SJU01", "TWL01", "VCX01", "WOX01"

  - `ItemNumbers` (array)
    Up to five items are allowed. If omitted, all items in the specified warehouse are included in the results.

  - `InventoryStatuses` (array)
    Up to five inventory status codes are allowed. If omitted, all inventory statuses are included in the results. The following are generic status codes. If you have a custom Wineshipping inventory type, please work with IT to get the inventory codes. See [inventory codes](../../../../docs/codes/inventorycodes) for possible values.
    Enum: "GOOD-NO-TX", "RTGD-NO-TX", "RDMG-NO-TX", "CDMG-NO-TX", "DMGD-NO-TX", "GOOD-NO-BD", "DMGD-ST-BD", "GOOD-ST-IM"

  - `IncludeTotalRecordCount` (boolean)
    Indicates whether to query the total record count.

  - `Skip` (integer)
    Start returning results after skipping the specified number of records. The default is zero. This identifies a subset of the results defined by the input filter. The subset is defined by skipping N results and selecting only the remaining results (starting with N+1), where N is an integer greater than or equal to zero.

  - `Top` (integer)
    Limit the number of results to the specified value; the default is 2500. Any value outside the range of 0 to 2500 is set to 2500.
Identifies a subset of the results based on the input filter by selecting only the first N results, where N is an integer greater than or equal to zero.

  - `IncludeUnavailableItems` (boolean)
    When true, the response includes items (products) with no physical inventory. By default, only items with non-zero physical inventory are returned.

## Response 200 fields (application/json):

  - `TotalRecordCount` (integer)

  - `Skip` (integer)

  - `Top` (integer)

  - `MoreRecords` (boolean)

  - `WarehouseInventoryStatuses` (array)

  - `WarehouseInventoryStatuses.CustomerNo` (string)
    Wineshipping Customer Number
    Example: "10001"

  - `WarehouseInventoryStatuses.CustomerName` (string)
    Wineshipping Customer Name
    Example: "DtC Wine Estates"

  - `WarehouseInventoryStatuses.ItemNo` (string)
    Product SKU

  - `WarehouseInventoryStatuses.ItemDescription` (string)
    Product description

  - `WarehouseInventoryStatuses.ItemUnit` (string)
    Unit of measure
    Example: "750"

  - `WarehouseInventoryStatuses.InventoryWarehouse` (string)
    See [warehouse locations](../../../../docs/codes/warehouselocations) for possible values.
    Enum: "APC01", "APC02", "COB01", "COB02", "ETC01", "MMC01", "PRB02", "PRB04", "SJU01", "TWL01", "VCX01", "WOX01"

  - `WarehouseInventoryStatuses.InventoryStatus` (string)
    See [inventory codes](../../../../docs/codes/inventorycodes) for possible values. Array of up to 5 items is allowed, and if omitted, all items will be included in the results.
    Enum: "GOOD-NO-TX", "RTGD-NO-TX", "RDMG-NO-TX", "CDMG-NO-TX", "DMGD-NO-TX", "GOOD-NO-BD", "DMGD-ST-BD", "GOOD-ST-IM"

  - `WarehouseInventoryStatuses.OnHandQuantity` (integer)
    Total quantity physically available in the warehouse
    Example: 1000

  - `WarehouseInventoryStatuses.ReservedQuantity` (integer)
    Total quantity reserved for orders being processed (inventory reserved based on time order is received)
    Example: 50

  - `WarehouseInventoryStatuses.AvailableQuantity` (integer)
    Quantity on hand less reserved
    Example: 950

  - `WarehouseInventoryStatuses.BackOrderQuantity` (integer)
    Quantity unavailable for orders being processed

  - `WarehouseInventoryStatuses.OpenPOQuantity` (integer)
    Quantity outstanding on open purchase orders not yet received, and not available
    Example: 100

  - `WarehouseInventoryStatuses.TranferQuantity` (integer)

  - `WarehouseInventoryStatuses.IncomingAvailable` (integer)
    The amount of incoming inventory that can be pre-reserved for new orders
    Example: 950

  - `WarehouseInventoryStatuses.IncomingPreReserved` (integer)
    The number of items on open orders reserved against incoming purchase orders that will be fulfilled once they arrive at the warehouse.

  - `WarehouseInventoryStatuses.Oversold` (integer)
    Oversold is the number of items on open orders that cannot be fulfilled based on current and incoming inventory.


## Response 400 fields

## Response 401 fields

## Response 429 fields

## Response 500 fields