Skip to main content

AttributeDescriptionFieldName

No description

enum AttributeDescriptionFieldName {
NAME
DESCRIPTION
UNIT
LANGUAGE
TYPE
ATTRIBUTE_CLASS
VALUESET_ID
GROUP
IS_SEARCHABLE
IS_PUBLIC
IS_SYSTEM
IS_HIDDEN
TEXT_VALUES
TEXT_VALUES_LANGUAGE
ENUM_VALUES
INT_VALUE
DECIMAL_VALUE
DATE_TIME_VALUE
COLOR_VALUE
}

Values

AttributeDescriptionFieldName.NAME

[Required][String] Descriptive identifier (Screaming Snake Case)

AttributeDescriptionFieldName.DESCRIPTION

[Required][Object] Attribute descriptions per language

AttributeDescriptionFieldName.UNIT

[Optional][String] Attribute unit per language

AttributeDescriptionFieldName.LANGUAGE

[Required][String] The language of the attribute

AttributeDescriptionFieldName.TYPE

[Required][String] Attribute type. One of: [text, enum, color, datetime, integer, decimal]

AttributeDescriptionFieldName.ATTRIBUTE_CLASS

[Required][Enum] Attribute class. One of: [product, category, cluster, customer, contact, company], must be one of the following: [product, category, cluster, customer, contact, company]

AttributeDescriptionFieldName.VALUESET_ID

[Optional][String] The ID of the connected valueset to use when type is ENUM

AttributeDescriptionFieldName.GROUP

[Optional][String] The attribute group

AttributeDescriptionFieldName.IS_SEARCHABLE

[Optional][Boolean] Flags whether this attribute should be used when generating catalog page filters

AttributeDescriptionFieldName.IS_PUBLIC

[Optional][Boolean] Flags whether this attribute should be used when generating product specifications

AttributeDescriptionFieldName.IS_SYSTEM

[Optional][Boolean] Flags whether this attribute is only available to system users

AttributeDescriptionFieldName.IS_HIDDEN

[Optional][Boolean] Flags whether this attribute is hidden and should only be used for background operations

AttributeDescriptionFieldName.TEXT_VALUES

[Optional][String] Attribute value descriptions per language, required for TEXT type attributes

AttributeDescriptionFieldName.TEXT_VALUES_LANGUAGE

[Optional][String] Attribute value descriptions per language, required for TEXT type attributes

AttributeDescriptionFieldName.ENUM_VALUES

[Optional][String] Attribute enum values, required for ENUM type attributes

AttributeDescriptionFieldName.INT_VALUE

[Optional][Integer] Attribute integer value, required for INTEGER type attributes

AttributeDescriptionFieldName.DECIMAL_VALUE

[Optional][Decimal] Attribute decimal value, required for DECIMAL type attributes

AttributeDescriptionFieldName.DATE_TIME_VALUE

[Optional][DateTime] Attribute datetime value, required for DATETIME type attributes in ISO 8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' (e.g., 2024-10-31T09:55:00.000Z)

AttributeDescriptionFieldName.COLOR_VALUE

[Optional][String] Attribute color value, required for COLOR type attributes

Member Of

AttributeDescriptionCsvMapping input