GET warehouses/{warehouseID}/inventory-report?PageSize={PageSize}&Page={Page}

Returns all products within a warehouse and their current inventory. Max page size 10000

Request Information

URI Parameters

NameDescriptionTypeAdditional information
warehouseID ID of the Warehouse integer Required
PageSize This is an optional parameter. This will default to 100. The max page size is 10000 integer Range: inclusive between 1 and 10000
Page This is an optional parameter. It will default to page 1. integer Matching regular expression pattern: ^[1-9]\d*$

Body Parameters

None.

Response Information

Resource Description

Returns all products within a warehouse and their current inventory. Max page size 10000

PagedWarehouseInventoryModel
NameDescriptionTypeAdditional information
TotalItems integer None.
PagingInfo PagingFilter None.
TotalPages integer None.
Data Collection of WarehouseInventoryModel None.

Response Formats

application/json, text/json

Sample:
{
  "TotalItems": 1,
  "PagingInfo": {
    "PageSize": 100,
    "Page": 1
  },
  "TotalPages": 1,
  "Data": [
    {
      "Product": {
        "ProductID": 1,
        "SKU": "SKU 1"
      },
      "TotalInventory": 11,
      "StockLocations": [
        {
          "StockLocation": {
            "StockLocationID": 1,
            "StockLocationReference": "Unspecified"
          },
          "Inventory": 1
        },
        {
          "StockLocation": {
            "StockLocationID": 1,
            "StockLocationReference": "A100"
          },
          "Inventory": 10
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<PagedWarehouseInventoryModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TotalItems>1</TotalItems>
  <PagingInfo>
    <PageSize>100</PageSize>
    <Page>1</Page>
  </PagingInfo>
  <TotalPages>1</TotalPages>
  <Data>
    <WarehouseInventoryModel>
      <Product>
        <ProductID>1</ProductID>
        <SKU>SKU 1</SKU>
      </Product>
      <TotalInventory>11</TotalInventory>
      <StockLocations>
        <WarehouseInventoryStockLocationModel>
          <StockLocation>
            <StockLocationID>1</StockLocationID>
            <StockLocationReference>Unspecified</StockLocationReference>
          </StockLocation>
          <Inventory>1</Inventory>
        </WarehouseInventoryStockLocationModel>
        <WarehouseInventoryStockLocationModel>
          <StockLocation>
            <StockLocationID>1</StockLocationID>
            <StockLocationReference>A100</StockLocationReference>
          </StockLocation>
          <Inventory>10</Inventory>
        </WarehouseInventoryStockLocationModel>
      </StockLocations>
    </WarehouseInventoryModel>
  </Data>
</PagedWarehouseInventoryModel>