Skip to main content

AttributeDescriptionCreateInput

Input for creating new attribute descriptions with comprehensive configuration options.

Provides complete attribute description creation capabilities including type definition, localization, visibility settings, and default values. The input ensures proper attribute schema definition with all necessary metadata for attribute management and usage.

Supports all attribute types, entity class assignment, and comprehensive configuration options for search, visibility, and access control. The creation process validates all inputs and establishes proper attribute description templates for future attribute creation.

input AttributeDescriptionCreateInput {
  name: String!
  descriptions: [LocalizedStringInput!]!
  units: [LocalizedStringInput!]
  type: AttributeType!
  attributeClass: AttributeDescriptionClass!
  valuesetId: Int
  group: String
  isSearchable: Boolean
  isPublic: Boolean
  isSystem: Boolean
  isHidden: Boolean
  defaultValue: AttributeValueInput!
}

Fields​

AttributeDescriptionCreateInput.name ● String! non-null scalar​

Unique identifier name for the attribute description.

Must be in SCREAMING_SNAKE_CASE format using only uppercase letters, numbers, and underscores. Maximum length is 64 characters. This name serves as a human-readable identifier and must be unique within the attribute class.

AttributeDescriptionCreateInput.descriptions ● [LocalizedStringInput!]! non-null input​

Localized human-readable descriptions of the attribute.

Provide user-friendly descriptions in multiple languages to explain what this attribute represents. Array must not be empty and contain at least the default language. These descriptions are used in user interfaces and documentation.

AttributeDescriptionCreateInput.units ● [LocalizedStringInput!] list input​

Localized unit of measurement for the attribute value.

Specify the units in which the attribute value is measured (e.g., "cm", "kg", "pieces"). Only applicable for numeric attribute types.

AttributeDescriptionCreateInput.type ● AttributeType! non-null enum​

The type of the attribute. One of: [TEXT, ENUM, COLOR, DATETIME, INT, DECIMAL]

Determines how attribute values are stored depending on what this attribute is used for.

AttributeDescriptionCreateInput.attributeClass ● AttributeDescriptionClass! non-null enum​

Entity type that this attribute description applies to.

Specifies which type of resource can have attributes based on this description. Each class has its own namespace for attribute names, ensuring name uniqueness within each entity type.

AttributeDescriptionCreateInput.valuesetId ● Int scalar​

Reference to a valueset for ENUM type attributes with predefined options.

Required when type is ENUM. Links to a predefined set of allowed values that defines the valid options for enum attributes. The valueset contains the selectable options that users can choose from. Must reference an existing valueset that contains appropriate options for the intended use case.

AttributeDescriptionCreateInput.group ● String scalar​

Logical grouping identifier for related attributes.

Used to organize attributes into categories for better management and user interface organization. Attributes in the same group are typically displayed together.

AttributeDescriptionCreateInput.isSearchable ● Boolean scalar​

Enable this attribute for search and filtering operations.

When true, attributes based on this description can be used in search filters and faceted navigation. Useful for attributes that help users find and filter products or other resources.

AttributeDescriptionCreateInput.isPublic ● Boolean scalar​

Make this attribute visible to end users.

When true, attributes based on this description are displayed in public interfaces like product specifications. When false, they are only visible to administrative users.

AttributeDescriptionCreateInput.isSystem ● Boolean scalar​

Restrict access to system administrators only.

When true, only users with system-level permissions can view and modify attributes based on this description. Used for internal system attributes.

AttributeDescriptionCreateInput.isHidden ● Boolean scalar​

Hide this attribute from all user interfaces.

When true, attributes based on this description are completely hidden from user interfaces and are only used for internal processing and background operations.

AttributeDescriptionCreateInput.defaultValue ● AttributeValueInput! non-null input​

Default value configuration for attributes based on this description.

Specifies the initial value that will be assigned to new attributes created from this description. The value type must match the attribute type specified above.

Member Of​

attributeDescriptionCreate mutation