Messages that represent a change or an action performed on a Customer, Customer Token, or Customer Group.
Customer Messages
Customer Created
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customer | Customer that was created. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Deleted
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Address Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerAddressChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
address | Address that was set during the Change Address update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Email Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerEmailChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
email String | The email that was set during the Change Email update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Email Verified
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerEmailVerified" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer First Name Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerFirstNameSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
firstName String | The firstName that was set during the Set First Name update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Last Name Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerLastNameSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
lastName String | The lastName that was set during the Set Last Name update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Title Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerTitleSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
title String | The title that was set during the Set Title update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Company Name Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerCompanyNameSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
companyName String | The companyName that was set during the Set Company Name update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Date Of Birth Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerDateOfBirthSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
dateOfBirth Date | The dateOfBirth that was set during the Set Date of Birth update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Group Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerGroupSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customerGroup | Customer Group that was set during the Set Customer Group update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Address Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerAddressRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
address | Address that was removed during the Remove Address update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Address Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerAddressAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
address | Address that was added during the Add Address update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Password Updated
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerPasswordUpdated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
reset Boolean | Whether the Customer's password was updated during the Reset password or Change password flow. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Custom Field Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerCustomFieldAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was added. |
value | The added CustomFieldValue based on the FieldType. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Custom Field Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerCustomFieldChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that changed. |
value | |
previousValue | CustomFieldValue based on the FieldType before the Set CustomField update action.
When there has not been a Custom Field with the name on the Customer before, a Customer Custom Field Added Message is generated instead. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Custom Field Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerCustomFieldRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was removed. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Custom Type Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerCustomTypeSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customFields | The Custom Fields that have been set. |
previousTypeId String | id of the previous Custom Type. Absent if there was no previous Custom Type present. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Custom Type Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerCustomTypeRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
previousTypeId String | id of the Custom Type that was removed. Absent if there was no previous Custom Type present. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Address Custom Field Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerAddressCustomFieldAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was added. |
value | The added CustomFieldValue based on the FieldType. |
addressId String | id of the Address to which the Custom Field was added. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Address Custom Field Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerAddressCustomFieldChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that changed. |
value | |
previousValue | CustomFieldValue based on the FieldType before the Set CustomField update action.
When there has not been a Custom Field with the name on the Customer Address before, a Customer Address Custom Field Added Message is generated instead. |
addressId String | id of the Address of which the Custom Field was changed. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Address Custom Field Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerAddressCustomFieldRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was removed. |
addressId String | id of the Address from which the Custom Field was removed. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Address Custom Type Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerAddressCustomTypeSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customFields | The Custom Fields that have been set. |
previousTypeId String | id of the previous Custom Type. Absent if there was no previous Custom Type present. |
addressId String | id of the Address on which the Custom Field was set. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Address Custom Type Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerAddressCustomTypeRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
previousTypeId String | id of the Custom Type that was removed. Absent if there was no previous Custom Type present. |
addressId String | id of the Address from which the Custom Type was removed. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Token Messages
Customer Email Token Created
resource
property of the Message is a CustomerEmailTokenReference.id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerEmailTokenCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customerId String | Unique identifier of the Customer. |
expiresAt DateTime | Date and time (UTC) the email token expires. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Password Token Created
resource
property of the Message is a CustomerPasswordTokenReference.id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerPasswordTokenCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customerId String | Unique identifier of the Customer. |
expiresAt DateTime | Date and time (UTC) the password token expires. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Group Messages
Customer Group Assignment Added BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerGroupAssignmentAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customerGroupAssignment | Customer Group assigned to the Customer during the Add CustomerGroupAssignment update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Group Assignment Removed BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerGroupAssignmentRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customerGroupAssignment | Customer Group removed during the Remove CustomerGroupAssignment update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Group Assignments Set BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerGroupAssignmentsSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customerGroupAssignments Array of CustomerGroupAssignment | Customer Groups assigned to the Customer during the Set CustomerGroupAssignments update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Group Custom Field Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerGroupCustomFieldAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was added. |
value | The added CustomFieldValue based on the FieldType. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Group Custom Field Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerGroupCustomFieldChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that changed. |
value | |
oldValue | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Group Custom Field Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerGroupCustomFieldRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was removed. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Group Custom Type Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerGroupCustomTypeSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customFields | The Custom Fields that have been set. |
oldTypeId String | id of the previous Custom Type. Absent if there was no previous Custom Type present. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Customer Group Custom Type Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | 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. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomerGroupCustomTypeRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
oldTypeId String | id of the Custom Type that was removed. Absent if there was no previous Custom Type present. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |