Interface ProductSetAttributeInAllVariantsAction

Adds, removes, or changes a Product Attribute in all Product Variants at the same time. This action is useful for setting values for Attributes with the Constraint SameForAll.

interface ProductSetAttributeInAllVariantsAction {
    action: "setAttributeInAllVariants";
    name: string;
    staged?: boolean;
    value?: any;
}

Properties

action name staged? value?

Properties

Readonly action

action: "setAttributeInAllVariants"

Readonly name

name: string

The name of the Attribute to set.

Optional Readonly staged

staged?: boolean

If true, only the staged Attributes are set. If false, both the current and staged Attributes are set.

Optional Readonly value

value?: any

Value to set for the Attributes. If empty, any existing value will be removed.

The [AttributeType](ctp:api:type:AttributeType) determines the format of the Attribute `value` to be provided:

- For [Enum Type](ctp:api:type:AttributeEnumType) and [Localized Enum Type](ctp:api:type:AttributeLocalizedEnumType),
  use the `key` of the [Plain Enum Value](ctp:api:type:AttributePlainEnumValue) or [Localized Enum Value](ctp:api:type:AttributeLocalizedEnumValue) objects,
  or the complete objects as `value`.
- For [Localizable Text Type](ctp:api:type:AttributeLocalizableTextType), use the [LocalizedString](ctp:api:type:LocalizedString) object as `value`.
- For [Money Type](ctp:api:type:AttributeMoneyType) Attributes, use the [Money](ctp:api:type:Money) object as `value`.
- For [Set Type](ctp:api:type:AttributeSetType) Attributes, use the entire `set` object  as `value`.
- For [Nested Type](ctp:api:type:AttributeNestedType) Attributes, use the list of values of all Attributes of the nested Product as `value`.
- For [Reference Type](ctp:api:type:AttributeReferenceType) Attributes, use the [Reference](ctp:api:type:Reference) object as `value`.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc