Business Unit and Associate Role Messages

Messages that represent a change or an action performed on a Business Unit or Associate Role.

Messages are available in a variety of Message Types specific to a resource. Common fields across all Message Types are represented by a base resource, Message.

You can access Messages either by querying the Messages API, or by subscribing to them with a Subscription. To query Messages using the API, you must enable the feature first.

Business Unit Messages

Messages that represent a change or an action performed on a Business Unit.

Business Unit Created

Generated after a successful Create BusinessUnit request.

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
"BusinessUnitCreated"

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.

businessUnit

The Business Unit 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.

Business Unit Address Added

Generated after a successful Add Address update action.

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
"BusinessUnitAddressAdded"

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 added to the Business Unit.

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.

Business Unit Address Changed

Generated after a successful Change Address update action.

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
"BusinessUnitAddressChanged"

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

Updated address of the Business Unit.

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.

Business Unit Address Removed

Generated after a successful Remove Address update action.

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
"BusinessUnitAddressRemoved"

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 removed from the Business Unit.

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.

Business Unit Associate Added

Generated after a successful Add Associate update action.

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
"BusinessUnitAssociateAdded"

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.

associate

The Associate that was added to the Business Unit.

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.

Business Unit Associates Set

Generated after a successful Set Associates update action.

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
"BusinessUnitAssociatesSet"

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.

associates
Array of Associate

The list of Associates that was updated on the Business Unit.

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.

Business Unit Associate Changed

Generated after a successful Change Associate update action.

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
"BusinessUnitAssociateChanged"

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.

associate

The Associate that was updated.

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.

Business Unit Associate Mode Changed

Generated after a successful Change Associate Mode update action.

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
"BusinessUnitAssociateModeChanged"

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.

associateMode

BusinessUnitAssociateMode of the Business Unit after the Change Associate Mode update action.

oldAssociateMode

BusinessUnitAssociateMode of the Business Unit before the Change Associate Mode 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.

Business Unit Associate Removed

Generated after a successful Remove Associate update action.

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
"BusinessUnitAssociateRemoved"

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.

associate

The Associate that was removed from the Business Unit.

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.

Business Unit Approval Rule Mode Changed

Generated after a successful Change Approval Rule Mode update action.

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
"BusinessUnitApprovalRuleModeChanged"

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.

approvalRuleMode

BusinessUnitApprovalRuleMode of the Business Unit after the Change Approval Rule Mode update action.

oldApprovalRuleMode

BusinessUnitApprovalRuleMode of the Business Unit before the Change Approval Rule Mode 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.

Business Unit Parent Changed

Generated after a successful Change Parent Unit update action.

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
"BusinessUnitParentChanged"

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.

oldParentUnit

Parent unit of the Business Unit before the Change Parent Unit update action.

newParentUnit

Parent unit of the Business Unit after the Change Parent Unit 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.

Business Unit Store Added

Generated after a successful Add Store update action.

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
"BusinessUnitStoreAdded"

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.

The Store that was added to the Business Unit.

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.

Business Unit Stores Set

Generated after a successful Set Stores update action.

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
"BusinessUnitStoresSet"

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.

stores
Array of StoreKeyReference

Stores of the Business Unit after the Set Stores 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.

Business Unit Store Mode Changed

Generated after a successful Set Store Mode update action.

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
"BusinessUnitStoreModeChanged"

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.

stores
Array of StoreKeyReference

Stores of the Business Unit after the Set Store Mode update action.

storeMode

BusinessUnitStoreMode of the Business Unit after the Set Store Mode update action.

oldStores
Array of StoreKeyReference

Stores of the Business Unit before the Set Store Mode update action.

oldStoreMode

BusinessUnitStoreMode of the Business Unit before the Set Store Mode 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.

Business Unit Store Removed

Generated after a successful Remove Store update action.

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
"BusinessUnitStoreRemoved"

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.

The Store that was removed from the Business Unit.

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.

Business Unit Status Changed

Generated after a successful Change Status update action.

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
"BusinessUnitStatusChanged"

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.

active

Updated status of the Business Unit.

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.

Business Unit Billing Address Added

Generated after a successful Add Billing Address Identifier update action.

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
"BusinessUnitBillingAddressAdded"

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 added to the Business Unit as 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.

Business Unit Billing Address Removed

Generated after a successful Remove Billing Address Identifier update action.

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
"BusinessUnitBillingAddressRemoved"

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 removed from the billing addresses of the Business Unit.

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.

Business Unit Default Billing Address Set

Generated after a successful Set Default Billing Address update action.

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
"BusinessUnitDefaultBillingAddressSet"

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.

Business Unit Shipping Address Added

Generated after a successful Add Shipping Address Identifier update action.

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
"BusinessUnitShippingAddressAdded"

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 added to the Business Unit as 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.

Business Unit Shipping Address Removed

Generated after a successful Remove Shipping Address Identifier update action.

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
"BusinessUnitShippingAddressRemoved"

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 removed from shipping addresses of the Business Unit.

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.

Business Unit Default Shipping Address Set

Generated after a successful Set Default Shipping Address update action.

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
"BusinessUnitDefaultShippingAddressSet"

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.

Business Unit Contact Email Set

Generated after a successful Set Contact Email update action.

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
"BusinessUnitContactEmailSet"

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.

contactEmail
String

The contact email that was updated on the Business Unit.

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.

Business Unit Name Changed

Generated after a successful Change Name update action.

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
"BusinessUnitNameChanged"

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

Updated name of the Business Unit.

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.

Business Unit Deleted

Generated after a successful Delete BusinessUnit request.

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
"BusinessUnitDeleted"

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.

Business Unit Custom Field Added

Generated after adding a Custom Field to a Business Unit using the Set CustomField update action. If a Custom Field already exists with the same name, a BusinessUnitCustomFieldChanged Message is generated instead.

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
"BusinessUnitCustomFieldAdded"

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

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.

Business Unit Custom Field Changed

Generated after changing an existing Custom Field on a Business Unit using the Set CustomField update action.

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
"BusinessUnitCustomFieldChanged"

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

CustomFieldValue based on the FieldType after the Set CustomField update action.

oldValue

CustomFieldValue based on the FieldType before the Set CustomField 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.

Business Unit Custom Field Removed

Generated after removing a Custom Field from a Business Unit using the Set CustomField update action.

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
"BusinessUnitCustomFieldRemoved"

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

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.

Business Unit Custom Type Set

Generated after adding a Custom Type to a Business Unit using the Set Custom Type update action.

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
"BusinessUnitCustomTypeSet"

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 were set.

oldTypeId
String

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.

Business Unit Custom Type Removed

Generated after removing a Custom Type from a Business Unit using the Set Custom Type update action.

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
"BusinessUnitCustomTypeRemoved"

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

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.

Business Unit Address Custom Field Added

Generated after adding a Custom Field to an address of a Business Unit using the Set Address CustomField update action. If a Custom Field already exists with the same name, a BusinessUnitAddressCustomFieldChanged Message is generated instead.

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
"BusinessUnitAddressCustomFieldAdded"

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

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.

Business Unit Address Custom Field Changed

Generated after changing an existing Custom Field on an address of a Business Unit using the Set Address CustomField update action.

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
"BusinessUnitAddressCustomFieldChanged"

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

CustomFieldValue based on the FieldType after the Set CustomField update action.

oldValue

CustomFieldValue based on the FieldType before the Set CustomField update action.

addressId
String

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.

Business Unit Address Custom Field Removed

Generated after removing a Custom Field from an address of a Business Unit using the Set Address CustomField update action.

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
"BusinessUnitAddressCustomFieldRemoved"

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

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.

Business Unit Address Custom Type Set

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

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
"BusinessUnitAddressCustomTypeSet"

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 were set.

oldTypeId
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

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.

Business Unit Address Custom Type Removed

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

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
"BusinessUnitAddressCustomTypeRemoved"

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.

addressId
String

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.

Associate Role Messages

Messages that represent a change or an action performed on an Associate Role.

Associate Role Created

Generated after a successful Create AssociateRole request.

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
"AssociateRoleCreated"

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.

associateRole

The AssociateRole 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.

Associate Role BuyerAssignable Changed

Generated after a successful Change BuyerAssignable update action.

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
"AssociateRoleBuyerAssignableChanged"

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.

buyerAssignable
Boolean

The new value of the buyerAssignable field of the AssociateRole.

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.

Associate Role Permission Added

Generated after a successful Add Permissions update action.

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
"AssociateRolePermissionAdded"

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.

permission

The Permission that was added to the AssociateRole.

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.

Associate Role Permission Removed

Generated after a successful Remove Permissions update action.

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
"AssociateRolePermissionRemoved"

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.

permission

The Permission that was removed from the AssociateRole.

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.

Associate Role Permissions Set

Generated after a successful Set Permissions update action.

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
"AssociateRolePermissionsSet"

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.

permissions
Array of Permission

Permission assigned to the AssociateRole.

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.

Associate Role Name Set

Generated after a successful Set Name update action.

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
"AssociateRoleNameSet"

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

Updated name of the AssociateRole.

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.

Associate Role Deleted

Generated after a successful Delete AssociateRole request.

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
"AssociateRoleDeleted"

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.