OBJECT

Category

Category object - categories group products and can contain children categories as well

link GraphQL Schema definition

  • type Category {
  • # An ID that uniquely identifies the category
  • id: ID
  • # An ID that uniquely identifies the parent category
  • parent_id: ID
  • # An optional description of the category
  • description: String
  • # The display name of the category
  • name: String
  • # Is active category
  • is_active: Boolean
  • # Category Path
  • path: String
  • # Category path in store
  • path_in_store: String
  • # The url key assigned to the category
  • url_key: String
  • # The url path assigned to the category
  • url_path: String
  • # The position of the category relative to other categories at the same level in
  • # tree
  • position: Int
  • # Indicates the depth of the category within the tree
  • level: Int
  • # Timestamp indicating when the category was created
  • created_at: DateTime
  • # Timestamp indicating when the category was updated
  • updated_at: DateTime
  • # The number of products in the category
  • product_count: Int
  • # The attribute to use for sorting
  • default_sort_by: String
  • # Children category data
  • children_data: [Category]
  • # Children category data
  • children: [Category]
  • # Category children count
  • children_count: Int
  • # Available sorting option for category
  • available_sort_by: [String]
  • # Include category to navigation menu
  • include_in_menu: Boolean
  • # Category display mode
  • display_mode: String
  • # Is filter avalaible in category
  • is_anchor: Boolean
  • # Category page layout
  • page_layout: String
  • # Get the products assigned to this category
  • #
  • # Arguments
  • # filter: Identifies which product attributes to search for and
  • # return.
  • # search: Performs a full-text search using the specified key
  • # words.
  • # pageSize: Specifies the maximum number of results to return at
  • # once. This attribute is optional.
  • # currentPage: Specifies which page of results to return. The
  • # default value is 1.
  • # sort: Specifies which attribute to sort on, and whether to
  • # return the results in ascending or descending order.
  • # _sourceIncludes: Specifies which attribute we include in
  • # result.
  • # _sourceExcludes: Specifies which attribute we exclude in
  • # result.
  • products(
  • filter: ProductFilterInput,
  • search: String,
  • pageSize: Int,
  • currentPage: Int,
  • sort: ProductSortInput,
  • _sourceIncludes: [String],
  • _sourceExcludes: [String]
  • ): Products
  • }