Alokai

CategoryInterface

Contains the full set of attributes that can be returned in a category search.

type CategoryInterface = {
  available_sort_by?: Maybe<Array<Maybe<Scalars['String']['output']>>>; /** An array of breadcrumb items. */
  breadcrumbs?: Maybe<Array<Maybe<Breadcrumb>>>; /** The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled. */
  canonical_url?: Maybe<Scalars['String']['output']>;
  children_count?: Maybe<Scalars['String']['output']>; /** Contains a category CMS block. */
  cms_block?: Maybe<CmsBlock>;
  created_at?: Maybe<Scalars['String']['output']>;
  custom_layout_update_file?: Maybe<Scalars['String']['output']>; /** The attribute to use for sorting. */
  default_sort_by?: Maybe<Scalars['String']['output']>; /** An optional description of the category. */
  description?: Maybe<Scalars['String']['output']>;
  display_mode?: Maybe<Scalars['String']['output']>;
  filter_price_range?: Maybe<Scalars['Float']['output']>;
  id?: Maybe<Scalars['Int']['output']>;
  image?: Maybe<Scalars['String']['output']>;
  include_in_menu?: Maybe<Scalars['Int']['output']>;
  is_anchor?: Maybe<Scalars['Int']['output']>;
  landing_page?: Maybe<Scalars['Int']['output']>; /** The depth of the category within the tree. */
  level?: Maybe<Scalars['Int']['output']>;
  meta_description?: Maybe<Scalars['String']['output']>;
  meta_keywords?: Maybe<Scalars['String']['output']>;
  meta_title?: Maybe<Scalars['String']['output']>; /** The display name of the category. */
  name?: Maybe<Scalars['String']['output']>; /** The full category path. */
  path?: Maybe<Scalars['String']['output']>; /** The category path within the store. */
  path_in_store?: Maybe<Scalars['String']['output']>; /** The position of the category relative to other categories at the same level in tree. */
  position?: Maybe<Scalars['Int']['output']>; /** The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not. */
  product_count?: Maybe<Scalars['Int']['output']>; /** The list of products assigned to the category. */
  products?: Maybe<CategoryProducts>; /** The unique ID for a `CategoryInterface` object. */
  uid: Scalars['ID']['output'];
  updated_at?: Maybe<Scalars['String']['output']>; /** The URL key assigned to the category. */
  url_key?: Maybe<Scalars['String']['output']>; /** The URL path assigned to the category. */
  url_path?: Maybe<Scalars['String']['output']>; /** The part of the category URL that is appended after the url key */
  url_suffix?: Maybe<Scalars['String']['output']>;
};

Referenced Types

On this page