@gradientedge/commercetools-utils
    Preparing search index...

    Interface ProductSetAttributeAction

    Either variantId or sku is required.

    interface ProductSetAttributeAction {
        action: "setAttribute";
        name: string;
        sku?: string;
        staged?: boolean;
        value?: any;
        variantId?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action name sku? staged? value? variantId?

    Properties

    action: "setAttribute"
    name: string

    Name of the Attribute to set.

    sku?: string

    The sku of the ProductVariant to update.

    staged?: boolean

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

    value?: any

    Value to set for the Attribute. 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) object or the complete object 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`.
    variantId?: number

    The id of the ProductVariant to update.

    Settings

    Member Visibility

    On This Page

    Properties