Skip to main content

CategoryProductSearchInput

No description

input CategoryProductSearchInput {
  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! = NL
  page: Int! = 1
  offset: Int! = 12
  textFilters: [ProductTextFilterInput!]
  rangeFilters: [ProductRangeFilterInput!]
  price: ProductPriceFilterInput
  inventory: ProductSearchInventoryFilterInput
  statuses: [ProductStatus!]! = A
  hidden: Boolean
  sortInputs: [ProductSortInput!]
  searchFields: [SearchFieldsInput!]
  hasBundle: YesNo
  isBundleLeader: YesNo
  containerSlugs: [String!]
  userId: Int
  companyId: Int
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
  getDescendants: Boolean = true
  applyOrderlists: Boolean = true
  orderlistIds: [Int!]
}

Fields​

CategoryProductSearchInput.term ● String scalar​

Product search term

CategoryProductSearchInput.manufacturers ● [String!] list scalar​

List of product manufacturers

CategoryProductSearchInput.supplierCodes ● [String!] list scalar​

List of product supplier codes

CategoryProductSearchInput.suppliers ● [String!] list scalar​

List of product suppliers

CategoryProductSearchInput.manufacturerCodes ● [String!] list scalar​

List of product manufacturer codes

CategoryProductSearchInput.EANCodes ● [String!] list scalar​

List of product EAN codes

CategoryProductSearchInput.skus ● [String!] list scalar​

List of product SKUS

CategoryProductSearchInput.ids ● [Int!] list scalar​

List of unique product identifiers

CategoryProductSearchInput.productIds ● [Int!] list scalar​

List of productIds to search for

CategoryProductSearchInput.clusterIds ● [Int!] list scalar​

List of clusterIds to search for

CategoryProductSearchInput.class ● ProductClass enum​

Product class

CategoryProductSearchInput.tags ● [String!] list scalar​

List of product tags

CategoryProductSearchInput.language ● String! non-null scalar​

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

CategoryProductSearchInput.page ● Int! non-null scalar​

Pagination page number [default=1]

CategoryProductSearchInput.offset ● Int! non-null scalar​

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

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

CategoryProductSearchInput.textFilters ● [ProductTextFilterInput!] list input​

List of text filters

CategoryProductSearchInput.rangeFilters ● [ProductRangeFilterInput!] list input​

List of range filters

CategoryProductSearchInput.price ● ProductPriceFilterInput input​

Product price filter

CategoryProductSearchInput.inventory ● ProductSearchInventoryFilterInput input​

Filter by inventory quantity ranges (totalQuantity, localQuantity, supplierQuantity). Inventory applies to products; a cluster matches when at least one underlying product is in range.

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

List of product status filters

CategoryProductSearchInput.hidden ● Boolean scalar​

Is product hidden?

CategoryProductSearchInput.sortInputs ● [ProductSortInput!] list input​

List of product sort filters

CategoryProductSearchInput.searchFields ● [SearchFieldsInput!] list input​

List of product search fields

CategoryProductSearchInput.hasBundle ● YesNo enum​

Is product in a bundle

CategoryProductSearchInput.isBundleLeader ● YesNo enum​

Is product a bundle leader

CategoryProductSearchInput.containerSlugs ● [String!] list scalar​

Product container slug(s)

CategoryProductSearchInput.userId ● Int scalar​

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

CategoryProductSearchInput.companyId ● Int scalar​

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

CategoryProductSearchInput.createdAt ● DateSearchInput input​

Search by date created

CategoryProductSearchInput.lastModifiedAt ● DateSearchInput input​

Search by date changed

CategoryProductSearchInput.getDescendants ● Boolean scalar​

Include descendants of the specified categoryId

CategoryProductSearchInput.applyOrderlists ● Boolean scalar​

Apply orderlist filtering to search results

CategoryProductSearchInput.orderlistIds ● [Int!] list scalar​

Order list IDs to apply for filtering