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

    Interface ProductRemoveImageAction

    Removes a Product image and deletes it from the Content Delivery Network (CDN) if it had been uploaded to our CDN. External images will not be deleted. The API deletes the removed image from the CDN in an eventual consistent way. Either variantId or sku is required.

    interface ProductRemoveImageAction {
        action: "removeImage";
        imageUrl: string;
        sku?: string;
        staged?: boolean;
        variantId?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action imageUrl sku? staged? variantId?

    Properties

    action: "removeImage"
    imageUrl: string

    The URL of the image to remove.

    sku?: string

    The sku of the ProductVariant to update.

    staged?: boolean

    If true, only the staged image is removed. If false, both the current and staged image is removed.

    variantId?: number

    The id of the ProductVariant to update.

    Settings

    Member Visibility

    On This Page

    Properties