POST public-api/ic/item/inventorysearch

This method is a simple inventory query similar to what is found on the Edit Item screen or on the mobile devices. Requires Allow Item permission and enforces role site permission.



Request Information

URI Parameters

None.

Body Parameters

InventorySearchParameters
NameDescriptionTypeAdditional information
ItemNumber

the unique identifier for this item

string

None.

SiteName

site where the inventory is located

string

None.

LocationCode

location of where the inventory is located

string

None.

SerialNumber

the unique serial number of this item

string

None.

Lot

the lot of this inventory

string

None.

DateCode

the date code in a DateTime format for this inventory

date

None.

Request Formats

application/json

Sample:
{
  "LocationCode": "R1.S1.R1"
}



Response Information

Resource Description

WaspResultOfListOfInventoryInfo
NameDescriptionTypeAdditional information
Data

Type specific result that always depends on the function called.

Collection of InventoryInfo

None.

Messages

List of Messages. All APIs should return messages. If an API function returns an error you can find more information about the error or errors in this collection of messages.

Collection of WtResult

None.

BatchNumber

This is a global batch number generated by a mass group of transaction records to be returned to the consumer on each call to rolling transaction rules. This requests that each group of Move/Add/Remove transaction batches is tied together. In prior products (such as Mobile Asset Cloud), all are set to null and the only time when the batch number is generated is for multiple check-out transactions but the old is to generate for each responsible party.

integer

None.

HasError

True if an API function result has an error message in the results. If this is false, the function succeeded but other informative messages may be available.

boolean

None.

HasHttpError

True if an API function call could not be fully posted to the server or the results could not be fully returned.

boolean

None.

HasMessage

True if any message is available.

boolean

None.

HasSuccessWithMoreDataRemaining

True if the server sent part of the data and there is more data available. Use with paging APIs to fetch data one page at a time.

boolean

None.

TotalRecordsLongCount

This is the total number of records available in the database based on the query and filer conditions provided. It is possible that the value can change from call to call as users add and delete records so this should not be used to page through multiple recordsets of data. This is used, for example, to set relative scroll bar sizes. When paging through data using functions like the assetadvancedinfosearch, calculating TotalRecordsLongCount for every page full of data is an time-consuming operation. To avoid that extra calculation, and help prevent throttling, assign TotalRecordsLongCount to TotalCountFromPriorFetch in the AdvancedSearchParameters to skip recalculating this total page count and to page thru the records faster.

integer

None.

Response Formats

application/json

Sample:
{
  "Data": [
    {
      "ItemNumber": "403226",
      "ItemDescription": "Plate 2X2 Round",
      "ItemType": 2147483635,
      "SiteName": "Warehouse 1",
      "LocationCode": "R1.S1.R1",
      "TotalQty": 669.0,
      "CheckedOutQty": 0.0,
      "AlternateItemNumber": ""
    },
    {
      "ItemNumber": "4210631",
      "ItemDescription": "Radiator Grille 1X2",
      "ItemType": 2147483635,
      "SiteName": "Warehouse 1",
      "LocationCode": "R1.S1.R1",
      "TotalQty": 433.0,
      "CheckedOutQty": 0.0,
      "AlternateItemNumber": ""
    },
    {
      "ItemNumber": "4218750",
      "ItemDescription": "Plate W. Bows 2X1�",
      "ItemType": 2147483635,
      "SiteName": "Warehouse 1",
      "LocationCode": "R1.S1.R1",
      "TotalQty": 685.0,
      "CheckedOutQty": 0.0,
      "AlternateItemNumber": ""
    },
    {
      "ItemNumber": "4211735",
      "ItemDescription": "Left Plate 2X4 W/Angle",
      "ItemType": 2147483635,
      "SiteName": "Warehouse 2",
      "LocationCode": "R1.S1.R1",
      "TotalQty": 912.0,
      "CheckedOutQty": 0.0,
      "AlternateItemNumber": ""
    },
    {
      "ItemNumber": "4211794",
      "ItemDescription": "Left Plate 2X3 W/Angle",
      "ItemType": 2147483635,
      "SiteName": "Warehouse 1",
      "LocationCode": "R1.S1.R1",
      "TotalQty": 351.0,
      "CheckedOutQty": 0.0,
      "AlternateItemNumber": ""
    },
    {
      "ItemNumber": "6051389",
      "ItemDescription": "Light Sword Stock, No. '1000'",
      "ItemType": 2147483635,
      "SiteName": "Warehouse 2",
      "LocationCode": "R1.S1.R1",
      "TotalQty": 909.0,
      "CheckedOutQty": 0.0,
      "AlternateItemNumber": ""
    },
    {
      "ItemNumber": "4268684",
      "ItemDescription": "Thill For Gig",
      "ItemType": 2147483635,
      "SiteName": "Warehouse 1",
      "LocationCode": "R1.S1.R1",
      "TotalQty": 161.0,
      "CheckedOutQty": 0.0,
      "AlternateItemNumber": ""
    },
    {
      "ItemNumber": "4211409",
      "ItemDescription": "Roof Tile 2X4/45�",
      "ItemType": 2147483635,
      "SiteName": "Warehouse 2",
      "LocationCode": "R1.S1.R1",
      "TotalQty": 109.0,
      "CheckedOutQty": 0.0,
      "AlternateItemNumber": ""
    },
    {
      "ItemNumber": "4539064",
      "ItemDescription": "Corner Plate 45 Deg. 3X3",
      "ItemType": 2147483635,
      "SiteName": "Warehouse 1",
      "LocationCode": "R1.S1.R1",
      "TotalQty": 585.0,
      "CheckedOutQty": 0.0,
      "AlternateItemNumber": ""
    },
    {
      "ItemNumber": "4512823",
      "ItemDescription": "Mini Upper Part No.'1340'",
      "ItemType": 2147483635,
      "SiteName": "Warehouse 2",
      "LocationCode": "R1.S1.R1",
      "TotalQty": 555.0,
      "CheckedOutQty": 0.0,
      "AlternateItemNumber": ""
    },
    {
      "ItemNumber": "4211489",
      "ItemDescription": "Roof Tile 1X3/25� Inv.",
      "ItemType": 2147483635,
      "SiteName": "Warehouse 2",
      "LocationCode": "R1.S1.R1",
      "TotalQty": 112.0,
      "CheckedOutQty": 0.0,
      "AlternateItemNumber": ""
    },
    {
      "ItemNumber": "4218868",
      "ItemDescription": "Disk �24",
      "ItemType": 2147483635,
      "SiteName": "Warehouse 1",
      "LocationCode": "R1.S1.R1",
      "TotalQty": 627.0,
      "CheckedOutQty": 0.0,
      "AlternateItemNumber": ""
    },
    {
      "ItemNumber": "10178-1",
      "ItemDescription": "Motorized Walking AT-AT",
      "ItemType": 2147483638,
      "SiteName": "Warehouse 1",
      "LocationCode": "R1.S1.R1",
      "TotalQty": 5.0,
      "CheckedOutQty": 0.0,
      "AlternateItemNumber": ""
    }
  ],
  "Messages": [],
  "HasSuccessWithMoreDataRemaining": false,
  "HasError": false,
  "HasMessage": false,
  "HasHttpError": false
}