Interface ProductTypeChangeAttributeNameAction

Renames an AttributeDefinition and also renames all corresponding Attributes on all Products with this ProductType. The renaming of the Attributes is eventually consistent.

If the AttributeDefinition name to be changed does not exist, an [AttributeNameDoesNotExist](ctp:api:type:AttributeNameDoesNotExistError) error is returned.
interface ProductTypeChangeAttributeNameAction {
    action: "changeAttributeName";
    attributeName: string;
    newAttributeName: string;
}

Properties

action attributeName newAttributeName

Properties

Readonly action

action: "changeAttributeName"

Readonly attributeName

attributeName: string

Name of the AttributeDefinition to update.

Readonly newAttributeName

newAttributeName: string

New user-defined name of the Attribute that is unique with the Project.

When using the same `name` for an Attribute in two or more ProductTypes, all fields of the AttributeDefinition of this Attribute must be the same across the ProductTypes. If not, an [AttributeDefinitionAlreadyExists](ctp:api:type:AttributeDefinitionAlreadyExistsError) error is returned.
An exception to this are the values of an `enum` or `lenum` type and sets thereof.

Settings

Member Visibility

Theme

On This Page

actionattributeNamenewAttributeName