Skip to main content

attributeDescriptionCreate

Create a new attribute description in the system.

Establishes a new attribute description with metadata, display configuration, and localization settings. The description will be available for attribute value creation immediately.

Possible errors:

  • ATTRIBUTE_DESCRIPTION_CREATE: Failed to create the attribute description
  • ATTRIBUTE_DESCRIPTION_ALREADY_EXISTS: Attribute description with the same identifier already exists
  • FORBIDDEN: Insufficient permissions

AUTH: Role=[configuration.OWNER]

attributeDescriptionCreate(
  input: AttributeDescriptionCreateInput!
): AttributeDescription!

Arguments​

attributeDescriptionCreate.input ● AttributeDescriptionCreateInput! non-null input​

Attribute description creation data including metadata and configuration.

Contains all necessary information to create a functional attribute description including type definition and display settings.

Type​

AttributeDescription object​

Attribute description schema defining the structure and metadata for attributes.

Serves as a template that defines how attributes should be structured and displayed. Contains type information, the entity type, localization settings, and default values that govern attribute behavior across the system.

An attribute description is the definition/blueprint of an attribute, specifying what entity it applies to (product, company, etc.), what data type it is (text, int, etc.), localized descriptions, and default values. The actual attributes are just the specific values assigned to objects using this description as their template. You must first define the attribute description, then use it to assign values to specific objects.