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

    Interface ProductVariantDeletedMessage

    Generated after a successful Remove ProductVariant update action.

    interface ProductVariantDeletedMessage {
        createdAt: string;
        createdBy?: CreatedBy;
        id: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        removedImageUrls: string[];
        resource: Reference;
        resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
        resourceVersion: number;
        sequenceNumber: number;
        staged: boolean;
        type: "ProductVariantDeleted";
        variant?: ProductVariant;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createdAt: string

    Date and time (UTC) the Message was generated.

    createdBy?: CreatedBy

    IDs and references that created the Message.

    id: string

    Unique identifier of the Message. Can be used to track which Messages have been processed.

    lastModifiedAt: string

    Value of createdAt.

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the Message.

    removedImageUrls: string[]

    List of image URLs that were removed with the Remove Product Variant update action.

    resource: Reference

    Reference to the resource on which the change or action was performed.

    resourceUserProvidedIdentifiers?: UserProvidedIdentifiers

    User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

    resourceVersion: number

    Version of the resource on which the change or action was performed.

    sequenceNumber: number

    Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

    staged: boolean

    If true, this message informs that only the staged ProductVariant has been removed by the update action. If false, both the current and staged ProductVariant have been removed.

    type: "ProductVariantDeleted"

    Message Type of the Message.

    variant?: ProductVariant

    Unique identifier of the Product Variant that was added.

    version: number

    Version of a resource. In case of Messages, this is always 1.