URI parameters (5)

Include Optional Parameter

* Please contact Aegis Premier Technologies if you have not been assigned your unique {context} parameter.

Headers | Add header

: Delete

Body

Samples:

Status

Headers

Body

GET api/{context}/inventory/All

parameters: ?sku={sku}&warehouse={warehouse}&category={category}&includeChildCategories={includeChildCategories}

Retrieve a list of all inventory items.

PLEASE NOTE: This call has the potential to return many records, so discretion is advised.

Request Information

Parameter	Description	Additional information
sku	Optional SKU of the item to return.	Define this parameter in the request URI.
warehouse	Optional Warehouse to search.	Define this parameter in the request URI.
category	Optional name of Product Category to search.	Define this parameter in the request URI.
includeChildCategories	Optional name of Product Category to search.	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "ProductCategory": "sample string 2",
    "BinLocation": "sample string 3",
    "WarehouseID": "sample string 4",
    "SKU": "sample string 5",
    "Name": "sample string 6",
    "Summary": "sample string 7",
    "FullDescription": "sample string 8",
    "Author": "sample string 9",
    "ForSale": true,
    "Taxable": true,
    "Weight": 1.0,
    "FMV": 1.0,
    "Price": 1.0,
    "MaxStock": 1,
    "ReorderLevel": 1,
    "LeadTime": 1,
    "Notes": "sample string 10",
    "Active": true,
    "OnDemand": true,
    "AllowBackorder": true,
    "ServiceOnly": true,
    "DefaultFund": "sample string 11",
    "IsTicket": true,
    "UPC": "sample string 12",
    "ForSaleOnWeb": true,
    "WebAvailableStart": "2025-10-27T06:44:52.0238963-06:00",
    "WebAvailableEnd": "2025-10-27T06:44:52.0238963-06:00",
    "WebPrice": 1.0,
    "WebMaxQuantity": 1,
    "WebFreeWithDonation": true,
    "WebMinimumDonation": 1.0,
    "WebDonationFund": "sample string 14",
    "Enclosure": true,
    "Featured": true,
    "MaxQuantity": 1,
    "AllowDiscount": true,
    "Version": 1,
    "IgnoreVersion": true,
    "AvailableQty": "sample string 16",
    "Attributes": [
      {
        "Name": "sample string 1",
        "DisplayOrder": 2,
        "DataType": "sample string 3",
        "Required": true
      },
      {
        "Name": "sample string 1",
        "DisplayOrder": 2,
        "DataType": "sample string 3",
        "Required": true
      },
      {
        "Name": "sample string 1",
        "DisplayOrder": 2,
        "DataType": "sample string 3",
        "Required": true
      }
    ]
  },
  {
    "ProductCategory": "sample string 2",
    "BinLocation": "sample string 3",
    "WarehouseID": "sample string 4",
    "SKU": "sample string 5",
    "Name": "sample string 6",
    "Summary": "sample string 7",
    "FullDescription": "sample string 8",
    "Author": "sample string 9",
    "ForSale": true,
    "Taxable": true,
    "Weight": 1.0,
    "FMV": 1.0,
    "Price": 1.0,
    "MaxStock": 1,
    "ReorderLevel": 1,
    "LeadTime": 1,
    "Notes": "sample string 10",
    "Active": true,
    "OnDemand": true,
    "AllowBackorder": true,
    "ServiceOnly": true,
    "DefaultFund": "sample string 11",
    "IsTicket": true,
    "UPC": "sample string 12",
    "ForSaleOnWeb": true,
    "WebAvailableStart": "2025-10-27T06:44:52.0238963-06:00",
    "WebAvailableEnd": "2025-10-27T06:44:52.0238963-06:00",
    "WebPrice": 1.0,
    "WebMaxQuantity": 1,
    "WebFreeWithDonation": true,
    "WebMinimumDonation": 1.0,
    "WebDonationFund": "sample string 14",
    "Enclosure": true,
    "Featured": true,
    "MaxQuantity": 1,
    "AllowDiscount": true,
    "Version": 1,
    "IgnoreVersion": true,
    "AvailableQty": "sample string 16",
    "Attributes": [
      {
        "Name": "sample string 1",
        "DisplayOrder": 2,
        "DataType": "sample string 3",
        "Required": true
      },
      {
        "Name": "sample string 1",
        "DisplayOrder": 2,
        "DataType": "sample string 3",
        "Required": true
      },
      {
        "Name": "sample string 1",
        "DisplayOrder": 2,
        "DataType": "sample string 3",
        "Required": true
      }
    ]
  },
  {
    "ProductCategory": "sample string 2",
    "BinLocation": "sample string 3",
    "WarehouseID": "sample string 4",
    "SKU": "sample string 5",
    "Name": "sample string 6",
    "Summary": "sample string 7",
    "FullDescription": "sample string 8",
    "Author": "sample string 9",
    "ForSale": true,
    "Taxable": true,
    "Weight": 1.0,
    "FMV": 1.0,
    "Price": 1.0,
    "MaxStock": 1,
    "ReorderLevel": 1,
    "LeadTime": 1,
    "Notes": "sample string 10",
    "Active": true,
    "OnDemand": true,
    "AllowBackorder": true,
    "ServiceOnly": true,
    "DefaultFund": "sample string 11",
    "IsTicket": true,
    "UPC": "sample string 12",
    "ForSaleOnWeb": true,
    "WebAvailableStart": "2025-10-27T06:44:52.0238963-06:00",
    "WebAvailableEnd": "2025-10-27T06:44:52.0238963-06:00",
    "WebPrice": 1.0,
    "WebMaxQuantity": 1,
    "WebFreeWithDonation": true,
    "WebMinimumDonation": 1.0,
    "WebDonationFund": "sample string 14",
    "Enclosure": true,
    "Featured": true,
    "MaxQuantity": 1,
    "AllowDiscount": true,
    "Version": 1,
    "IgnoreVersion": true,
    "AvailableQty": "sample string 16",
    "Attributes": [
      {
        "Name": "sample string 1",
        "DisplayOrder": 2,
        "DataType": "sample string 3",
        "Required": true
      },
      {
        "Name": "sample string 1",
        "DisplayOrder": 2,
        "DataType": "sample string 3",
        "Required": true
      },
      {
        "Name": "sample string 1",
        "DisplayOrder": 2,
        "DataType": "sample string 3",
        "Required": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfInventoryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDS.Web.WebApi.Models">
  <InventoryModel>
    <Active>true</Active>
    <AllowBackorder>true</AllowBackorder>
    <AllowDiscount>true</AllowDiscount>
    <Attributes>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>0e667aaa-662b-47c8-b41d-6c959e1cb7ba</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>0e667aaa-662b-47c8-b41d-6c959e1cb7ba</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>0e667aaa-662b-47c8-b41d-6c959e1cb7ba</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
    </Attributes>
    <Author>sample string 9</Author>
    <AvailableQty>sample string 16</AvailableQty>
    <BinLocation>sample string 3</BinLocation>
    <DefaultFund>sample string 11</DefaultFund>
    <DefaultFundID>c753d9e2-a8cc-4870-95b9-0bd8a63ceaed</DefaultFundID>
    <Enclosure>true</Enclosure>
    <FMV>1</FMV>
    <Featured>true</Featured>
    <ForSale>true</ForSale>
    <ForSaleOnWeb>true</ForSaleOnWeb>
    <FullDescription>sample string 8</FullDescription>
    <ID>f87e8e2b-d32d-4a61-93a7-4d693a91c08d</ID>
    <IgnoreVersion>true</IgnoreVersion>
    <IsTicket>true</IsTicket>
    <LeadTime>1</LeadTime>
    <MaxQuantity>1</MaxQuantity>
    <MaxStock>1</MaxStock>
    <Name>sample string 6</Name>
    <Notes>sample string 10</Notes>
    <OnDemand>true</OnDemand>
    <Price>1</Price>
    <ProductCategory>sample string 2</ProductCategory>
    <ProductCategoryID>6789ff14-6133-4378-91d7-cf005e1e484f</ProductCategoryID>
    <ReorderLevel>1</ReorderLevel>
    <SKU>sample string 5</SKU>
    <ServiceOnly>true</ServiceOnly>
    <Summary>sample string 7</Summary>
    <Taxable>true</Taxable>
    <UPC>sample string 12</UPC>
    <Version>1</Version>
    <WarehouseID>sample string 4</WarehouseID>
    <WebAvailableEnd>2025-10-27T06:44:52.0238963-06:00</WebAvailableEnd>
    <WebAvailableStart>2025-10-27T06:44:52.0238963-06:00</WebAvailableStart>
    <WebDonationFund>sample string 14</WebDonationFund>
    <WebDonationFundID>cad9d763-3933-408e-884b-8dd5bd1741c0</WebDonationFundID>
    <WebFreeWithDonation>true</WebFreeWithDonation>
    <WebMaxQuantity>1</WebMaxQuantity>
    <WebMinimumDonation>1</WebMinimumDonation>
    <WebPrice>1</WebPrice>
    <Weight>1</Weight>
  </InventoryModel>
  <InventoryModel>
    <Active>true</Active>
    <AllowBackorder>true</AllowBackorder>
    <AllowDiscount>true</AllowDiscount>
    <Attributes>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>0e667aaa-662b-47c8-b41d-6c959e1cb7ba</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>0e667aaa-662b-47c8-b41d-6c959e1cb7ba</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>0e667aaa-662b-47c8-b41d-6c959e1cb7ba</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
    </Attributes>
    <Author>sample string 9</Author>
    <AvailableQty>sample string 16</AvailableQty>
    <BinLocation>sample string 3</BinLocation>
    <DefaultFund>sample string 11</DefaultFund>
    <DefaultFundID>c753d9e2-a8cc-4870-95b9-0bd8a63ceaed</DefaultFundID>
    <Enclosure>true</Enclosure>
    <FMV>1</FMV>
    <Featured>true</Featured>
    <ForSale>true</ForSale>
    <ForSaleOnWeb>true</ForSaleOnWeb>
    <FullDescription>sample string 8</FullDescription>
    <ID>f87e8e2b-d32d-4a61-93a7-4d693a91c08d</ID>
    <IgnoreVersion>true</IgnoreVersion>
    <IsTicket>true</IsTicket>
    <LeadTime>1</LeadTime>
    <MaxQuantity>1</MaxQuantity>
    <MaxStock>1</MaxStock>
    <Name>sample string 6</Name>
    <Notes>sample string 10</Notes>
    <OnDemand>true</OnDemand>
    <Price>1</Price>
    <ProductCategory>sample string 2</ProductCategory>
    <ProductCategoryID>6789ff14-6133-4378-91d7-cf005e1e484f</ProductCategoryID>
    <ReorderLevel>1</ReorderLevel>
    <SKU>sample string 5</SKU>
    <ServiceOnly>true</ServiceOnly>
    <Summary>sample string 7</Summary>
    <Taxable>true</Taxable>
    <UPC>sample string 12</UPC>
    <Version>1</Version>
    <WarehouseID>sample string 4</WarehouseID>
    <WebAvailableEnd>2025-10-27T06:44:52.0238963-06:00</WebAvailableEnd>
    <WebAvailableStart>2025-10-27T06:44:52.0238963-06:00</WebAvailableStart>
    <WebDonationFund>sample string 14</WebDonationFund>
    <WebDonationFundID>cad9d763-3933-408e-884b-8dd5bd1741c0</WebDonationFundID>
    <WebFreeWithDonation>true</WebFreeWithDonation>
    <WebMaxQuantity>1</WebMaxQuantity>
    <WebMinimumDonation>1</WebMinimumDonation>
    <WebPrice>1</WebPrice>
    <Weight>1</Weight>
  </InventoryModel>
  <InventoryModel>
    <Active>true</Active>
    <AllowBackorder>true</AllowBackorder>
    <AllowDiscount>true</AllowDiscount>
    <Attributes>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>0e667aaa-662b-47c8-b41d-6c959e1cb7ba</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>0e667aaa-662b-47c8-b41d-6c959e1cb7ba</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>0e667aaa-662b-47c8-b41d-6c959e1cb7ba</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
    </Attributes>
    <Author>sample string 9</Author>
    <AvailableQty>sample string 16</AvailableQty>
    <BinLocation>sample string 3</BinLocation>
    <DefaultFund>sample string 11</DefaultFund>
    <DefaultFundID>c753d9e2-a8cc-4870-95b9-0bd8a63ceaed</DefaultFundID>
    <Enclosure>true</Enclosure>
    <FMV>1</FMV>
    <Featured>true</Featured>
    <ForSale>true</ForSale>
    <ForSaleOnWeb>true</ForSaleOnWeb>
    <FullDescription>sample string 8</FullDescription>
    <ID>f87e8e2b-d32d-4a61-93a7-4d693a91c08d</ID>
    <IgnoreVersion>true</IgnoreVersion>
    <IsTicket>true</IsTicket>
    <LeadTime>1</LeadTime>
    <MaxQuantity>1</MaxQuantity>
    <MaxStock>1</MaxStock>
    <Name>sample string 6</Name>
    <Notes>sample string 10</Notes>
    <OnDemand>true</OnDemand>
    <Price>1</Price>
    <ProductCategory>sample string 2</ProductCategory>
    <ProductCategoryID>6789ff14-6133-4378-91d7-cf005e1e484f</ProductCategoryID>
    <ReorderLevel>1</ReorderLevel>
    <SKU>sample string 5</SKU>
    <ServiceOnly>true</ServiceOnly>
    <Summary>sample string 7</Summary>
    <Taxable>true</Taxable>
    <UPC>sample string 12</UPC>
    <Version>1</Version>
    <WarehouseID>sample string 4</WarehouseID>
    <WebAvailableEnd>2025-10-27T06:44:52.0238963-06:00</WebAvailableEnd>
    <WebAvailableStart>2025-10-27T06:44:52.0238963-06:00</WebAvailableStart>
    <WebDonationFund>sample string 14</WebDonationFund>
    <WebDonationFundID>cad9d763-3933-408e-884b-8dd5bd1741c0</WebDonationFundID>
    <WebFreeWithDonation>true</WebFreeWithDonation>
    <WebMaxQuantity>1</WebMaxQuantity>
    <WebMinimumDonation>1</WebMinimumDonation>
    <WebPrice>1</WebPrice>
    <Weight>1</Weight>
  </InventoryModel>
</ArrayOfInventoryModel>