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

    Interface BusinessUnitTopLevelUnitSetMessage

    Generated when a Business Unit topLevelUnit is modified due to a hierarchy change after a successful Set Unit Type or Change Parent Unit update action.

    interface BusinessUnitTopLevelUnitSetMessage {
        createdAt: string;
        createdBy?: CreatedBy;
        id: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        oldTopLevelUnit: BusinessUnitKeyReference;
        resource: Reference;
        resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
        resourceVersion: number;
        sequenceNumber: number;
        topLevelUnit: BusinessUnitKeyReference;
        type: "BusinessUnitTopLevelUnitSet";
        version: number;
    }

    Hierarchy (View Summary)

    • IMessage
      • BusinessUnitTopLevelUnitSetMessage
    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.

    oldTopLevelUnit: BusinessUnitKeyReference

    Top-level unit of the Business Unit before the Set Unit Type or Change Parent Unit 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.

    Top-level unit of the Business Unit after the Set Unit Type or Change Parent Unit update action.

    type: "BusinessUnitTopLevelUnitSet"

    Message Type of the Message.

    version: number

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