Skip to main content

AttributeResult

Comprehensive attribute result combining attribute descriptions, values, and entity associations.

Represents the complete attribute information for an entity, including the attribute description schema, the actual attribute instance (if assigned), and the effective value (either from the assigned attribute or the default value from the description).

This entity provides a unified view of attribute data that combines:

  • The attribute description defining the schema and rules
  • The specific attribute instance linking the value to the entity (nullable if not explicitly assigned)
  • The effective attribute value (either assigned value or default from description)

Perfect for displaying complete attribute information in user interfaces, generating specifications, or providing comprehensive attribute data for business logic operations.

type AttributeResult {
  attribute: Attribute
  attributeDescription: AttributeDescription!
  value: AttributeValue!
}

Fields​

AttributeResult.attribute ● Attribute interface​

The specific attribute instance linking the value to the entity.

Contains the actual attribute record that associates the value with the specific entity (product, category, etc.). This field is null when the entity doesn't have an explicitly assigned attribute value, in which case the default value from the attribute description is used.

When present, this attribute contains metadata such as creation timestamps, modification history, and value.

AttributeResult.attributeDescription ● AttributeDescription! non-null object​

The attribute description defining the schema and behavior for this attribute.

Contains the complete attribute description including type definition, display configuration, localization settings, and default values. This description serves as the template that defines how the attribute should behave and be presented.

Essential for understanding attribute constraints, available operations, and presentation requirements.

AttributeResult.value ● AttributeValue! non-null interface​

The effective attribute value for this entity.

Contains the actual value data, either from the explicitly assigned attribute instance or the default value from the attribute description when no specific value has been assigned to the entity.

The value structure varies based on the attribute type (text, enum, color, etc.) and includes all necessary data for display and business logic operations.

Member Of​

AttributeResultResponse object