CatalogSearchRequest
search_modeSearch mode hint.
qFree text fallback query. Prefer structured fields such as series, description, main_application, compatible_insert, and filters when possible.
item_numberItem number search term.
descriptionProduct description search term.
seriesSeries or family name.
main_applicationMain application category.
sub_applicationSub application category.
compatible_insertInsert model for reverse lookup from insert to compatible tools. Do not use this when searching for the insert item itself; use description plus ITEMTYPE=I instead.
Structured dimensional or attribute filters. Use an array of objects such as [{"field":"DC","op":"eq","value":10}]. Multiple filters are treated as AND conditions.
response_profileResponse detail level.
include_definitionsInclude top-level and item field definitions.
limitMaximum number of records to return.
offsetZero-based pagination offset.
CatalogFilter
fieldField name, such as DC, DCX, RE, ITEMTYPE, or compatible_insert.
opFilter operator.
Expected value for eq, contains, gte, or lte.
Minimum value for between.
Maximum value for between.
MetadataType
CatalogSearchResponse
Normalized request parameters used for the query.
searchModeSearch mode used by the backend.
resultCountTotal matched item count before pagination.
returnedCountNumber of items returned in this response.
hasMoreWhether additional results are available.
Catalog records or metadata records.
warningsNon-fatal warnings.
nextOffsetOffset for the next page, or null when no next page exists.
Definitions for top-level response fields.
Definitions for fields inside items.
Suggested filters that can be added to a follow-up search when resultCount is much larger than returnedCount.
CatalogItem
ITEMNUMItem number.
DESCRIPTIONProduct description.
MainApplicationMain application category.
SubApplicationSub application category.
product_nameProduct name group.
seriesSeries or family name.
compatible_insertCompatible insert model or MIID value.