Skip to main content

ProductSearchByCategoryInput

No description

input ProductSearchByCategoryInput {
  categoryIds: [Int!]!
  getDescendants: Boolean
  term: String
  manufacturers: [String!]
  supplierCodes: [String!]
  suppliers: [String!]
  manufacturerCodes: [String!]
  EANCodes: [String!]
  skus: [String!]
  ids: [Int!]
  productIds: [Int!]
  clusterIds: [Int!]
  class: ProductClass
  tags: [String!]
  language: String!
  page: Int!
  offset: Int!
  textFilters: [ProductSearchTextFilterInput!]
  rangeFilters: [ProductSearchRangeFilterInput!]
  price: ProductSearchPriceFilterInput
  priceSheetIds: [String!]
  statuses: [ProductStatus!]!
  hidden: Boolean
  sortInputs: [ProductSearchSortInput!]
  searchFields: [ProductSearchFieldsInput!]
  hasBundle: YesNo
  isBundleLeader: YesNo
  userId: Int
  companyId: Int
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
  facets: [ProductSearchFacetInput!]
  applyOrderlists: Boolean
  orderlistIds: [Int!]
}

Fields​

ProductSearchByCategoryInput.categoryIds ● [Int!]! non-null scalar​

List of category IDs to search. Each category will be searched separately.

ProductSearchByCategoryInput.getDescendants ● Boolean scalar​

Include descendants of each category in the search

ProductSearchByCategoryInput.term ● String scalar​

Product search term

ProductSearchByCategoryInput.manufacturers ● [String!] list scalar​

List of product manufacturers

ProductSearchByCategoryInput.supplierCodes ● [String!] list scalar​

List of product supplier codes

ProductSearchByCategoryInput.suppliers ● [String!] list scalar​

List of product suppliers

ProductSearchByCategoryInput.manufacturerCodes ● [String!] list scalar​

List of product manufacturer codes

ProductSearchByCategoryInput.EANCodes ● [String!] list scalar​

List of product EAN codes

ProductSearchByCategoryInput.skus ● [String!] list scalar​

List of product SKUS

ProductSearchByCategoryInput.ids ● [Int!] list scalar​

List of unique product identifiers

ProductSearchByCategoryInput.productIds ● [Int!] list scalar​

List of productIds to search for

ProductSearchByCategoryInput.clusterIds ● [Int!] list scalar​

List of clusterIds to search for

ProductSearchByCategoryInput.class ● ProductClass enum​

Product class

ProductSearchByCategoryInput.tags ● [String!] list scalar​

List of product tags

ProductSearchByCategoryInput.language ● String! non-null scalar​

Specify through which language to search in, has no effect on other returned fields (eg. names,slugs)

ProductSearchByCategoryInput.page ● Int! non-null scalar​

Pagination page number [default=1]

ProductSearchByCategoryInput.offset ● Int! non-null scalar​

Pagination offset number [default=12][max: 500]

NOTE: If offset > 500 is supplied it will be capped to 500

ProductSearchByCategoryInput.textFilters ● [ProductSearchTextFilterInput!] list input​

List of text filters

ProductSearchByCategoryInput.rangeFilters ● [ProductSearchRangeFilterInput!] list input​

List of range filters

ProductSearchByCategoryInput.price ● ProductSearchPriceFilterInput input​

Product price filter

ProductSearchByCategoryInput.priceSheetIds ● [String!] list scalar​

List of priceSheetIds (UUIDs) ordered by priority. The first priceSheetId has highest priority. Used to determine customer-specific pricing for sorting, filtering, and aggregation. When not provided, the default price is used.

ProductSearchByCategoryInput.statuses ● [ProductStatus!]! non-null enum​

List of product status filters

ProductSearchByCategoryInput.hidden ● Boolean scalar​

Is product hidden?

ProductSearchByCategoryInput.sortInputs ● [ProductSearchSortInput!] list input​

List of product sort filters

ProductSearchByCategoryInput.searchFields ● [ProductSearchFieldsInput!] list input​

List of product search fields

ProductSearchByCategoryInput.hasBundle ● YesNo enum​

Is product in a bundle

ProductSearchByCategoryInput.isBundleLeader ● YesNo enum​

Is product a bundle leader

ProductSearchByCategoryInput.userId ● Int scalar​

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

ProductSearchByCategoryInput.companyId ● Int scalar​

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

ProductSearchByCategoryInput.createdAt ● DateSearchInput input​

Search by date created

ProductSearchByCategoryInput.lastModifiedAt ● DateSearchInput input​

Search by date changed

ProductSearchByCategoryInput.facets ● [ProductSearchFacetInput!] list input​

List of attribute IDs to include in faceted aggregations

ProductSearchByCategoryInput.applyOrderlists ● Boolean scalar​

Apply orderlist filtering to search results

ProductSearchByCategoryInput.orderlistIds ● [Int!] list scalar​

Order list IDs to apply for filtering

Member Of​

productSearchByCategory query