@gradientedge/commercetools-utils
    Preparing search index...

    Interface AttributeDefinitionDraft

    Specify the Attribute to be created with the ProductTypeDraft.

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

    Specifies how an Attribute or a combination of Attributes should be validated across all variants of a Product. If the Attribute is defined at Product level, then attributeConstraint must be None. Otherwise, an InvalidOperation error is returned.

    inputHint?: TextInputHint

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

    inputTip?: LocalizedString

    Provides additional information about the Attribute that aids content managers when setting Product details.

    isRequired: boolean

    Whether the Attribute is required to have a value on a ProductVariant.

    isSearchable?: boolean

    Set as true if you want the Attribute's values to be available in the Product Search or the Product Projection Search API and can be used in full-text search queries, filters, and facets. If an Attribute's level is set as Product, then Product Projection Search does not support the Attribute. To use the Attribute in search, filters, or facets, set isSearchable to true for all AttributeDefinitions with the same name across different ProductTypes. If the isSearchable values are different, the Attribute isn't available for search, filters, or facets.

    Which exact features are available with this flag depends on the specific [AttributeType](ctp:api:type:AttributeType).
The maximum size of a searchable field is **restricted** by the [Field content size limit](/api/limits#field-content-size).
This constraint is enforced at both Product creation and Product update.
If the length of the input exceeds the maximum size, an [InvalidField](ctp:api:type:InvalidFieldError) error is returned.
    label: LocalizedString

    Human-readable label for the Attribute.

    level?: AttributeLevelEnum

    Specifies whether the Attribute is defined at the Product or Variant level.

    name: string

    User-defined name of the Attribute that must be unique within the ProductType.

    To use the same `name` in multiple ProductTypes, each AttributeDefinition must have the same `type`; otherwise, an [AttributeDefinitionTypeConflict](ctp:api:type:AttributeDefinitionTypeConflictError) error is returned.
For `enum` or `lenum` Types and sets of these AttributeTypes, the enum values can be different for each ProductType.
    type: AttributeType

    Describes the Type of the Attribute.

    When the `type` is different for an AttributeDefinition using the same name in multiple ProductTypes, an [AttributeDefinitionTypeConflict](ctp:api:type:AttributeDefinitionTypeConflictError) error is returned.

    Settings
    Member Visibility

    On This Page
    Properties