Interface ProductTypeChangeEnumKeyAction

Updates the key of a single enum value in an AttributeEnumType AttributeDefinition, AttributeLocalizedEnumType AttributeDefinition, AttributeSetType of AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeLocalizedEnumType AttributeDefinition.

If the AttributeDefinition does not contain an enum with the referenced key, a [EnumKeyDoesNotExist](ctp:api:type:EnumKeyDoesNotExistError) error is returned.

All Products will be updated to the new key in an [eventually consistent](/general-concepts#eventual-consistency) way.
interface ProductTypeChangeEnumKeyAction {
    action: "changeEnumKey";
    attributeName: string;
    key: string;
    newKey: string;
}

Properties

action attributeName key newKey

Properties

Readonly action

action: "changeEnumKey"

Readonly attributeName

attributeName: string

Name of the AttributeDefinition to update.

Readonly key

key: string

Existing key to be changed.

Readonly newKey

newKey: string

New key to be set.

Settings

Member Visibility

Theme

On This Page

actionattributeNamekeynewKey