OBJECT

Category

link GraphQL Schema definition

  • type Category implements Document {
  • breadcrumbText: String
  • content: String
  • hasSubcategories: Boolean
  • # NB: Carries a performance cost, as asking for this will result in a separate API
  • # call in the backend.
  • head: HtmlHead
  • id: Int!
  • images: [CategoryImage]
  • # A dynamic category has no fixed products; products are dynamically included
  • # based on filters defined on the category in Admin. N.B. Products found on a
  • # dynamic category has no route that includes said category, instead
  • # product.primaryRoute will have to be used.
  • isDynamic: Boolean!
  • # Whether or not this category and all its children are considered hidden
  • isHidden: Boolean! @deprecated( reason: "This field should no longer be used and will always be false." )
  • level: Int!
  • # When empty will display the value of the name field
  • mainHeader: String
  • name: String!
  • parent: Category
  • parentCategory: Category @deprecated( reason: "Use parent instead" )
  • parentId: Int @deprecated( reason: "Use parent.id instead" )
  • # The primary route of this Category. NB: Carries a performance cost, as asking
  • # for this will result in a separate API call in the backend.
  • primaryRoute: Route
  • # NB: Carries a performance cost, as asking for this will result in a separate API
  • # call in the backend.
  • #
  • # Arguments
  • # first: [Not documented]
  • # offset: [Not documented]
  • # orderBy: [Not documented]
  • # orderByDirection: [Not documented]
  • # filters: [Not documented]
  • products(
  • first: Paging,
  • offset: Int,
  • orderBy: ProductOrderOptions,
  • orderByDirection: SortDirection,
  • filters: FilterInput
  • ): PagedResult
  • subcategories: [Category]
  • }

link Require by