GET api/v1/ItemInventory/itemCode/{itemCode}
Get Item by item code
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| itemCode |
Item code to return |
string |
Required |
Body Parameters
Response Information
Resource Description
ItemInventory| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer | ||
| ItemId | integer | ||
| WarehouseId | integer | ||
| Balance | decimal number | ||
| CommittedBalance | decimal number | ||
| ShippableBalance | decimal number | ||
| ReserveBalance | decimal number | ||
| ItemCode | string | ||
| ItemDescription | string | ||
| WarehouseName | string | ||
| ItemInventoryDetails | Collection of ItemInventoryDetail | ||
| ModifiedDateTime |
Modified datetime for the object. This will be added by the system. |
date | |
| ExecutionTime |
How long the method took in milliseconds. System supplied value. |
integer | |
| TxID |
Transaction ID of the call. Will be added for the response. Not needed in the request. |
string |
Response Formats
application/json, text/json
Sample:
{
"executionTime": 13,
"txID": "sample string 14"
}
application/xml, text/xml
Sample:
<ItemInventory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Models">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">13</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 14</TxID>
<Balance>4</Balance>
<CommittedBalance>5</CommittedBalance>
<Id>1</Id>
<Item z:Id="i2">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">28</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 29</TxID>
<AlternateItemCode>sample string 3</AlternateItemCode>
<BarCodeNumber>sample string 25</BarCodeNumber>
<BillingCode>sample string 11</BillingCode>
<Cost>24</Cost>
<Description>sample string 8</Description>
<DimHeight>18</DimHeight>
<DimLength>16</DimLength>
<DimUoM>sample string 19</DimUoM>
<DimWidth>17</DimWidth>
<ErpId>sample string 7</ErpId>
<GTIN>sample string 5</GTIN>
<HarmonizedCode>sample string 6</HarmonizedCode>
<HasSerialNumber>true</HasSerialNumber>
<Id>1</Id>
<Image>QEA=</Image>
<ItemCode>sample string 2</ItemCode>
<ItemInventories>
<ItemInventory z:Ref="i1" />
<ItemInventory z:Ref="i1" />
</ItemInventories>
<ItemInventoryLedgers>
<ItemInventoryLedgerEntry z:Id="i3">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">15</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 16</TxID>
<Balance>8</Balance>
<Description>sample string 12</Description>
<Id>1</Id>
<Item z:Ref="i2" />
<ItemCode>sample string 5</ItemCode>
<ItemId>4</ItemId>
<ItemLedgerAdjustmentType>
<Id>Unknown</Id>
<ItemInventoryLedgers>
<ItemInventoryLedgerEntry z:Ref="i3" />
<ItemInventoryLedgerEntry z:Ref="i3" />
</ItemInventoryLedgers>
<Name>sample string 1</Name>
</ItemLedgerAdjustmentType>
<ItemLedgerAdjustmentTypeId>Unknown</ItemLedgerAdjustmentTypeId>
<ItemReceivingId>1</ItemReceivingId>
<LotNumber>sample string 10</LotNumber>
<OrderId>1</OrderId>
<OrderShipmentId>1</OrderShipmentId>
<PONumber>6</PONumber>
<Quantity>7</Quantity>
<ReserveBalance>9</ReserveBalance>
<TransactionDate>2025-12-19T20:11:53.0088419+00:00</TransactionDate>
<Warehouse z:Id="i4">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">11</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 12</TxID>
<Address1>sample string 4</Address1>
<Address2>sample string 5</Address2>
<City>sample string 6</City>
<Company>sample string 3</Company>
<Id>1</Id>
<ItemInventories>
<ItemInventory z:Ref="i1" />
<ItemInventory z:Ref="i1" />
</ItemInventories>
<ItemInventoryDetails>
<ItemInventoryDetail z:Id="i5">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">14</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 15</TxID>
<DetailBalance>4</DetailBalance>
<DetailCommitted>5</DetailCommitted>
<Id>1</Id>
<ItemInventory z:Ref="i1" />
<ItemInventoryId>2</ItemInventoryId>
<LotBalance>10</LotBalance>
<LotExpiration>2025-12-19T20:11:53.0088419+00:00</LotExpiration>
<LotNumber>sample string 9</LotNumber>
<ReceiveAmount>6</ReceiveAmount>
<RecieveDate>2025-12-19T20:11:53.0088419+00:00</RecieveDate>
<ReserveBalance>8</ReserveBalance>
<Warehouse z:Ref="i4" />
<WarehouseId>3</WarehouseId>
</ItemInventoryDetail>
<ItemInventoryDetail z:Ref="i5" />
</ItemInventoryDetails>
<ItemInventoryLedgers>
<ItemInventoryLedgerEntry z:Ref="i3" />
<ItemInventoryLedgerEntry z:Ref="i3" />
</ItemInventoryLedgers>
<Name>sample string 2</Name>
<State>sample string 7</State>
<Zip>sample string 8</Zip>
</Warehouse>
<WarehouseId>2</WarehouseId>
<WarehouseName>sample string 3</WarehouseName>
</ItemInventoryLedgerEntry>
<ItemInventoryLedgerEntry z:Ref="i3" />
</ItemInventoryLedgers>
<ItemKitBuilds>
<ItemKitBuild z:Id="i6">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">8</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 9</TxID>
<Barcode>sample string 4</Barcode>
<BarcodeImage>sample string 5</BarcodeImage>
<CreatedDateTime>2025-12-19T20:11:53.0088419+00:00</CreatedDateTime>
<CreatedSessionId>1</CreatedSessionId>
<Id>1</Id>
<Item z:Ref="i2" />
<ItemCode>sample string 3</ItemCode>
<ItemId>2</ItemId>
<ItemKitBuildItems>
<ItemKitBuildItem z:Id="i7">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">8</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 9</TxID>
<GTIN>sample string 3</GTIN>
<Id>1</Id>
<ItemId>1</ItemId>
<ItemKitBuild z:Ref="i6" />
<ItemKitBuildId>2</ItemKitBuildId>
<LotExpDate>2025-12-19T20:11:53.0088419+00:00</LotExpDate>
<LotNumber>sample string 4</LotNumber>
<Quantity>1</Quantity>
<SerialNumber>sample string 5</SerialNumber>
</ItemKitBuildItem>
<ItemKitBuildItem z:Ref="i7" />
</ItemKitBuildItems>
</ItemKitBuild>
<ItemKitBuild z:Ref="i6" />
</ItemKitBuilds>
<ItemKits>
<ItemKit z:Id="i8">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">10</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 11</TxID>
<ComponentGTIN>sample string 7</ComponentGTIN>
<ComponentItemCode>sample string 5</ComponentItemCode>
<ComponentItemId>4</ComponentItemId>
<ComponentQuantity>6</ComponentQuantity>
<Id>1</Id>
<Item z:Ref="i2" />
<ItemCode>sample string 3</ItemCode>
<ItemId>2</ItemId>
</ItemKit>
<ItemKit z:Ref="i8" />
</ItemKits>
<ItemPrice>20</ItemPrice>
<ItemStatus>
<Description>sample string 2</Description>
<Id>Inactive</Id>
<Items>
<Item z:Ref="i2" />
<Item z:Ref="i2" />
</Items>
<Name>sample string 1</Name>
</ItemStatus>
<ItemStatusId>Inactive</ItemStatusId>
<ItemType>
<Id>Unknown</Id>
<Items>
<Item z:Ref="i2" />
<Item z:Ref="i2" />
</Items>
<Name>sample string 1</Name>
</ItemType>
<ItemTypeId>Unknown</ItemTypeId>
<ItemUoM>sample string 9</ItemUoM>
<LotControlled>true</LotControlled>
<MfgItemCode>sample string 4</MfgItemCode>
<OrderItems>
<OrderItem z:Id="i9">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">8</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 9</TxID>
<Item z:Ref="i2" />
<ItemCode>sample string 4</ItemCode>
<Quantity>5</Quantity>
</OrderItem>
<OrderItem z:Ref="i9" />
</OrderItems>
<Prop65>true</Prop65>
<UPCCode>sample string 10</UPCCode>
<UnitOfMeasure>
<Description>sample string 2</Description>
<Items>
<Item z:Ref="i2" />
<Item z:Ref="i2" />
</Items>
<Items1>
<Item z:Ref="i2" />
<Item z:Ref="i2" />
</Items1>
<Items2>
<Item z:Ref="i2" />
<Item z:Ref="i2" />
</Items2>
<Symbol>sample string 3</Symbol>
<UoM>sample string 1</UoM>
</UnitOfMeasure>
<UnitOfMeasure1>
<Description>sample string 2</Description>
<Items>
<Item z:Ref="i2" />
<Item z:Ref="i2" />
</Items>
<Items1>
<Item z:Ref="i2" />
<Item z:Ref="i2" />
</Items1>
<Items2>
<Item z:Ref="i2" />
<Item z:Ref="i2" />
</Items2>
<Symbol>sample string 3</Symbol>
<UoM>sample string 1</UoM>
</UnitOfMeasure1>
<UnitOfMeasure2>
<Description>sample string 2</Description>
<Items>
<Item z:Ref="i2" />
<Item z:Ref="i2" />
</Items>
<Items1>
<Item z:Ref="i2" />
<Item z:Ref="i2" />
</Items1>
<Items2>
<Item z:Ref="i2" />
<Item z:Ref="i2" />
</Items2>
<Symbol>sample string 3</Symbol>
<UoM>sample string 1</UoM>
</UnitOfMeasure2>
<Vendor>
<Id>1</Id>
<Items>
<Item z:Ref="i2" />
<Item z:Ref="i2" />
</Items>
<Name>sample string 2</Name>
</Vendor>
<VendorId>12</VendorId>
<Volume>1</Volume>
<VolumeUoM>sample string 23</VolumeUoM>
<Weight>13</Weight>
<WeightUoM>sample string 14</WeightUoM>
</Item>
<ItemCode>sample string 8</ItemCode>
<ItemDescription>sample string 9</ItemDescription>
<ItemId>2</ItemId>
<ItemInventoryDetails>
<ItemInventoryDetail z:Ref="i5" />
<ItemInventoryDetail z:Ref="i5" />
</ItemInventoryDetails>
<ReserveBalance>7</ReserveBalance>
<ShippableBalance>6</ShippableBalance>
<Warehouse z:Ref="i4" />
<WarehouseId>3</WarehouseId>
<WarehouseName>sample string 10</WarehouseName>
</ItemInventory>