Retrieve a list of all inventory items.
PLEASE NOTE: This call has the potential to return many records, so discretion is advised.
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. |
[ { "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": "2024-09-09T12:56:48.4956039-06:00", "WebAvailableEnd": "2024-09-09T12:56:48.4956039-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": "2024-09-09T12:56:48.4956039-06:00", "WebAvailableEnd": "2024-09-09T12:56:48.4956039-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": "2024-09-09T12:56:48.4956039-06:00", "WebAvailableEnd": "2024-09-09T12:56:48.4956039-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 } ] } ]
<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>00b552bf-6ead-4f13-a548-60e3010e722e</PickListID> <Required>true</Required> </InventoryModel.ProductAttribute> <InventoryModel.ProductAttribute> <DataType>sample string 3</DataType> <DisplayOrder>2</DisplayOrder> <Name>sample string 1</Name> <PickListID>00b552bf-6ead-4f13-a548-60e3010e722e</PickListID> <Required>true</Required> </InventoryModel.ProductAttribute> <InventoryModel.ProductAttribute> <DataType>sample string 3</DataType> <DisplayOrder>2</DisplayOrder> <Name>sample string 1</Name> <PickListID>00b552bf-6ead-4f13-a548-60e3010e722e</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>20445a84-93ad-48b1-bb3a-251445e2b89a</DefaultFundID> <Enclosure>true</Enclosure> <FMV>1</FMV> <Featured>true</Featured> <ForSale>true</ForSale> <ForSaleOnWeb>true</ForSaleOnWeb> <FullDescription>sample string 8</FullDescription> <ID>9c25ca48-c9bd-4265-a997-06f945010259</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>c7010b01-8bb0-4fd2-9268-8b5ec4255613</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>2024-09-09T12:56:48.4956039-06:00</WebAvailableEnd> <WebAvailableStart>2024-09-09T12:56:48.4956039-06:00</WebAvailableStart> <WebDonationFund>sample string 14</WebDonationFund> <WebDonationFundID>dd25cbe1-b144-43ff-8f01-c5ba0c8dc19e</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>00b552bf-6ead-4f13-a548-60e3010e722e</PickListID> <Required>true</Required> </InventoryModel.ProductAttribute> <InventoryModel.ProductAttribute> <DataType>sample string 3</DataType> <DisplayOrder>2</DisplayOrder> <Name>sample string 1</Name> <PickListID>00b552bf-6ead-4f13-a548-60e3010e722e</PickListID> <Required>true</Required> </InventoryModel.ProductAttribute> <InventoryModel.ProductAttribute> <DataType>sample string 3</DataType> <DisplayOrder>2</DisplayOrder> <Name>sample string 1</Name> <PickListID>00b552bf-6ead-4f13-a548-60e3010e722e</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>20445a84-93ad-48b1-bb3a-251445e2b89a</DefaultFundID> <Enclosure>true</Enclosure> <FMV>1</FMV> <Featured>true</Featured> <ForSale>true</ForSale> <ForSaleOnWeb>true</ForSaleOnWeb> <FullDescription>sample string 8</FullDescription> <ID>9c25ca48-c9bd-4265-a997-06f945010259</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>c7010b01-8bb0-4fd2-9268-8b5ec4255613</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>2024-09-09T12:56:48.4956039-06:00</WebAvailableEnd> <WebAvailableStart>2024-09-09T12:56:48.4956039-06:00</WebAvailableStart> <WebDonationFund>sample string 14</WebDonationFund> <WebDonationFundID>dd25cbe1-b144-43ff-8f01-c5ba0c8dc19e</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>00b552bf-6ead-4f13-a548-60e3010e722e</PickListID> <Required>true</Required> </InventoryModel.ProductAttribute> <InventoryModel.ProductAttribute> <DataType>sample string 3</DataType> <DisplayOrder>2</DisplayOrder> <Name>sample string 1</Name> <PickListID>00b552bf-6ead-4f13-a548-60e3010e722e</PickListID> <Required>true</Required> </InventoryModel.ProductAttribute> <InventoryModel.ProductAttribute> <DataType>sample string 3</DataType> <DisplayOrder>2</DisplayOrder> <Name>sample string 1</Name> <PickListID>00b552bf-6ead-4f13-a548-60e3010e722e</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>20445a84-93ad-48b1-bb3a-251445e2b89a</DefaultFundID> <Enclosure>true</Enclosure> <FMV>1</FMV> <Featured>true</Featured> <ForSale>true</ForSale> <ForSaleOnWeb>true</ForSaleOnWeb> <FullDescription>sample string 8</FullDescription> <ID>9c25ca48-c9bd-4265-a997-06f945010259</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>c7010b01-8bb0-4fd2-9268-8b5ec4255613</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>2024-09-09T12:56:48.4956039-06:00</WebAvailableEnd> <WebAvailableStart>2024-09-09T12:56:48.4956039-06:00</WebAvailableStart> <WebDonationFund>sample string 14</WebDonationFund> <WebDonationFundID>dd25cbe1-b144-43ff-8f01-c5ba0c8dc19e</WebDonationFundID> <WebFreeWithDonation>true</WebFreeWithDonation> <WebMaxQuantity>1</WebMaxQuantity> <WebMinimumDonation>1</WebMinimumDonation> <WebPrice>1</WebPrice> <Weight>1</Weight> </InventoryModel> </ArrayOfInventoryModel>