AttributeDescriptionUpdateInput

Input for updating an existing attribute description's configuration.

Allows modification of attribute description properties including localized content, visibility settings, and default values. Only provided fields will be updated, others remain unchanged.

input AttributeDescriptionUpdateInput {
  descriptions: [LocalizedStringInput!]
  units: [LocalizedStringInput!]
  group: String
  isSearchable: Boolean
  isPublic: Boolean
  isSystem: Boolean
  isHidden: Boolean
  defaultValue: AttributeValueInput
}

Fields

AttributeDescriptionUpdateInput.descriptions ● [LocalizedStringInput!] list input

Updated localized descriptions explaining what this attribute represents.

Provide user-friendly descriptions in multiple languages for display in user interfaces and documentation. Array must not be empty when provided and must contain unique language entries.

AttributeDescriptionUpdateInput.units ● [LocalizedStringInput!] list input

Updated localized units of measurement for the attribute value.

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

AttributeDescriptionUpdateInput.group ● String scalar

Updated logical grouping identifier for related attributes.

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

AttributeDescriptionUpdateInput.isSearchable ● Boolean scalar

Updated setting for enabling this attribute in 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.

AttributeDescriptionUpdateInput.isPublic ● Boolean scalar

Updated setting for making 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.

AttributeDescriptionUpdateInput.isSystem ● Boolean scalar

Updated setting for restricting 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.

AttributeDescriptionUpdateInput.isHidden ● Boolean scalar

Updated setting for hiding 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.

AttributeDescriptionUpdateInput.defaultValue ● AttributeValueInput input

Updated 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 in the description.

Member Of

attributeDescriptionUpdate mutation