GET api/{context}/inventory/Name/{text}

Retrieve a list of inventory items based on description.

Request Information

ParameterDescriptionAdditional information
text
The Description of the Inventory.

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": "2022-09-28T06:13:51.5916567-06:00",
    "WebAvailableEnd": "2022-09-28T06:13:51.5916567-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": "2022-09-28T06:13:51.5916567-06:00",
    "WebAvailableEnd": "2022-09-28T06:13:51.5916567-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": "2022-09-28T06:13:51.5916567-06:00",
    "WebAvailableEnd": "2022-09-28T06:13:51.5916567-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>b4cc4049-d70e-43c7-9b54-fb316363fe6a</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>b4cc4049-d70e-43c7-9b54-fb316363fe6a</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>b4cc4049-d70e-43c7-9b54-fb316363fe6a</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>3e8ae133-d0e4-4533-985f-173ac03d4391</DefaultFundID>
    <Enclosure>true</Enclosure>
    <FMV>1</FMV>
    <Featured>true</Featured>
    <ForSale>true</ForSale>
    <ForSaleOnWeb>true</ForSaleOnWeb>
    <FullDescription>sample string 8</FullDescription>
    <ID>9e29129f-698b-4a53-86dc-ec9f319b64f2</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>ce79174c-9e30-40f3-9c0b-27c2fac5a12b</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>2022-09-28T06:13:51.5916567-06:00</WebAvailableEnd>
    <WebAvailableStart>2022-09-28T06:13:51.5916567-06:00</WebAvailableStart>
    <WebDonationFund>sample string 14</WebDonationFund>
    <WebDonationFundID>279f47dc-2e88-40a9-b265-ddc415cbbce8</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>b4cc4049-d70e-43c7-9b54-fb316363fe6a</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>b4cc4049-d70e-43c7-9b54-fb316363fe6a</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>b4cc4049-d70e-43c7-9b54-fb316363fe6a</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>3e8ae133-d0e4-4533-985f-173ac03d4391</DefaultFundID>
    <Enclosure>true</Enclosure>
    <FMV>1</FMV>
    <Featured>true</Featured>
    <ForSale>true</ForSale>
    <ForSaleOnWeb>true</ForSaleOnWeb>
    <FullDescription>sample string 8</FullDescription>
    <ID>9e29129f-698b-4a53-86dc-ec9f319b64f2</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>ce79174c-9e30-40f3-9c0b-27c2fac5a12b</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>2022-09-28T06:13:51.5916567-06:00</WebAvailableEnd>
    <WebAvailableStart>2022-09-28T06:13:51.5916567-06:00</WebAvailableStart>
    <WebDonationFund>sample string 14</WebDonationFund>
    <WebDonationFundID>279f47dc-2e88-40a9-b265-ddc415cbbce8</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>b4cc4049-d70e-43c7-9b54-fb316363fe6a</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>b4cc4049-d70e-43c7-9b54-fb316363fe6a</PickListID>
        <Required>true</Required>
      </InventoryModel.ProductAttribute>
      <InventoryModel.ProductAttribute>
        <DataType>sample string 3</DataType>
        <DisplayOrder>2</DisplayOrder>
        <Name>sample string 1</Name>
        <PickListID>b4cc4049-d70e-43c7-9b54-fb316363fe6a</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>3e8ae133-d0e4-4533-985f-173ac03d4391</DefaultFundID>
    <Enclosure>true</Enclosure>
    <FMV>1</FMV>
    <Featured>true</Featured>
    <ForSale>true</ForSale>
    <ForSaleOnWeb>true</ForSaleOnWeb>
    <FullDescription>sample string 8</FullDescription>
    <ID>9e29129f-698b-4a53-86dc-ec9f319b64f2</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>ce79174c-9e30-40f3-9c0b-27c2fac5a12b</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>2022-09-28T06:13:51.5916567-06:00</WebAvailableEnd>
    <WebAvailableStart>2022-09-28T06:13:51.5916567-06:00</WebAvailableStart>
    <WebDonationFund>sample string 14</WebDonationFund>
    <WebDonationFundID>279f47dc-2e88-40a9-b265-ddc415cbbce8</WebDonationFundID>
    <WebFreeWithDonation>true</WebFreeWithDonation>
    <WebMaxQuantity>1</WebMaxQuantity>
    <WebMinimumDonation>1</WebMinimumDonation>
    <WebPrice>1</WebPrice>
    <Weight>1</Weight>
  </InventoryModel>
</ArrayOfInventoryModel>