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

    Interface VariantSetAssetCustomFieldAction

    Sets or removes a Custom Field on an existing Asset of a Variant. The Asset to update must be specified using either assetId or assetKey.

    interface VariantSetAssetCustomFieldAction {
        action: "setAssetCustomField";
        assetId?: string;
        assetKey?: string;
        name: string;
        staged?: boolean;
        value?: any;
    }

    Hierarchy (View Summary)

    Index
    action assetId? assetKey? name staged? value?
    action: "setAssetCustomField"
    assetId?: string

    The id of the Asset to update.

    assetKey?: string

    The key of the Asset to update.

    name: string

    Name of the Custom Field.

    staged?: boolean

    Whether only the staged Asset is updated. If false, both the current and staged Asset is updated.

    value?: any

    If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

    Settings
    Member Visibility

    On This Page
    Properties