Typescript SDK Type Docs
    Preparing search index...

    Interface AttributeDefinition

    interface AttributeDefinition {
        attributeConstraint?: AttributeConstraintEnum;
        inputHint?: TextInputHint;
        inputTip?: LocalizedString;
        isRequired: boolean;
        isSearchable?: boolean;
        label: LocalizedString;
        level?: AttributeLevel;
        name: string;
        type: AttributeType;
    }
    Index

    Properties

    attributeConstraint? inputHint? inputTip? isRequired isSearchable? label level? name type

    Properties

    attributeConstraint?: AttributeConstraintEnum

    Specifies how Attributes are validated across all variants of a Product.

    inputHint?: TextInputHint

    Provides a visual representation directive for values of this Attribute (only relevant for AttributeTextType and AttributeLocalizableTextType).

    inputTip?: LocalizedString

    Provides additional Attribute information to aid content managers configure Product details.

    isRequired: boolean

    If true, the Attribute must have a value on a ProductVariant.

    isSearchable?: boolean

    If true, the Attribute's values are available in the Product Search or the Product Projection Search API for use in full-text search queries, filters, and facets.

    label: LocalizedString

    Human-readable label for the Attribute.

    level?: AttributeLevel
    name: string

    User-defined name of the Attribute that is unique within the Project.

    type: AttributeType

    Describes the Type of the Attribute.

    Settings

    Member Visibility

    On This Page

    Properties