GET v1/Inventory/ViewInventory?itemId={itemId}
Retrieves the inventory details for a specific item.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| itemId |
The unique identifier of the item to view in the inventory. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
An containing: - A status code of 200 (OK) and a list of if the inventory is found. - A status code of 400 (Bad Request) if there is an error in the request or a is returned. - A status code of 404 (Not Found) if the inventory is not found. - A status code of 500 (Internal Server Error) if an exception occurs.
Collection of ItemDetailDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemID |
Gets or sets the unique identifier of the item. |
integer |
None. |
| Name |
Gets or sets the name of the item. |
string |
None. |
| Description |
Gets or sets the description of the item. |
string |
None. |
| ItemCode |
Gets or sets the code of the item. |
string |
None. |
| Quantity |
Gets or sets the quantity of the item. |
integer |
None. |
| Comment |
Gets or sets the comment associated with the item. |
string |
None. |
| UserName |
Gets or sets the username of the person associated with the item. |
string |
None. |
| ItemImage |
Gets or sets the list of images associated with the item. |
Collection of ItemImageDTO |
None. |
| CustomerItem |
Gets or sets the list of customer items associated with the item. |
Collection of CustomerItemDTO |
None. |
| Location |
Gets or sets the list of locations associated with the item. |
Collection of LocationDTO |
None. |
| ItemType |
Gets or sets the type of the item. |
string |
None. |
| ExpirationDate |
Gets or sets the expiration date of the item. |
date |
None. |
| CustPartNo |
Gets or sets the customer part number associated with the item. |
string |
None. |
| InitialReceipt |
Gets or sets the initial receipt information of the item. |
string |
None. |
| Active |
Gets or sets a value indicating whether the item is active. |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ItemID": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"ItemCode": "sample string 4",
"Quantity": 5,
"Comment": "sample string 6",
"UserName": "sample string 7",
"ItemImage": [
{
"ImageID": 1,
"Image": "QEA=",
"Name": "sample string 2",
"Type": "sample string 3",
"ItemID": 4
},
{
"ImageID": 1,
"Image": "QEA=",
"Name": "sample string 2",
"Type": "sample string 3",
"ItemID": 4
}
],
"CustomerItem": [
{
"CustomerID": 1,
"ItemID": 2,
"Itemcode": "sample string 3",
"Itemdesc": "sample string 4",
"CustomerDetail": {
"CustomerID": 1,
"Name": "sample string 2",
"CustomerCode": "sample string 3",
"Address": [
{
"AddressId": 1,
"AddressTypeId": 2,
"AddressTypeName": "sample string 3",
"AttnLine": "sample string 4",
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"AddressLine3": "sample string 7",
"City": "sample string 8",
"StateCode": "sample string 9",
"ZipCode": "sample string 10",
"CountryCode": "sample string 11"
},
{
"AddressId": 1,
"AddressTypeId": 2,
"AddressTypeName": "sample string 3",
"AttnLine": "sample string 4",
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"AddressLine3": "sample string 7",
"City": "sample string 8",
"StateCode": "sample string 9",
"ZipCode": "sample string 10",
"CountryCode": "sample string 11"
}
],
"Phone": [
{
"PhoneId": 1,
"PhoneTypeId": 2,
"PhoneTypeName": "sample string 3",
"Phone": "sample string 4",
"Extension": "sample string 5"
},
{
"PhoneId": 1,
"PhoneTypeId": 2,
"PhoneTypeName": "sample string 3",
"Phone": "sample string 4",
"Extension": "sample string 5"
}
]
}
},
{
"CustomerID": 1,
"ItemID": 2,
"Itemcode": "sample string 3",
"Itemdesc": "sample string 4",
"CustomerDetail": {
"CustomerID": 1,
"Name": "sample string 2",
"CustomerCode": "sample string 3",
"Address": [
{
"AddressId": 1,
"AddressTypeId": 2,
"AddressTypeName": "sample string 3",
"AttnLine": "sample string 4",
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"AddressLine3": "sample string 7",
"City": "sample string 8",
"StateCode": "sample string 9",
"ZipCode": "sample string 10",
"CountryCode": "sample string 11"
},
{
"AddressId": 1,
"AddressTypeId": 2,
"AddressTypeName": "sample string 3",
"AttnLine": "sample string 4",
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"AddressLine3": "sample string 7",
"City": "sample string 8",
"StateCode": "sample string 9",
"ZipCode": "sample string 10",
"CountryCode": "sample string 11"
}
],
"Phone": [
{
"PhoneId": 1,
"PhoneTypeId": 2,
"PhoneTypeName": "sample string 3",
"Phone": "sample string 4",
"Extension": "sample string 5"
},
{
"PhoneId": 1,
"PhoneTypeId": 2,
"PhoneTypeName": "sample string 3",
"Phone": "sample string 4",
"Extension": "sample string 5"
}
]
}
}
],
"Location": [
{
"WarehouseLocationID": 1,
"Description": "sample string 2",
"Quantity": 3
},
{
"WarehouseLocationID": 1,
"Description": "sample string 2",
"Quantity": 3
}
],
"ItemType": "sample string 8",
"ExpirationDate": "2025-07-01T04:01:42.6752212+00:00",
"CustPartNo": "sample string 10",
"InitialReceipt": "sample string 11",
"Active": true
},
{
"ItemID": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"ItemCode": "sample string 4",
"Quantity": 5,
"Comment": "sample string 6",
"UserName": "sample string 7",
"ItemImage": [
{
"ImageID": 1,
"Image": "QEA=",
"Name": "sample string 2",
"Type": "sample string 3",
"ItemID": 4
},
{
"ImageID": 1,
"Image": "QEA=",
"Name": "sample string 2",
"Type": "sample string 3",
"ItemID": 4
}
],
"CustomerItem": [
{
"CustomerID": 1,
"ItemID": 2,
"Itemcode": "sample string 3",
"Itemdesc": "sample string 4",
"CustomerDetail": {
"CustomerID": 1,
"Name": "sample string 2",
"CustomerCode": "sample string 3",
"Address": [
{
"AddressId": 1,
"AddressTypeId": 2,
"AddressTypeName": "sample string 3",
"AttnLine": "sample string 4",
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"AddressLine3": "sample string 7",
"City": "sample string 8",
"StateCode": "sample string 9",
"ZipCode": "sample string 10",
"CountryCode": "sample string 11"
},
{
"AddressId": 1,
"AddressTypeId": 2,
"AddressTypeName": "sample string 3",
"AttnLine": "sample string 4",
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"AddressLine3": "sample string 7",
"City": "sample string 8",
"StateCode": "sample string 9",
"ZipCode": "sample string 10",
"CountryCode": "sample string 11"
}
],
"Phone": [
{
"PhoneId": 1,
"PhoneTypeId": 2,
"PhoneTypeName": "sample string 3",
"Phone": "sample string 4",
"Extension": "sample string 5"
},
{
"PhoneId": 1,
"PhoneTypeId": 2,
"PhoneTypeName": "sample string 3",
"Phone": "sample string 4",
"Extension": "sample string 5"
}
]
}
},
{
"CustomerID": 1,
"ItemID": 2,
"Itemcode": "sample string 3",
"Itemdesc": "sample string 4",
"CustomerDetail": {
"CustomerID": 1,
"Name": "sample string 2",
"CustomerCode": "sample string 3",
"Address": [
{
"AddressId": 1,
"AddressTypeId": 2,
"AddressTypeName": "sample string 3",
"AttnLine": "sample string 4",
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"AddressLine3": "sample string 7",
"City": "sample string 8",
"StateCode": "sample string 9",
"ZipCode": "sample string 10",
"CountryCode": "sample string 11"
},
{
"AddressId": 1,
"AddressTypeId": 2,
"AddressTypeName": "sample string 3",
"AttnLine": "sample string 4",
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"AddressLine3": "sample string 7",
"City": "sample string 8",
"StateCode": "sample string 9",
"ZipCode": "sample string 10",
"CountryCode": "sample string 11"
}
],
"Phone": [
{
"PhoneId": 1,
"PhoneTypeId": 2,
"PhoneTypeName": "sample string 3",
"Phone": "sample string 4",
"Extension": "sample string 5"
},
{
"PhoneId": 1,
"PhoneTypeId": 2,
"PhoneTypeName": "sample string 3",
"Phone": "sample string 4",
"Extension": "sample string 5"
}
]
}
}
],
"Location": [
{
"WarehouseLocationID": 1,
"Description": "sample string 2",
"Quantity": 3
},
{
"WarehouseLocationID": 1,
"Description": "sample string 2",
"Quantity": 3
}
],
"ItemType": "sample string 8",
"ExpirationDate": "2025-07-01T04:01:42.6752212+00:00",
"CustPartNo": "sample string 10",
"InitialReceipt": "sample string 11",
"Active": true
}
]
application/xml, text/xml
Sample:
<ArrayOfItemDetailDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ItemDetailDTO>
<ItemID>1</ItemID>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<ItemCode>sample string 4</ItemCode>
<Quantity>5</Quantity>
<Comment>sample string 6</Comment>
<UserName>sample string 7</UserName>
<ItemImage>
<ItemImageDTO>
<ImageID>1</ImageID>
<Image>QEA=</Image>
<Name>sample string 2</Name>
<Type>sample string 3</Type>
<ItemID>4</ItemID>
</ItemImageDTO>
<ItemImageDTO>
<ImageID>1</ImageID>
<Image>QEA=</Image>
<Name>sample string 2</Name>
<Type>sample string 3</Type>
<ItemID>4</ItemID>
</ItemImageDTO>
</ItemImage>
<CustomerItem>
<CustomerItemDTO>
<CustomerID>1</CustomerID>
<ItemID>2</ItemID>
<ItemCode>sample string 3</ItemCode>
<Description>sample string 4</Description>
<CustomerDetail>
<CustomerID>1</CustomerID>
<Name>sample string 2</Name>
<CustomerCode>sample string 3</CustomerCode>
<Address>
<AddressDTO>
<AddressId>1</AddressId>
<AddressTypeId>2</AddressTypeId>
<AddressTypeName>sample string 3</AddressTypeName>
<AttnLine>sample string 4</AttnLine>
<AddressLine1>sample string 5</AddressLine1>
<AddressLine2>sample string 6</AddressLine2>
<AddressLine3>sample string 7</AddressLine3>
<City>sample string 8</City>
<StateCode>sample string 9</StateCode>
<ZipCode>sample string 10</ZipCode>
<CountryCode>sample string 11</CountryCode>
</AddressDTO>
<AddressDTO>
<AddressId>1</AddressId>
<AddressTypeId>2</AddressTypeId>
<AddressTypeName>sample string 3</AddressTypeName>
<AttnLine>sample string 4</AttnLine>
<AddressLine1>sample string 5</AddressLine1>
<AddressLine2>sample string 6</AddressLine2>
<AddressLine3>sample string 7</AddressLine3>
<City>sample string 8</City>
<StateCode>sample string 9</StateCode>
<ZipCode>sample string 10</ZipCode>
<CountryCode>sample string 11</CountryCode>
</AddressDTO>
</Address>
<Phone>
<PhoneDTO>
<PhoneId>1</PhoneId>
<PhoneTypeId>2</PhoneTypeId>
<PhoneTypeName>sample string 3</PhoneTypeName>
<Phone>sample string 4</Phone>
<Extension>sample string 5</Extension>
</PhoneDTO>
<PhoneDTO>
<PhoneId>1</PhoneId>
<PhoneTypeId>2</PhoneTypeId>
<PhoneTypeName>sample string 3</PhoneTypeName>
<Phone>sample string 4</Phone>
<Extension>sample string 5</Extension>
</PhoneDTO>
</Phone>
<IsExist>true</IsExist>
</CustomerDetail>
</CustomerItemDTO>
<CustomerItemDTO>
<CustomerID>1</CustomerID>
<ItemID>2</ItemID>
<ItemCode>sample string 3</ItemCode>
<Description>sample string 4</Description>
<CustomerDetail>
<CustomerID>1</CustomerID>
<Name>sample string 2</Name>
<CustomerCode>sample string 3</CustomerCode>
<Address>
<AddressDTO>
<AddressId>1</AddressId>
<AddressTypeId>2</AddressTypeId>
<AddressTypeName>sample string 3</AddressTypeName>
<AttnLine>sample string 4</AttnLine>
<AddressLine1>sample string 5</AddressLine1>
<AddressLine2>sample string 6</AddressLine2>
<AddressLine3>sample string 7</AddressLine3>
<City>sample string 8</City>
<StateCode>sample string 9</StateCode>
<ZipCode>sample string 10</ZipCode>
<CountryCode>sample string 11</CountryCode>
</AddressDTO>
<AddressDTO>
<AddressId>1</AddressId>
<AddressTypeId>2</AddressTypeId>
<AddressTypeName>sample string 3</AddressTypeName>
<AttnLine>sample string 4</AttnLine>
<AddressLine1>sample string 5</AddressLine1>
<AddressLine2>sample string 6</AddressLine2>
<AddressLine3>sample string 7</AddressLine3>
<City>sample string 8</City>
<StateCode>sample string 9</StateCode>
<ZipCode>sample string 10</ZipCode>
<CountryCode>sample string 11</CountryCode>
</AddressDTO>
</Address>
<Phone>
<PhoneDTO>
<PhoneId>1</PhoneId>
<PhoneTypeId>2</PhoneTypeId>
<PhoneTypeName>sample string 3</PhoneTypeName>
<Phone>sample string 4</Phone>
<Extension>sample string 5</Extension>
</PhoneDTO>
<PhoneDTO>
<PhoneId>1</PhoneId>
<PhoneTypeId>2</PhoneTypeId>
<PhoneTypeName>sample string 3</PhoneTypeName>
<Phone>sample string 4</Phone>
<Extension>sample string 5</Extension>
</PhoneDTO>
</Phone>
<IsExist>true</IsExist>
</CustomerDetail>
</CustomerItemDTO>
</CustomerItem>
<Location>
<LocationDTO>
<WarehouseLocationID>1</WarehouseLocationID>
<Description>sample string 2</Description>
<Quantity>3</Quantity>
<IsExist>true</IsExist>
</LocationDTO>
<LocationDTO>
<WarehouseLocationID>1</WarehouseLocationID>
<Description>sample string 2</Description>
<Quantity>3</Quantity>
<IsExist>true</IsExist>
</LocationDTO>
</Location>
<ItemType>sample string 8</ItemType>
<ExpirationDate>2025-07-01T04:01:42.6752212+00:00</ExpirationDate>
<CustPartNo>sample string 10</CustPartNo>
<InitialReceipt>sample string 11</InitialReceipt>
<Active>true</Active>
<IsExist>true</IsExist>
</ItemDetailDTO>
<ItemDetailDTO>
<ItemID>1</ItemID>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<ItemCode>sample string 4</ItemCode>
<Quantity>5</Quantity>
<Comment>sample string 6</Comment>
<UserName>sample string 7</UserName>
<ItemImage>
<ItemImageDTO>
<ImageID>1</ImageID>
<Image>QEA=</Image>
<Name>sample string 2</Name>
<Type>sample string 3</Type>
<ItemID>4</ItemID>
</ItemImageDTO>
<ItemImageDTO>
<ImageID>1</ImageID>
<Image>QEA=</Image>
<Name>sample string 2</Name>
<Type>sample string 3</Type>
<ItemID>4</ItemID>
</ItemImageDTO>
</ItemImage>
<CustomerItem>
<CustomerItemDTO>
<CustomerID>1</CustomerID>
<ItemID>2</ItemID>
<ItemCode>sample string 3</ItemCode>
<Description>sample string 4</Description>
<CustomerDetail>
<CustomerID>1</CustomerID>
<Name>sample string 2</Name>
<CustomerCode>sample string 3</CustomerCode>
<Address>
<AddressDTO>
<AddressId>1</AddressId>
<AddressTypeId>2</AddressTypeId>
<AddressTypeName>sample string 3</AddressTypeName>
<AttnLine>sample string 4</AttnLine>
<AddressLine1>sample string 5</AddressLine1>
<AddressLine2>sample string 6</AddressLine2>
<AddressLine3>sample string 7</AddressLine3>
<City>sample string 8</City>
<StateCode>sample string 9</StateCode>
<ZipCode>sample string 10</ZipCode>
<CountryCode>sample string 11</CountryCode>
</AddressDTO>
<AddressDTO>
<AddressId>1</AddressId>
<AddressTypeId>2</AddressTypeId>
<AddressTypeName>sample string 3</AddressTypeName>
<AttnLine>sample string 4</AttnLine>
<AddressLine1>sample string 5</AddressLine1>
<AddressLine2>sample string 6</AddressLine2>
<AddressLine3>sample string 7</AddressLine3>
<City>sample string 8</City>
<StateCode>sample string 9</StateCode>
<ZipCode>sample string 10</ZipCode>
<CountryCode>sample string 11</CountryCode>
</AddressDTO>
</Address>
<Phone>
<PhoneDTO>
<PhoneId>1</PhoneId>
<PhoneTypeId>2</PhoneTypeId>
<PhoneTypeName>sample string 3</PhoneTypeName>
<Phone>sample string 4</Phone>
<Extension>sample string 5</Extension>
</PhoneDTO>
<PhoneDTO>
<PhoneId>1</PhoneId>
<PhoneTypeId>2</PhoneTypeId>
<PhoneTypeName>sample string 3</PhoneTypeName>
<Phone>sample string 4</Phone>
<Extension>sample string 5</Extension>
</PhoneDTO>
</Phone>
<IsExist>true</IsExist>
</CustomerDetail>
</CustomerItemDTO>
<CustomerItemDTO>
<CustomerID>1</CustomerID>
<ItemID>2</ItemID>
<ItemCode>sample string 3</ItemCode>
<Description>sample string 4</Description>
<CustomerDetail>
<CustomerID>1</CustomerID>
<Name>sample string 2</Name>
<CustomerCode>sample string 3</CustomerCode>
<Address>
<AddressDTO>
<AddressId>1</AddressId>
<AddressTypeId>2</AddressTypeId>
<AddressTypeName>sample string 3</AddressTypeName>
<AttnLine>sample string 4</AttnLine>
<AddressLine1>sample string 5</AddressLine1>
<AddressLine2>sample string 6</AddressLine2>
<AddressLine3>sample string 7</AddressLine3>
<City>sample string 8</City>
<StateCode>sample string 9</StateCode>
<ZipCode>sample string 10</ZipCode>
<CountryCode>sample string 11</CountryCode>
</AddressDTO>
<AddressDTO>
<AddressId>1</AddressId>
<AddressTypeId>2</AddressTypeId>
<AddressTypeName>sample string 3</AddressTypeName>
<AttnLine>sample string 4</AttnLine>
<AddressLine1>sample string 5</AddressLine1>
<AddressLine2>sample string 6</AddressLine2>
<AddressLine3>sample string 7</AddressLine3>
<City>sample string 8</City>
<StateCode>sample string 9</StateCode>
<ZipCode>sample string 10</ZipCode>
<CountryCode>sample string 11</CountryCode>
</AddressDTO>
</Address>
<Phone>
<PhoneDTO>
<PhoneId>1</PhoneId>
<PhoneTypeId>2</PhoneTypeId>
<PhoneTypeName>sample string 3</PhoneTypeName>
<Phone>sample string 4</Phone>
<Extension>sample string 5</Extension>
</PhoneDTO>
<PhoneDTO>
<PhoneId>1</PhoneId>
<PhoneTypeId>2</PhoneTypeId>
<PhoneTypeName>sample string 3</PhoneTypeName>
<Phone>sample string 4</Phone>
<Extension>sample string 5</Extension>
</PhoneDTO>
</Phone>
<IsExist>true</IsExist>
</CustomerDetail>
</CustomerItemDTO>
</CustomerItem>
<Location>
<LocationDTO>
<WarehouseLocationID>1</WarehouseLocationID>
<Description>sample string 2</Description>
<Quantity>3</Quantity>
<IsExist>true</IsExist>
</LocationDTO>
<LocationDTO>
<WarehouseLocationID>1</WarehouseLocationID>
<Description>sample string 2</Description>
<Quantity>3</Quantity>
<IsExist>true</IsExist>
</LocationDTO>
</Location>
<ItemType>sample string 8</ItemType>
<ExpirationDate>2025-07-01T04:01:42.6752212+00:00</ExpirationDate>
<CustPartNo>sample string 10</CustPartNo>
<InitialReceipt>sample string 11</InitialReceipt>
<Active>true</Active>
<IsExist>true</IsExist>
</ItemDetailDTO>
</ArrayOfItemDetailDTO>