POST api/NebimCommon/GetProductInventory

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Barcode	string	None.
PlaceCode	string	None.
IsSN	integer	None.
ItemTypeCode	byte	None.
ItemCode	string	None.
ColorCode	string	None.
ItemDim1Code	string	None.
ItemDim2Code	string	None.
ItemDim3Code	string	None.
Detail	boolean	None.
OtherStore	boolean	None.
IncludeNotApproved	boolean	None.
UseSerialNumber	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "barcode": "sample string 1",
  "placeCode": "sample string 2",
  "isSN": 3,
  "itemTypeCode": 64,
  "itemCode": "sample string 5",
  "colorCode": "sample string 6",
  "itemDim1Code": "sample string 7",
  "itemDim2Code": "sample string 8",
  "itemDim3Code": "sample string 9",
  "detail": true,
  "otherStore": true,
  "includeNotApproved": true,
  "useSerialNumber": true
}

application/xml, text/xml

Sample:

<GetInventoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VolisServer.DTOs.Request">
  <Barcode>sample string 1</Barcode>
  <ColorCode>sample string 6</ColorCode>
  <Detail>true</Detail>
  <IncludeNotApproved>true</IncludeNotApproved>
  <IsSN>3</IsSN>
  <ItemCode>sample string 5</ItemCode>
  <ItemDim1Code>sample string 7</ItemDim1Code>
  <ItemDim2Code>sample string 8</ItemDim2Code>
  <ItemDim3Code>sample string 9</ItemDim3Code>
  <ItemTypeCode>64</ItemTypeCode>
  <OtherStore>true</OtherStore>
  <PlaceCode>sample string 2</PlaceCode>
  <UseSerialNumber>true</UseSerialNumber>
</GetInventoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseModelOfListOfProductInventoryDTO

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Errors	Collection of string	None.
Code	integer	None.
Data	Collection of ProductInventoryDTO	None.
Warning	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "message": "sample string 2",
  "errors": [
    "sample string 1",
    "sample string 2"
  ],
  "code": 3,
  "data": [
    {
      "sectionCode": "sample string 1",
      "palletCode": "sample string 2",
      "packageCode": "sample string 3",
      "itemTypeCode": 4,
      "itemCode": "sample string 5",
      "itemDescription": "sample string 6",
      "colorCode": "sample string 7",
      "colorDescription": "sample string 8",
      "itemDim1Code": "sample string 9",
      "itemDim2Code": "sample string 10",
      "itemDim3Code": "sample string 11",
      "inventoryQty": 12.0,
      "inCollectionQty": 13.0,
      "serialNumber": "sample string 14",
      "isSN": 15,
      "capQty": 16.0
    },
    {
      "sectionCode": "sample string 1",
      "palletCode": "sample string 2",
      "packageCode": "sample string 3",
      "itemTypeCode": 4,
      "itemCode": "sample string 5",
      "itemDescription": "sample string 6",
      "colorCode": "sample string 7",
      "colorDescription": "sample string 8",
      "itemDim1Code": "sample string 9",
      "itemDim2Code": "sample string 10",
      "itemDim3Code": "sample string 11",
      "inventoryQty": 12.0,
      "inCollectionQty": 13.0,
      "serialNumber": "sample string 14",
      "isSN": 15,
      "capQty": 16.0
    }
  ],
  "warning": true
}

application/xml, text/xml

Sample:

<ResponseModelOfArrayOfProductInventoryDTO0JY7E9Nx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VolisServer.CustomClasses">
  <Code>3</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/VolisServer.DTOs.Common">
    <d2p1:ProductInventoryDTO>
      <d2p1:CapQty>16</d2p1:CapQty>
      <d2p1:ColorCode>sample string 7</d2p1:ColorCode>
      <d2p1:ColorDescription>sample string 8</d2p1:ColorDescription>
      <d2p1:InCollectionQty>13</d2p1:InCollectionQty>
      <d2p1:InventoryQty>12</d2p1:InventoryQty>
      <d2p1:IsSN>15</d2p1:IsSN>
      <d2p1:ItemCode>sample string 5</d2p1:ItemCode>
      <d2p1:ItemDescription>sample string 6</d2p1:ItemDescription>
      <d2p1:ItemDim1Code>sample string 9</d2p1:ItemDim1Code>
      <d2p1:ItemDim2Code>sample string 10</d2p1:ItemDim2Code>
      <d2p1:ItemDim3Code>sample string 11</d2p1:ItemDim3Code>
      <d2p1:ItemTypeCode>4</d2p1:ItemTypeCode>
      <d2p1:PackageCode>sample string 3</d2p1:PackageCode>
      <d2p1:PalletCode>sample string 2</d2p1:PalletCode>
      <d2p1:SectionCode>sample string 1</d2p1:SectionCode>
      <d2p1:SerialNumber>sample string 14</d2p1:SerialNumber>
    </d2p1:ProductInventoryDTO>
    <d2p1:ProductInventoryDTO>
      <d2p1:CapQty>16</d2p1:CapQty>
      <d2p1:ColorCode>sample string 7</d2p1:ColorCode>
      <d2p1:ColorDescription>sample string 8</d2p1:ColorDescription>
      <d2p1:InCollectionQty>13</d2p1:InCollectionQty>
      <d2p1:InventoryQty>12</d2p1:InventoryQty>
      <d2p1:IsSN>15</d2p1:IsSN>
      <d2p1:ItemCode>sample string 5</d2p1:ItemCode>
      <d2p1:ItemDescription>sample string 6</d2p1:ItemDescription>
      <d2p1:ItemDim1Code>sample string 9</d2p1:ItemDim1Code>
      <d2p1:ItemDim2Code>sample string 10</d2p1:ItemDim2Code>
      <d2p1:ItemDim3Code>sample string 11</d2p1:ItemDim3Code>
      <d2p1:ItemTypeCode>4</d2p1:ItemTypeCode>
      <d2p1:PackageCode>sample string 3</d2p1:PackageCode>
      <d2p1:PalletCode>sample string 2</d2p1:PalletCode>
      <d2p1:SectionCode>sample string 1</d2p1:SectionCode>
      <d2p1:SerialNumber>sample string 14</d2p1:SerialNumber>
    </d2p1:ProductInventoryDTO>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <Message>sample string 2</Message>
  <Success>true</Success>
  <Warning>true</Warning>
</ResponseModelOfArrayOfProductInventoryDTO0JY7E9Nx>