Catalog Modul

Back

Overview

The Catalog module is responsible for managing all product-related master data.
It defines how products are described, classified and enriched before they are used
by pricing, inventory and sales modules.

Catalog is a foundational module and is required for:

• product listings
• search and filtering
• pricing configuration
• inventory management
• SEO and merchandising

All operations are tenant-aware and scoped to the current tenant.

Services

The Catalog module consists of the following services:

• Brands - product brands and manufacturers
• Category - product categories and hierarchies
• Products - core product data
• Product Category - product category relations
• Product Colour - colour variants
• Product Size - size variants
• Product SEO - SEO metadata
• Product Property Value - dynamic product attributes
• Related Product - related and cross-sell products
• Property - attribute and property definitions

Models

This module exposes and consumes the following models.

• Brand Model
• Category Model
• Product Model
• Product Colour Model
• Product Size Model
• Product SEO Model
• Product Property Value Model
• Property Model

Brand Model

Represents a product brand or manufacturer.

Fields:

• Id (type: long) - internal identifier
• Name (type: string?) - brand display name
• Code (type: string?) - unique brand code (per tenant)
• IsActive (type: bool?) - active flag

Validation:

• IsReadyToAdd()
  • requires Name and Code
• IsReadyToUpdate()
  • requires Id > 0
  • requires Name and Code
  • IsActive is optional

Category Model

Represents a product category.

Fields:

• Id (type: long) - internal identifier
• Name (type: string?) - category name
• Code (type: string?) - category code
• ParentId (type: long) - optional parent category
• IsActive (type: bool?) - active flag

Validation:

• IsReadyToAdd()
  • requires Name and Code
• IsReadyToUpdate()
  • requires Id > 0
  • requires Name and Code

Product Model

Represents a catalog product with pricing, stock and dynamic properties.

The product entity is the core element of the Catalog module and is used across pricing, inventory and sales domains.

Fields:

• Id (type: long) - internal product identifier
• Code (type: string?) - product code / SKU
• Name (type: string?) - product display name
• Description (type: string?) - full product description
• Summary (type: string?) - short product summary
• IsActive (type: bool) - active flag
• Brand (type: string?) - associated brand name
• TaxCode (type: long) - tax classification code
• Stock (type: List<StockModel>) - stock information
• UnitPrice (type: decimal?) - base unit price
• Properties (type: List<ProductPropertyModel>) - dynamic product properties

Notes:

• All fields are tenant-scoped
• Pricing and stock information may be overridden by other modules
• Properties allow extending the product model without schema changes

Product Colour Model

Represents a colour variant.

Fields:

• Id (type: long) - internal identifier
• CreatedAt (type: DateTime) - creation timestamp
• Description (type: string?) - colour description or display name
• Code (type: string?) - unique colour code
• ImageSwatchURL (type: string?) - URL to colour swatch image
• IsActive (type: bool?) - active flag (default: true)

Validation:

• IsReadyToAdd()
  • requires Code, Description, ImageSwatchURL
• IsReadyToUpdate()
  • requires Id > 0
  • requires Code, Description, ImageSwatchURL

Product Size Model

Represents a size variant that can be assigned to products.

Fields:

• Id (type: long) - internal identifier
• CreatedAt (type: DateTime) - creation timestamp
• Description (type: string?) - size description
• Code (type: string?) - unique size code
• IsActive (type: bool?) - active flag

Validation:

• IsReadyToAdd()
  • requires Code and Description
• IsReadyToUpdate()
  • requires Id > 0
  • requires Code and Description

Product SEO Model

Represents SEO metadata associated with a product.

Fields:

• ProductId (type: long) - associated product identifier
• MetaTitle (type: string?) - SEO meta title
• MetaDescription (type: string?) - SEO meta description
• Slug (type: string) - URL-friendly product slug
• CanonicalUrl (type: string?) - canonical URL

Validation:

• IsValid()
  • requires ProductId
  • requires MetaTitle
  • requires MetaDescription
  • requires Slug
  • requires CanonicalUrl

Notes:

• Slug is normalized (lowercase, spaces replaced)
• Slug must be unique per product

Product Property Value Model

Represents a value assigned to a dynamic product property.

Fields:

• ProductId (type: long) - associated product identifier
• PropertyId (type: long) - associated property identifier
• Value (type: string?) - property value

Validation:

• IsEmpty()
  • returns true if ProductId == 0 or PropertyId == 0

Notes:

• (ProductId, PropertyId) must be unique

Property Model

Represents a definable product attribute.

Fields:

• Id (type: long) - internal identifier
• Name (type: string) - property display name
• Code (type: string) - unique property code
• DataType (type: string) - expected value type (e.g. string, number, boolean)

Validation:

• IsReadyToAdd()
  • requires Name and Code
• IsReadyToUpdate()
  • requires Id > 0
  • requires Name, Code, DataType

Notes:

• Properties are reusable
• DataType controls value interpretation