POST public-api/ic/item/advancedinventorysearch

This method is a robust inventory query similar to the main View Item non tree mode grid. This is a paging API. Requires Allow Item permission and enforces role site permission.



Request Information

URI Parameters

None.

Body Parameters

AdvancedSearchParameters
NameDescriptionTypeAdditional information
TotalCountFromPriorFetch

integer

None.

AdditionalSkipCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Sort

Collection of Object

None.

Filter

TopLevelFilterType

None.

ClientUtcOffset

TimeZoneInfoId

None.

FilterBehavior

FilterBehaviorFlags

None.

IgnoreAttachments

boolean

None.

IgnoreGeoLocation

boolean

None.

WorkingSiteIdCsvList

string

None.

Request Formats

application/json

Sample:
{
  "_sortCriteria": [],
  "TotalCountFromPriorFetch": 1,
  "AdditionalSkipCount": 1,
  "PageSize": 2,
  "PageNumber": 3,
  "Filter": {
    "$id": "1",
    "field": "sample string 1",
    "operator": "sample string 2",
    "value": {},
    "logic": "sample string 4",
    "filters": []
  },
  "ClientUtcOffset": null,
  "FilterBehavior": 0,
  "IgnoreAttachments": true,
  "IgnoreGeoLocation": true,
  "WorkingSiteIdCsvList": "6"
}



Response Information

Resource Description

WaspResultOfListOfInventoryAdvancedInfo
NameDescriptionTypeAdditional information
Data

Collection of InventoryAdvancedInfo

None.

Messages

Collection of WtResult

None.

BatchNumber

integer

None.

HasError

boolean

None.

HasHttpError

boolean

None.

HasMessage

boolean

None.

HasSuccessWithMoreDataRemaining

boolean

None.

TotalRecordsLongCount

integer

None.

Response Formats

application/json

Sample:
{
  "Data": [
    {
      "ItemNumber": "sample string 1",
      "ItemDescription": "sample string 2",
      "CostMethod": 10,
      "ItemType": 0,
      "RowNumber": 3,
      "SiteName": "sample string 4",
      "LocationCode": "sample string 5",
      "ParentContainerId": "sample string 6",
      "TotalAvailable": 1.0,
      "TotalCheckedOut": 1.0,
      "TotalInHouse": 1.0,
      "OnOrder": 1.0,
      "Committed": 1.0,
      "ContainerId": "sample string 7",
      "SerialNumber": "sample string 8",
      "Lot": "sample string 9",
      "DateCodeString": "2026-02-17",
      "DateCode": "2026-02-17T00:00:00",
      "ItemCost": 1.0,
      "ListPrice": 1.0,
      "SalesPrice": 1.0,
      "CategoryDescription": "sample string 11",
      "ManufacturerName": "sample string 12",
      "StockingUnit": "sample string 13",
      "TaxCode": "sample string 14",
      "AlternateItemNumber": "sample string 15",
      "DimensionInfo": {
        "DimensionUnit": "sample string 1",
        "Height": 2.0,
        "Width": 3.0,
        "Depth": 4.0,
        "WeightUnit": "sample string 5",
        "Weight": 6.0,
        "VolumeUnit": "sample string 7",
        "MaxVolume": 8.0
      },
      "CustomFields": [
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-02-17T10:20:39.1814396+00:00",
          "DcfValueRecordStatus": 0
        },
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-02-17T10:20:39.1814396+00:00",
          "DcfValueRecordStatus": 0
        }
      ]
    },
    {
      "ItemNumber": "sample string 1",
      "ItemDescription": "sample string 2",
      "CostMethod": 10,
      "ItemType": 0,
      "RowNumber": 3,
      "SiteName": "sample string 4",
      "LocationCode": "sample string 5",
      "ParentContainerId": "sample string 6",
      "TotalAvailable": 1.0,
      "TotalCheckedOut": 1.0,
      "TotalInHouse": 1.0,
      "OnOrder": 1.0,
      "Committed": 1.0,
      "ContainerId": "sample string 7",
      "SerialNumber": "sample string 8",
      "Lot": "sample string 9",
      "DateCodeString": "2026-02-17",
      "DateCode": "2026-02-17T00:00:00",
      "ItemCost": 1.0,
      "ListPrice": 1.0,
      "SalesPrice": 1.0,
      "CategoryDescription": "sample string 11",
      "ManufacturerName": "sample string 12",
      "StockingUnit": "sample string 13",
      "TaxCode": "sample string 14",
      "AlternateItemNumber": "sample string 15",
      "DimensionInfo": {
        "DimensionUnit": "sample string 1",
        "Height": 2.0,
        "Width": 3.0,
        "Depth": 4.0,
        "WeightUnit": "sample string 5",
        "Weight": 6.0,
        "VolumeUnit": "sample string 7",
        "MaxVolume": 8.0
      },
      "CustomFields": [
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-02-17T10:20:39.1814396+00:00",
          "DcfValueRecordStatus": 0
        },
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-02-17T10:20:39.1814396+00:00",
          "DcfValueRecordStatus": 0
        }
      ]
    }
  ],
  "Messages": [
    {
      "ResultCode": 0,
      "Message": "sample string 1",
      "HttpStatusCode": 200,
      "FieldName": "sample string 2"
    },
    {
      "ResultCode": 0,
      "Message": "sample string 1",
      "HttpStatusCode": 200,
      "FieldName": "sample string 2"
    }
  ],
  "BatchNumber": 1,
  "HasError": false,
  "HasHttpError": false,
  "HasMessage": true,
  "HasSuccessWithMoreDataRemaining": false,
  "TotalRecordsLongCount": 1
}