Skip to main content

Category

No description

type Category {
  id: Int! @deprecated
  categoryId: Int!
  attributeValues(
    filter: AttributeFilterInput
  ): AttributeValueResponse!
  name(
    language: String
  ): [LocalizedString!]!
  description(
    language: String
  ): [LocalizedString!]!
  shortDescription(
    language: String
  ): [LocalizedString!]!
  slug(
    language: String
  ): [LocalizedString!]!
  path: String!
  categories: [Category!]
  parent: Category
  defaultLanguage: String!
  categoryPath: [Category!]!
  products(
    term: String
    manufacturer: [String!]
    supplierCode: [String!]
    supplier: [String!]
    manufacturerCode: [String!]
    EANCode: [String!]
    id: [Int!]
    classId: [Int!]
    class: ProductClass
    tag: [String!]
    language: String! = NL
    page: Int! = 1
    offset: Int! = 12
    textFilters: [TextFilterInput!]
    rangeFilters: [RangeFilterInput!]
    price: PriceFilterInput
    status: [ProductStatus!] = [A]
    hidden: Boolean
    sort: [SortInput!]
    searchFields: [SearchFieldsInput!]
    hasBundle: YesNo
    isBundleLeader: YesNo
    parentSlug: String
    pathSlug: String
    userId: Int
    getDescendants: Boolean = true
    sku: [String!]
  ): ProductsResponse!
}

Fields

`Category.id` ● `Int!` deprecated non-null scalar

DEPRECATED
This property is no longer relevant or necessary, use categoryId instead.

`Category.categoryId` ● `Int!` non-null scalar

`Category.attributeValues` ● `AttributeValueResponse!` non-null object

Returns a paginated response of AttributeValues

Category.attributeValues.filter ● AttributeFilterInput input

`Category.name` ● `[LocalizedString!]!` non-null object

Localized category name as it is available in the supported language defaults to the category's default language.

Category.name.language ● String scalar

`Category.description` ● `[LocalizedString!]!` non-null object

The long description for this category, this field can contain html formatting, this field can be translated is case of multilingual catalog

Category.description.language ● String scalar

`Category.shortDescription` ● `[LocalizedString!]!` non-null object

The short description for this category, this field can contain html formatting, this field can be translated is case of multilingual catalog

Category.shortDescription.language ● String scalar

`Category.slug` ● `[LocalizedString!]!` non-null object

The slug for this category, each available language contains a different slug

Category.slug.language ● String scalar

`Category.path` ● `String!` non-null scalar

The path in id's to the root of the inheritance tree, can be passed as parameter to the productsearch API

`Category.categories` ● `[Category!]` list object

`Category.parent` ● `Category` object

The category's parent Category when available

`Category.defaultLanguage` ● `String!` non-null scalar

`Category.categoryPath` ● `[Category!]!` non-null object

`Category.products` ● `ProductsResponse!` non-null object

Category.products.term ● String scalar

Product search term

`Category.products.manufacturer` ● `[String!]` list scalar

List of product manufacturers

`Category.products.supplierCode` ● `[String!]` list scalar

List of product supplier codes

`Category.products.supplier` ● `[String!]` list scalar

List of product suppliers

`Category.products.manufacturerCode` ● `[String!]` list scalar

List of product manufacturer codes

`Category.products.EANCode` ● `[String!]` list scalar

List of product EAN codes

`Category.products.id` ● `[Int!]` list scalar

List of unique product identifiers

`Category.products.classId` ● `[Int!]` list scalar

List of unique class identifier

`Category.products.class` ● `ProductClass` enum

Product class

`Category.products.tag` ● `[String!]` list scalar

List of product tags

`Category.products.language` ● `String!` non-null scalar

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

`Category.products.page` ● `Int!` non-null scalar

Pagination page number [default=1]

`Category.products.offset` ● `Int!` non-null scalar

Pagination offset number [default=12]

`Category.products.textFilters` ● `[TextFilterInput!]` list input

List of text filters

`Category.products.rangeFilters` ● `[RangeFilterInput!]` list input

List of range filters

`Category.products.price` ● `PriceFilterInput` input

Product price filter

`Category.products.status` ● `[ProductStatus!]` list enum

List of product status filters

`Category.products.hidden` ● `Boolean` scalar

Is product hidden?

`Category.products.sort` ● `[SortInput!]` list input

List of product sort filters

`Category.products.searchFields` ● `[SearchFieldsInput!]` list input

Product supplier code

`Category.products.hasBundle` ● `YesNo` enum

Product supplier code

`Category.products.isBundleLeader` ● `YesNo` enum

Product supplier code

`Category.products.parentSlug` ● `String` scalar

Product parent slug

`Category.products.pathSlug` ● `String` scalar

Product path slug

`Category.products.userId` ● `Int` scalar

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

`Category.products.getDescendants` ● `Boolean` scalar

Get all descending products (true) or only the direct child products of this category (false)

`Category.products.sku` ● `[String!]` list scalar

List of product SKUs

Returned By

category query ● categoryCreate mutation ● categoryUpdate mutation

Member Of

Category object ● CategoryResponse object ● Cluster object ● Product object