Interface FieldDefinition

Defines a Custom Field and its meta-information. This FieldDefinition is similar to an AttributeDefinition of Product Types.

interface FieldDefinition {
    inputHint?: string;
    label: LocalizedString;
    name: string;
    required: boolean;
    type: FieldType;
}

Properties

inputHint? label name required type

Properties

Optional Readonly inputHint

inputHint?: string

Defines the visual representation of the field in user interfaces like the Merchant Center. It is only relevant for string-based FieldTypes like CustomFieldStringType and CustomFieldLocalizedStringType.

Readonly label

label: LocalizedString

A human-readable label for the field.

Readonly name

name: string

Name of the Custom Field to define. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type.

Readonly required

required: boolean

Defines whether the field is required to have a value.

Readonly type

type: FieldType

Data type of the Custom Field to define.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc