Application Load
ICategory
The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.
ICategoryCatalog category, localized content and child categories.
src/lib/interfaces/orionplace/category/ICategory.tsexport interface ICategory {
// category identifier
id: number;
// category order supplied by the backend
ordering?: number;
// category view count
c_views?: number;
// Optional value of search_target; it may be omitted.
search_target?: boolean;
// nesting depth
depth: number;
// backend child count; does not guarantee available childs entries
numchild: number;
// large category image
logo_image?: string | null;
// selected image ID
logo_image_id?: number | null;
// category image displayed in the category menu
menu_image?: string | null;
// selected image ID
menu_image_id?: number | null;
// Defaults to false. When true, omit this category and its descendants from
// navigation trees and menus. Keep the returned category data for product
// main-category names, links and breadcrumbs; publication and product
// assignments stay unchanged.
exclude_from_tree?: boolean; // Omit this branch from navigation; retain it for product category lookup.
// root category may be displayed as a separate menu entry
separate_menu: boolean;
// whether the category is public
is_public: boolean;
// number of images available in this category's image storage
c_images: number;
// first representative product ID; the product is stored in Application Load
// product collections
product_rep_1_id?: number | null;
// second representative product ID; may be missing or match the first
product_rep_2_id?: number | null;
// Open Graph SEO data
og?: ISeoOg[] | null;
// Twitter SEO data
twitter?: ISeoTwitter[] | null;
// whether the weight filter is available
weight_filter?: boolean;
// background for logo_image
category_image_bg: string;
// whether to display the localized banner_image (true) or logo_image (false)
use_localized_banner: boolean;
// localized data
locale: Record<string, ICategoryLocale>;
// array of parent category IDs
path_to_top?: number[];
// available child categories; this array defines the menu hierarchy
childs?: ICategory[];
}