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

Retrieve a product by its ID (SKU)

Request Information

ParameterDescriptionAdditional information
text 
The SKU of the product

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-05-05T17:06:36.4836634-06:00",
  "WebAvailableEnd": "2025-05-05T17:06:36.4836634-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: 
<InventoryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDS.Web.WebApi.Models">
  <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>650cf4f2-e523-465f-9c5a-70d85d89fa91</PickListID>
      <Required>true</Required>
    </InventoryModel.ProductAttribute>
    <InventoryModel.ProductAttribute>
      <DataType>sample string 3</DataType>
      <DisplayOrder>2</DisplayOrder>
      <Name>sample string 1</Name>
      <PickListID>650cf4f2-e523-465f-9c5a-70d85d89fa91</PickListID>
      <Required>true</Required>
    </InventoryModel.ProductAttribute>
    <InventoryModel.ProductAttribute>
      <DataType>sample string 3</DataType>
      <DisplayOrder>2</DisplayOrder>
      <Name>sample string 1</Name>
      <PickListID>650cf4f2-e523-465f-9c5a-70d85d89fa91</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>1249ee01-8271-453d-9457-0fe4cb2e8701</DefaultFundID>
  <Enclosure>true</Enclosure>
  <FMV>1</FMV>
  <Featured>true</Featured>
  <ForSale>true</ForSale>
  <ForSaleOnWeb>true</ForSaleOnWeb>
  <FullDescription>sample string 8</FullDescription>
  <ID>078fdf99-27c6-4bef-9809-11b940e04b74</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>a50165ee-c834-4252-8563-10297402e29d</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-05-05T17:06:36.4836634-06:00</WebAvailableEnd>
  <WebAvailableStart>2025-05-05T17:06:36.4836634-06:00</WebAvailableStart>
  <WebDonationFund>sample string 14</WebDonationFund>
  <WebDonationFundID>75ef9fc5-f100-4855-a6e3-9fe8b6aca695</WebDonationFundID>
  <WebFreeWithDonation>true</WebFreeWithDonation>
  <WebMaxQuantity>1</WebMaxQuantity>
  <WebMinimumDonation>1</WebMinimumDonation>
  <WebPrice>1</WebPrice>
  <Weight>1</Weight>
</InventoryModel>