Skip to main content

CategoryAttribute

Category-specific attribute containing custom properties and metadata for product categories.

Extends the base category interface with attribute functionality. Used to store additional category information such as display properties, classification metadata, and custom properties that are not part of the standard category schema.

Perfect for category-level configuration, taxonomy enhancement, and category-specific business rules that need to be applied across all products within the category.

type CategoryAttribute implements Attribute {
  id: String!
  value: AttributeValue!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  createdBy: Int
  lastModifiedBy: Int
  attributeDescription: AttributeDescription
  categoryId: Int!
}

Fields​

CategoryAttribute.id ● String! non-null scalar​

Unique identifier for this attribute instance.

Auto-generated UUID that serves as the primary key for this specific attribute. Used to reference and manage individual attribute instances.

CategoryAttribute.value ● AttributeValue! non-null interface​

The actual value data stored in this attribute.

Contains the attribute value in the appropriate format based on the attribute description's type definition. The value structure varies depending on the attribute type (text, enum, color, etc.).

CategoryAttribute.createdAt ● DateTime! non-null scalar​

Timestamp when this attribute was originally created.

Records the exact date and time when this attribute instance was first created in the system. Used for audit trails and data lifecycle management.

CategoryAttribute.lastModifiedAt ● DateTime! non-null scalar​

Timestamp when this attribute was last modified.

Records the most recent date and time when any changes were made to this attribute's value or configuration. Updated automatically on each modification.

CategoryAttribute.createdBy ● Int scalar​

Identifier of the user who created this attribute.

References the user account that originally created this attribute instance. May be 0 for system-generated attributes or when user information is not available.

CategoryAttribute.lastModifiedBy ● Int scalar​

Identifier of the user who last modified this attribute.

References the user account that made the most recent changes to this attribute. May be 0 for system modifications or when user information is not available.

CategoryAttribute.attributeDescription ● AttributeDescription object​

Retrieve the attribute description that defines this category attribute's schema and behavior.

Returns the complete attribute description containing metadata, type definitions, display configuration, and localization settings. This description serves as the template that defines how this category attribute should behave and be presented.

Essential for understanding attribute constraints, available operations, and presentation requirements for category-specific attributes that extend category information.

CategoryAttribute.categoryId ● Int! non-null scalar​

Unique identifier of the category that owns this attribute.

References the specific category in the catalog hierarchy that this attribute value is associated with. Used to establish the relationship between attributes and their parent categories for classification and organizational purposes.

Interfaces​

Attribute interface​

Base interface for all attribute types across different entity classes.

Attributes provide extensible metadata and properties for various entities in the system. Each attribute is associated with a specific entity type and contains typed values based on its attribute description schema.