ProductSearchInput

Advanced product search criteria with category and orderlist filtering.

Extends base product search functionality with category-specific filtering, SKU-based searches, and orderlist-based product visibility controls. Supports hierarchical category navigation and customer-specific product access.

input ProductSearchInput {
  term: String
  manufacturers: [String!]
  supplierCodes: [String!]
  suppliers: [String!]
  manufacturerCodes: [String!]
  EANCodes: [String!]
  ids: [Int!]
  productIds: [Int!]
  clusterIds: [Int!]
  class: ProductClass
  tags: [String!]
  language: String!
  page: Int!
  offset: Int!
  textFilters: [ProductTextFilterInput!]
  rangeFilters: [ProductRangeFilterInput!]
  price: ProductPriceFilterInput
  statuses: [ProductStatus!]!
  hidden: Boolean
  sortInputs: [ProductSortInput!]
  searchFields: [SearchFieldsInput!]
  hasBundle: YesNo
  isBundleLeader: YesNo
  containerSlugs: [String!]
  containerPathSlugs: [String!]
  userId: Int
  companyId: Int
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
  path: String
  categoryId: Int
  skus: [String!]
  getDescendants: Boolean
  applyOrderlists: Boolean
  orderlistIds: [Int!]
}

Fields

ProductSearchInput.term ● String scalar

General search term for product discovery.

Searches across product names, descriptions, keywords, SKUs, and other searchable fields. Supports partial matching and relevance-based ranking.

ProductSearchInput.manufacturers ● [String!] list scalar

Filter by product manufacturers.

Returns products from any of the specified manufacturers. Useful for brand-based filtering and manufacturer-specific product catalogs.

ProductSearchInput.supplierCodes ● [String!] list scalar

Filter by supplier product codes.

Returns products matching any of the specified supplier codes. Used for supplier-specific product identification and cross-referencing.

ProductSearchInput.suppliers ● [String!] list scalar

Filter by product suppliers.

Returns products from any of the specified suppliers. Useful for supplier-based filtering and procurement-focused searches.

ProductSearchInput.manufacturerCodes ● [String!] list scalar

Filter by manufacturer product codes.

Returns products matching any of the specified manufacturer codes (OEM codes). Used for cross-referencing and manufacturer-specific identification.

ProductSearchInput.EANCodes ● [String!] list scalar

Filter by European Article Numbers (EAN).

Returns products matching any of the specified EAN codes. Used for barcode-based product identification and inventory management.

ProductSearchInput.ids ● [Int!] list scalar

Filter by specific product identifiers.

Returns products whose IDs match the provided list. Useful for retrieving specific products or bulk operations.

ProductSearchInput.productIds ● [Int!] list scalar

Filter by product identifiers.

Returns products matching any of the specified product IDs. Alternative to 'ids' field for product identification.

ProductSearchInput.clusterIds ● [Int!] list scalar

Filter by product cluster identifiers.

Returns products belonging to any of the specified clusters. Used for finding configurable products and product groups.

ProductSearchInput.class ● ProductClass enum

Filter by product classification.

Returns products of the specified class type (e.g. product, cluster). Used for business logic and fulfillment routing.

ProductSearchInput.tags ● [String!] list scalar

Filter by product tags.

Returns products that have any of the specified tags. Used for promotional grouping, seasonal filtering, and custom product categorization.

ProductSearchInput.language ● String! non-null scalar

Language for search processing.

ISO 639-1 uppercase language code that determines which language-specific fields are used for searching. Does not affect the language of returned content (use language-specific resolvers for that).

ProductSearchInput.page ● Int! non-null scalar

Page number for pagination.

Specifies which page of results to return. Must be 1 or greater. Default is 1.

ProductSearchInput.offset ● Int! non-null scalar

Number of items per page.

Controls how many products are returned in each page. Default is 12, maximum is 500. Values over 500 will be capped to 500.

ProductSearchInput.textFilters ● [ProductTextFilterInput!] list input

List of text filters

ProductSearchInput.rangeFilters ● [ProductRangeFilterInput!] list input

List of range filters

ProductSearchInput.price ● ProductPriceFilterInput input

Product price filter

ProductSearchInput.statuses ● [ProductStatus!]! non-null enum

List of product status filters

ProductSearchInput.hidden ● Boolean scalar

Is product hidden?

ProductSearchInput.sortInputs ● [ProductSortInput!] list input

List of product sort filters

ProductSearchInput.searchFields ● [SearchFieldsInput!] list input

List of product search fields

ProductSearchInput.hasBundle ● YesNo enum

Is product in a bundle

ProductSearchInput.isBundleLeader ● YesNo enum

Is product a bundle leader

ProductSearchInput.containerSlugs ● [String!] list scalar

Product container slug(s)

ProductSearchInput.containerPathSlugs ● [String!] list scalar

Product path slug(s)

ProductSearchInput.userId ● Int scalar

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

ProductSearchInput.companyId ● Int scalar

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

ProductSearchInput.createdAt ● DateSearchInput input

Search by date created

ProductSearchInput.lastModifiedAt ● DateSearchInput input

Search by date changed

ProductSearchInput.path ● String scalar

Category path for hierarchical navigation.

Slash-separated category path (e.g., 'electronics/computers/laptops') used for category-based product filtering and navigation.

ProductSearchInput.categoryId ● Int scalar

Category identifier for product filtering.

Filters products to only those belonging to the specified category. Use with getDescendants to control whether subcategory products are included.

ProductSearchInput.skus ● [String!] list scalar

Filter by specific product SKUs.

Returns only products whose SKUs match the provided list. Useful for retrieving specific products or bulk product operations.

ProductSearchInput.getDescendants ● Boolean scalar

Include products from subcategories.

When true, includes products from all descendant categories of the specified categoryId. When false, returns only products directly assigned to the specified category.

ProductSearchInput.applyOrderlists ● Boolean scalar

Enable orderlist-based product filtering.

When true, applies orderlist restrictions to determine product visibility based on customer permissions and access rights.

ProductSearchInput.orderlistIds ● [Int!] list scalar

Specific orderlists to apply for product filtering.

List of orderlist IDs to use for determining product visibility. If not specified, uses default orderlists based on customer context.

Member Of

products query