Messages that represent a change or an action performed on a Customer, Customer Token, or Customer Group.
Customer Messages
Customer Created
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Deleted
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Address Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Email Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
emailString | The email that was set during the Change Email update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Email Verified
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer First Name Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
firstNameString | The firstName that was set during the Set First Name update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Last Name Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
lastNameString | The lastName that was set during the Set Last Name update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Title Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
titleString | The title that was set during the Set Title update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Company Name Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
companyNameString | The companyName that was set during the Set Company Name update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Date Of Birth Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
dateOfBirthDate | The dateOfBirth that was set during the Set Date of Birth update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Group Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Address Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Address Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Default Shipping Address Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "CustomerDefaultShippingAddressSet"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 | The address that was set as the default shipping address. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Default Billing Address Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "CustomerDefaultBillingAddressSet"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 | The address that was set as the default billing address. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Stores Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "CustomerStoresSet"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. |
storesArray of StoreKeyReference | |
oldStoresArray of StoreKeyReference | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Password Updated
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
resetBoolean | Whether the Customer's password was updated during the Reset password or Change password flow. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Custom Field Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
nameString | Name of the Custom Field that was added. |
value | The added CustomFieldValue based on the FieldType. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Custom Field Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
nameString | 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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Custom Field Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
nameString | Name of the Custom Field that was removed. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Custom Type Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
previousTypeIdString | id of the previous Custom Type. Absent if there was no previous Custom Type present. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Custom Type Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
previousTypeIdString | id of the Custom Type that was removed. Absent if there was no previous Custom Type present. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Address Custom Field Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
nameString | Name of the Custom Field that was added. |
value | The added CustomFieldValue based on the FieldType. |
addressIdString | id of the Address to which the Custom Field was added. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Address Custom Field Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
nameString | 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. |
addressIdString | id of the Address of which the Custom Field was changed. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Address Custom Field Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
nameString | Name of the Custom Field that was removed. |
addressIdString | id of the Address from which the Custom Field was removed. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Address Custom Type Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
previousTypeIdString | id of the previous Custom Type. Absent if there was no previous Custom Type present. |
addressIdString | id of the Address on which the Custom Field was set. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Address Custom Type Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
previousTypeIdString | id of the Custom Type that was removed. Absent if there was no previous Custom Type present. |
addressIdString | id of the Address from which the Custom Type was removed. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Token Messages
Customer Email Token Created
resource property of the Message is a CustomerEmailTokenReference.idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
customerIdString | Unique identifier of the Customer. |
expiresAt | Date and time (UTC) the email token expires. |
valueString | Value of the token, present only if the token's validity is 60 minutes or less. |
invalidateOlderTokensBoolean | If true, all email tokens issued previously for the Customer are invalidated. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Password Token Created
resource property of the Message is a CustomerPasswordTokenReference.idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
customerIdString | Unique identifier of the Customer. |
expiresAt | Date and time (UTC) the password token expires. |
valueString | Value of the token, present only if the token's validity is 60 minutes or less. |
invalidateOlderTokensBoolean | If true, all password tokens issued previously for the Customer are invalidated. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Group Messages
Customer Group Assignment Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Group Assignment Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Group Assignments Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
customerGroupAssignmentsArray of CustomerGroupAssignment | Customer Groups assigned to the Customer during the Set CustomerGroupAssignments update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Group Custom Field Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
nameString | Name of the Custom Field that was added. |
value | The added CustomFieldValue based on the FieldType. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Group Custom Field Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
nameString | Name of the Custom Field that changed. |
value | |
oldValue | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Group Custom Field Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
nameString | Name of the Custom Field that was removed. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Group Custom Type Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
oldTypeIdString | id of the previous Custom Type. Absent if there was no previous Custom Type present. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Customer Group Custom Type Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
oldTypeIdString | id of the Custom Type that was removed. Absent if there was no previous Custom Type present. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |