POST api/BarcodeLookup/LookupItem
Inventory lookup details
Request Information
URI Parameters
None.
Body Parameters
LookupItemRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| APIToken | string |
None. |
|
| UPC_EAN_Code | string |
Required |
|
| ItemType | integer |
None. |
Request Formats
application/json, text/json, text/plain, text/html
Sample:
{
"apiToken": "sample string 1",
"upC_EAN_Code": "sample string 2",
"itemType": 1
}
application/xml, text/xml
Sample:
<LookupItemRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"> <APIToken>sample string 1</APIToken> <ItemType>1</ItemType> <UPC_EAN_Code>sample string 2</UPC_EAN_Code> </LookupItemRequestModel>
multipart/form-data
Sample:
<LookupItemRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><APIToken>sample string 1</APIToken><ItemType>1</ItemType><UPC_EAN_Code>sample string 2</UPC_EAN_Code></LookupItemRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
LookupItemResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SerialNo | string |
None. |
|
| ItemName | string |
None. |
|
| UPC_EAN_Code | string |
None. |
|
| ItemType | integer |
None. |
|
| ItemDetails | PartsSupplyDataModel |
None. |
|
| ReturnID | integer |
Required |
|
| Message | string |
Required |
|
| Successful | boolean |
Required |
|
| Code | integer |
None. |
|
| TotalRecord | integer |
None. |
Response Formats
application/json, text/json, text/plain, text/html
Sample:
{
"serialNo": "sample string 1",
"itemName": "sample string 2",
"upC_EAN_Code": "sample string 3",
"itemType": 4,
"itemDetails": {
"catalogueID": 1,
"catalogueCode_ProductID": "sample string 1",
"shortDesc": "sample string 2",
"longDesc": "sample string 3",
"aisle": "sample string 4",
"row": "sample string 5",
"bin": "sample string 6",
"status": 1,
"statusName": "sample string 7",
"serialNo": "sample string 8",
"barcode": "sample string 9",
"unspc_Code": "sample string 10",
"accountGroupId": 1,
"accountGroup": "sample string 11",
"categoryID": 1,
"category": "sample string 12",
"make": "sample string 13",
"model": "sample string 14",
"locationID": 1,
"location": "sample string 15",
"departmentId": 1,
"department": "sample string 16",
"building": "sample string 17",
"room": "sample string 18",
"price": 1.0,
"taxID": 1,
"tax": 1.0,
"orderUnitId": 1,
"orderUnit": "sample string 19",
"currencyID": 1,
"currency": "sample string 20",
"reOrderQty": 1.0,
"availableQty": 1.0,
"cost": 1.0,
"uomqbListID": "sample string 21",
"vendorQBListID": "sample string 22",
"isActive": 23,
"isDeleted": 24,
"isStockCheck": true,
"addedBy": 26,
"addedDate": "2025-07-17T05:02:43.6591478+00:00",
"modifiedBy": 27,
"modifiedDate": "2025-07-17T05:02:43.6591478+00:00",
"totalRecord": 28,
"rfid": "sample string 29",
"qboListID": "sample string 30",
"qboEditSequence": "sample string 31",
"lastSyncTimeToQBO": "2025-07-17T05:02:43.6591478+00:00",
"lastSyncQtyToQBO": 1.0,
"lastSyncQtyFromQBO": 1.0,
"qbIncomeAccountID": "sample string 32",
"qbExpenseAccountID": "sample string 33",
"qbAssetAccountID": "sample string 34",
"partsFile": [
{
"catalogueFileID": 1,
"catalogueID": 2,
"actualFileName": "sample string 3",
"renamedFileName": "sample string 4",
"addedBy": 5,
"addedDate": "2025-07-17T05:02:43.6591478+00:00",
"downloadPath": "sample string 7",
"fileType": "sample string 8",
"linkURL": "sample string 9",
"note": "sample string 10"
},
{
"catalogueFileID": 1,
"catalogueID": 2,
"actualFileName": "sample string 3",
"renamedFileName": "sample string 4",
"addedBy": 5,
"addedDate": "2025-07-17T05:02:43.6591478+00:00",
"downloadPath": "sample string 7",
"fileType": "sample string 8",
"linkURL": "sample string 9",
"note": "sample string 10"
}
],
"subCategoryID": 1,
"subCategoryName": "sample string 35",
"subCategoryID2": 1,
"subCategory2Name": "sample string 36",
"subCategoryID3": 1,
"subCategory3Name": "sample string 37",
"imageURL1": "sample string 38",
"renamedFileName": "sample string 39",
"partsImage": "sample string 40",
"lastCycleCountDate": "2025-07-17T05:02:43.6591478+00:00",
"costCode": "sample string 41",
"costCodeName": "sample string 42",
"vendor": "sample string 43",
"manufacturerWebsite": "sample string 44",
"sitetype": "sample string 45",
"imageURL2": "sample string 46",
"imageURL3": "sample string 47",
"imageURL4": "sample string 48",
"imageURL5": "sample string 49",
"imageURL6": "sample string 50",
"imageURL7": "sample string 51",
"imageURL8": "sample string 52",
"notes": "sample string 53",
"qbDesktopVendorID": 1,
"isOilConsumptionHidden": true,
"custom1": "sample string 55",
"custom2": "sample string 56",
"custom3": "sample string 57",
"custom4": "sample string 58",
"custom5": "sample string 59",
"custom6": "sample string 60",
"custom7": "sample string 61",
"custom8": "sample string 62",
"custom9": "sample string 63",
"custom10": "sample string 64"
},
"returnID": 5,
"message": "sample string 6",
"successful": true,
"code": 8,
"totalRecord": 9
}
application/xml, text/xml
Sample:
<LookupItemResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
<Code>8</Code>
<Message>sample string 6</Message>
<ReturnID>5</ReturnID>
<Successful>true</Successful>
<TotalRecord>9</TotalRecord>
<ItemDetails>
<AccountGroup>sample string 11</AccountGroup>
<AccountGroupId>1</AccountGroupId>
<AddedBy>26</AddedBy>
<AddedDate>2025-07-17T05:02:43.6591478+00:00</AddedDate>
<Aisle>sample string 4</Aisle>
<AvailableQty>1</AvailableQty>
<Barcode>sample string 9</Barcode>
<Bin>sample string 6</Bin>
<Building>sample string 17</Building>
<CatalogueCode_ProductID>sample string 1</CatalogueCode_ProductID>
<CatalogueID>1</CatalogueID>
<Category>sample string 12</Category>
<CategoryID>1</CategoryID>
<Cost>1</Cost>
<CostCode>sample string 41</CostCode>
<CostCodeName>sample string 42</CostCodeName>
<Currency>sample string 20</Currency>
<CurrencyID>1</CurrencyID>
<Custom1>sample string 55</Custom1>
<Custom10>sample string 64</Custom10>
<Custom2>sample string 56</Custom2>
<Custom3>sample string 57</Custom3>
<Custom4>sample string 58</Custom4>
<Custom5>sample string 59</Custom5>
<Custom6>sample string 60</Custom6>
<Custom7>sample string 61</Custom7>
<Custom8>sample string 62</Custom8>
<Custom9>sample string 63</Custom9>
<Department>sample string 16</Department>
<DepartmentId>1</DepartmentId>
<ImageURL1>sample string 38</ImageURL1>
<ImageURL2>sample string 46</ImageURL2>
<ImageURL3>sample string 47</ImageURL3>
<ImageURL4>sample string 48</ImageURL4>
<ImageURL5>sample string 49</ImageURL5>
<ImageURL6>sample string 50</ImageURL6>
<ImageURL7>sample string 51</ImageURL7>
<ImageURL8>sample string 52</ImageURL8>
<IsActive>23</IsActive>
<IsDeleted>24</IsDeleted>
<IsOilConsumptionHidden>true</IsOilConsumptionHidden>
<IsStockCheck>true</IsStockCheck>
<LastCycleCountDate>2025-07-17T05:02:43.6591478+00:00</LastCycleCountDate>
<LastSyncQtyFromQBO>1</LastSyncQtyFromQBO>
<LastSyncQtyToQBO>1</LastSyncQtyToQBO>
<LastSyncTimeToQBO>2025-07-17T05:02:43.6591478+00:00</LastSyncTimeToQBO>
<Location>sample string 15</Location>
<LocationID>1</LocationID>
<LongDesc>sample string 3</LongDesc>
<Make>sample string 13</Make>
<ManufacturerWebsite>sample string 44</ManufacturerWebsite>
<Model>sample string 14</Model>
<ModifiedBy>27</ModifiedBy>
<ModifiedDate>2025-07-17T05:02:43.6591478+00:00</ModifiedDate>
<Notes>sample string 53</Notes>
<OrderUnit>sample string 19</OrderUnit>
<OrderUnitId>1</OrderUnitId>
<PartsFile xmlns:d3p1="http://schemas.datacontract.org/2004/07/">
<d3p1:PartsFile>
<d3p1:ActualFileName>sample string 3</d3p1:ActualFileName>
<d3p1:AddedBy>5</d3p1:AddedBy>
<d3p1:AddedDate>2025-07-17T05:02:43.6591478+00:00</d3p1:AddedDate>
<d3p1:CatalogueFileID>1</d3p1:CatalogueFileID>
<d3p1:CatalogueID>2</d3p1:CatalogueID>
<d3p1:DownloadPath>sample string 7</d3p1:DownloadPath>
<d3p1:FileType>sample string 8</d3p1:FileType>
<d3p1:LinkURL>sample string 9</d3p1:LinkURL>
<d3p1:Note>sample string 10</d3p1:Note>
<d3p1:RenamedFileName>sample string 4</d3p1:RenamedFileName>
</d3p1:PartsFile>
<d3p1:PartsFile>
<d3p1:ActualFileName>sample string 3</d3p1:ActualFileName>
<d3p1:AddedBy>5</d3p1:AddedBy>
<d3p1:AddedDate>2025-07-17T05:02:43.6591478+00:00</d3p1:AddedDate>
<d3p1:CatalogueFileID>1</d3p1:CatalogueFileID>
<d3p1:CatalogueID>2</d3p1:CatalogueID>
<d3p1:DownloadPath>sample string 7</d3p1:DownloadPath>
<d3p1:FileType>sample string 8</d3p1:FileType>
<d3p1:LinkURL>sample string 9</d3p1:LinkURL>
<d3p1:Note>sample string 10</d3p1:Note>
<d3p1:RenamedFileName>sample string 4</d3p1:RenamedFileName>
</d3p1:PartsFile>
</PartsFile>
<PartsImage>sample string 40</PartsImage>
<Price>1</Price>
<QBAssetAccountID>sample string 34</QBAssetAccountID>
<QBDesktopVendorID>1</QBDesktopVendorID>
<QBExpenseAccountID>sample string 33</QBExpenseAccountID>
<QBIncomeAccountID>sample string 32</QBIncomeAccountID>
<QBOEditSequence>sample string 31</QBOEditSequence>
<QBOListID>sample string 30</QBOListID>
<RFID>sample string 29</RFID>
<ReOrderQty>1</ReOrderQty>
<RenamedFileName>sample string 39</RenamedFileName>
<Room>sample string 18</Room>
<Row>sample string 5</Row>
<SerialNo>sample string 8</SerialNo>
<ShortDesc>sample string 2</ShortDesc>
<Sitetype>sample string 45</Sitetype>
<Status>1</Status>
<StatusName>sample string 7</StatusName>
<SubCategory2Name>sample string 36</SubCategory2Name>
<SubCategory3Name>sample string 37</SubCategory3Name>
<SubCategoryID>1</SubCategoryID>
<SubCategoryID2>1</SubCategoryID2>
<SubCategoryID3>1</SubCategoryID3>
<SubCategoryName>sample string 35</SubCategoryName>
<Tax>1</Tax>
<TaxID>1</TaxID>
<TotalRecord>28</TotalRecord>
<UOMQBListID>sample string 21</UOMQBListID>
<Unspc_Code>sample string 10</Unspc_Code>
<Vendor>sample string 43</Vendor>
<VendorQBListID>sample string 22</VendorQBListID>
</ItemDetails>
<ItemName>sample string 2</ItemName>
<ItemType>4</ItemType>
<SerialNo>sample string 1</SerialNo>
<UPC_EAN_Code>sample string 3</UPC_EAN_Code>
</LookupItemResponseModel>
multipart/form-data
Sample:
<LookupItemResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>8</Code><Message>sample string 6</Message><ReturnID>5</ReturnID><Successful>true</Successful><TotalRecord>9</TotalRecord><ItemDetails><AccountGroup>sample string 11</AccountGroup><AccountGroupId>1</AccountGroupId><AddedBy>26</AddedBy><AddedDate>2025-07-17T05:02:43.6591478+00:00</AddedDate><Aisle>sample string 4</Aisle><AvailableQty>1</AvailableQty><Barcode>sample string 9</Barcode><Bin>sample string 6</Bin><Building>sample string 17</Building><CatalogueCode_ProductID>sample string 1</CatalogueCode_ProductID><CatalogueID>1</CatalogueID><Category>sample string 12</Category><CategoryID>1</CategoryID><Cost>1</Cost><CostCode>sample string 41</CostCode><CostCodeName>sample string 42</CostCodeName><Currency>sample string 20</Currency><CurrencyID>1</CurrencyID><Custom1>sample string 55</Custom1><Custom10>sample string 64</Custom10><Custom2>sample string 56</Custom2><Custom3>sample string 57</Custom3><Custom4>sample string 58</Custom4><Custom5>sample string 59</Custom5><Custom6>sample string 60</Custom6><Custom7>sample string 61</Custom7><Custom8>sample string 62</Custom8><Custom9>sample string 63</Custom9><Department>sample string 16</Department><DepartmentId>1</DepartmentId><ImageURL1>sample string 38</ImageURL1><ImageURL2>sample string 46</ImageURL2><ImageURL3>sample string 47</ImageURL3><ImageURL4>sample string 48</ImageURL4><ImageURL5>sample string 49</ImageURL5><ImageURL6>sample string 50</ImageURL6><ImageURL7>sample string 51</ImageURL7><ImageURL8>sample string 52</ImageURL8><IsActive>23</IsActive><IsDeleted>24</IsDeleted><IsOilConsumptionHidden>true</IsOilConsumptionHidden><IsStockCheck>true</IsStockCheck><LastCycleCountDate>2025-07-17T05:02:43.6591478+00:00</LastCycleCountDate><LastSyncQtyFromQBO>1</LastSyncQtyFromQBO><LastSyncQtyToQBO>1</LastSyncQtyToQBO><LastSyncTimeToQBO>2025-07-17T05:02:43.6591478+00:00</LastSyncTimeToQBO><Location>sample string 15</Location><LocationID>1</LocationID><LongDesc>sample string 3</LongDesc><Make>sample string 13</Make><ManufacturerWebsite>sample string 44</ManufacturerWebsite><Model>sample string 14</Model><ModifiedBy>27</ModifiedBy><ModifiedDate>2025-07-17T05:02:43.6591478+00:00</ModifiedDate><Notes>sample string 53</Notes><OrderUnit>sample string 19</OrderUnit><OrderUnitId>1</OrderUnitId><PartsFile xmlns:d3p1="http://schemas.datacontract.org/2004/07/"><d3p1:PartsFile><d3p1:ActualFileName>sample string 3</d3p1:ActualFileName><d3p1:AddedBy>5</d3p1:AddedBy><d3p1:AddedDate>2025-07-17T05:02:43.6591478+00:00</d3p1:AddedDate><d3p1:CatalogueFileID>1</d3p1:CatalogueFileID><d3p1:CatalogueID>2</d3p1:CatalogueID><d3p1:DownloadPath>sample string 7</d3p1:DownloadPath><d3p1:FileType>sample string 8</d3p1:FileType><d3p1:LinkURL>sample string 9</d3p1:LinkURL><d3p1:Note>sample string 10</d3p1:Note><d3p1:RenamedFileName>sample string 4</d3p1:RenamedFileName></d3p1:PartsFile><d3p1:PartsFile><d3p1:ActualFileName>sample string 3</d3p1:ActualFileName><d3p1:AddedBy>5</d3p1:AddedBy><d3p1:AddedDate>2025-07-17T05:02:43.6591478+00:00</d3p1:AddedDate><d3p1:CatalogueFileID>1</d3p1:CatalogueFileID><d3p1:CatalogueID>2</d3p1:CatalogueID><d3p1:DownloadPath>sample string 7</d3p1:DownloadPath><d3p1:FileType>sample string 8</d3p1:FileType><d3p1:LinkURL>sample string 9</d3p1:LinkURL><d3p1:Note>sample string 10</d3p1:Note><d3p1:RenamedFileName>sample string 4</d3p1:RenamedFileName></d3p1:PartsFile></PartsFile><PartsImage>sample string 40</PartsImage><Price>1</Price><QBAssetAccountID>sample string 34</QBAssetAccountID><QBDesktopVendorID>1</QBDesktopVendorID><QBExpenseAccountID>sample string 33</QBExpenseAccountID><QBIncomeAccountID>sample string 32</QBIncomeAccountID><QBOEditSequence>sample string 31</QBOEditSequence><QBOListID>sample string 30</QBOListID><RFID>sample string 29</RFID><ReOrderQty>1</ReOrderQty><RenamedFileName>sample string 39</RenamedFileName><Room>sample string 18</Room><Row>sample string 5</Row><SerialNo>sample string 8</SerialNo><ShortDesc>sample string 2</ShortDesc><Sitetype>sample string 45</Sitetype><Status>1</Status><StatusName>sample string 7</StatusName><SubCategory2Name>sample string 36</SubCategory2Name><SubCategory3Name>sample string 37</SubCategory3Name><SubCategoryID>1</SubCategoryID><SubCategoryID2>1</SubCategoryID2><SubCategoryID3>1</SubCategoryID3><SubCategoryName>sample string 35</SubCategoryName><Tax>1</Tax><TaxID>1</TaxID><TotalRecord>28</TotalRecord><UOMQBListID>sample string 21</UOMQBListID><Unspc_Code>sample string 10</Unspc_Code><Vendor>sample string 43</Vendor><VendorQBListID>sample string 22</VendorQBListID></ItemDetails><ItemName>sample string 2</ItemName><ItemType>4</ItemType><SerialNo>sample string 1</SerialNo><UPC_EAN_Code>sample string 3</UPC_EAN_Code></LookupItemResponseModel>