GET v1/Inventory/GetInventoryItem?itemId={itemId}

Retrieves the inventory item details for a given item ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
itemId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of ItemSummeryDTO
NameDescriptionTypeAdditional 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.
ItemType

Gets or sets the type of the item.

 string

None.
Active

Gets or sets a value indicating whether the item is active.

 boolean

None.
ItemImage

Gets or sets the list of images associated with the item.

 Collection of ItemImageDTO

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "ItemID": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "ItemCode": "sample string 4",
    "ItemType": "sample string 5",
    "Active": true,
    "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
      }
    ]
  },
  {
    "ItemID": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "ItemCode": "sample string 4",
    "ItemType": "sample string 5",
    "Active": true,
    "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
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfItemSummeryDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ItemSummeryDTO>
    <ItemID>1</ItemID>
    <Name>sample string 2</Name>
    <Description>sample string 3</Description>
    <ItemCode>sample string 4</ItemCode>
    <ItemType>sample string 5</ItemType>
    <Active>true</Active>
    <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>
  </ItemSummeryDTO>
  <ItemSummeryDTO>
    <ItemID>1</ItemID>
    <Name>sample string 2</Name>
    <Description>sample string 3</Description>
    <ItemCode>sample string 4</ItemCode>
    <ItemType>sample string 5</ItemType>
    <Active>true</Active>
    <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>
  </ItemSummeryDTO>
</ArrayOfItemSummeryDTO>