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

    Interface BusinessUnitAddressCustomTypeSetMessage

    Generated after adding a Custom Type to an address of a Business Unit using the Set Custom Type in Address update action.

    interface BusinessUnitAddressCustomTypeSetMessage {
        addressId?: string;
        createdAt: string;
        createdBy?: CreatedBy;
        customFields: CustomFields;
        id: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        oldTypeId?: string;
        resource: Reference;
        resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
        resourceVersion: number;
        sequenceNumber: number;
        type: "BusinessUnitAddressCustomTypeSet";
        version: number;
    }

    Hierarchy (View Summary)

    • IMessage
      • BusinessUnitAddressCustomTypeSetMessage
    Index

    Properties

    addressId? createdAt createdBy? customFields id lastModifiedAt lastModifiedBy? oldTypeId? resource resourceUserProvidedIdentifiers? resourceVersion sequenceNumber type version

    Properties

    addressId?: string

    id of the Address on which the Custom Field was set.

    createdAt: string

    Date and time (UTC) the Message was generated.

    createdBy?: CreatedBy

    IDs and references that created the Message.

    customFields: CustomFields

    The Custom Fields that were set.

    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.

    oldTypeId?: string

    id of the previous Custom Type. Absent if there was no previous Custom Type present.

    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.

    type: "BusinessUnitAddressCustomTypeSet"

    Message Type of the Message.

    version: number

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

    Settings

    Member Visibility

    On This Page

    Properties