Skip to main content

CategoryBaseProductsSearchInput

No description

input CategoryBaseProductsSearchInput {
  term: String
  types: [ProductClass!]
  statuses: [ProductStatus!]
  manufacturers: [String!]
  suppliers: [String!]
  hidden: Boolean
  getDescending: YesNo
  page: Int
  offset: Int
  language: String
  sortBy: BaseProductSortField
  sortOrder: SortOrder
  source: String
  sourceIds: [String!]
  applyOrderlists: Boolean = true
  orderlistIds: [Int!]
  userId: Int
  companyId: Int
}

Fields

`CategoryBaseProductsSearchInput.term` ● `String` scalar

Search term for SKU and localized content

`CategoryBaseProductsSearchInput.types` ● `[ProductClass!]` list enum

Filter by base product types

`CategoryBaseProductsSearchInput.statuses` ● `[ProductStatus!]` list enum

Filter by product statuses (applies to PRODUCT type only)

`CategoryBaseProductsSearchInput.manufacturers` ● `[String!]` list scalar

Filter by manufacturers (applies to PRODUCT type only)

`CategoryBaseProductsSearchInput.suppliers` ● `[String!]` list scalar

Filter by suppliers (applies to PRODUCT type only)

`CategoryBaseProductsSearchInput.hidden` ● `Boolean` scalar

Filter base products by hidden status. true = only hidden, false = only non-hidden, null = no filter.

`CategoryBaseProductsSearchInput.getDescending` ● `YesNo` enum

Include products from descendant categories

`CategoryBaseProductsSearchInput.page` ● `Int` scalar

Page number for pagination

`CategoryBaseProductsSearchInput.offset` ● `Int` scalar

Number of items per page

`CategoryBaseProductsSearchInput.language` ● `String` scalar

Language for localized content

`CategoryBaseProductsSearchInput.sortBy` ● `BaseProductSortField` enum

Field to sort by

`CategoryBaseProductsSearchInput.sortOrder` ● `SortOrder` enum

Sort order

`CategoryBaseProductsSearchInput.source` ● `String` scalar

Source system name (must be used with sourceIds)

`CategoryBaseProductsSearchInput.sourceIds` ● `[String!]` list scalar

Source IDs to filter by (must be used with source)

`CategoryBaseProductsSearchInput.applyOrderlists` ● `Boolean` scalar

Whether to apply orderlist filtering

`CategoryBaseProductsSearchInput.orderlistIds` ● `[Int!]` list scalar

Order list IDs to apply for filtering

`CategoryBaseProductsSearchInput.userId` ● `Int` scalar

Browse catalog as a specific User. Permissions, orderlists, favorite will be merged with the logged in user.

`CategoryBaseProductsSearchInput.companyId` ● `Int` scalar

Browse catalog as a specific Company. Permissions, orderlists, favorite will be merged with the logged in user.

Fields