Typescript SDK Type Docs
    Preparing search index...

    Interface EnumAttribute

    This type represents an attribute whose value is an enum. The attribute value refers to the key of the enum value.

    interface EnumAttribute {
        name?: string;
        type: "enum";
        value: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    name? type value

    Properties

    name?: string

    Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch.

    Must match `name` of an [AttributeDefinition](ctp:api:type:AttributeDefinition) of the Product Type.
    type: "enum"

    Must match type of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.

    value: string

    The key of the enum value. Must match the key of an AttributePlainEnumValue in the Product Type.

    Settings

    Member Visibility

    On This Page

    Properties