Messages

A Message represents a change or an action performed on a resource, for example an Order or a Product.

Messages are available in a variety of Message Types specific to a resource. Common fields across Message Types are represented by a base resource, Message. In addition to these common fields, each Message contains further fields related to a particular change or action (for example, the field firstName is present on a CustomerFirstNameSet Message).

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

Representations

Message

MessagePagedQueryResponse

UserProvidedIdentifiers -ContainerAndKey

Message

Base representation of a Message containing common fields to all Message Types.

`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	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	Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Message fields that can be used in query predicates: createdAt, lastModifiedAt, id, version, sequenceNumber, resource, resourceVersion, type.

MessagePagedQueryResponse

PagedQueryResult with results containing an array of Message.

`limit` Int	Number of results requested.
`count` Int	Actual number of results returned.
`total` Int	Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`. When the results are filtered with a Query Predicate, `total` is subject to a limit.
`offset` Int	Number of elements skipped.
`results` Array of Message	Messages matching the query.

UserProvidedIdentifiers

User-provided identifiers present on the resource for which the Message is created. The value of the identifier stored in the Message corresponds to the one that was set on the resource at the version shown in resourceVersion.

`key` String	User-provided unique identifier of the resource.
`customerNumber` String	User-provided unique identifier of a Customer.
`externalId` String	User-provided unique identifier of the resource.
`orderNumber` String	User-provided unique identifier of an Order.
`sku` String	Unique SKU of a Product Variant.
`slug` LocalizedString	Unique identifier usually used in deep-link URLs for a Product. The value corresponds to the slug in the `current` Product Projection.
`containerAndKey` ContainerAndKey	Unique identifier of a Custom Object.

ContainerAndKey

ContainerAndKey is specific to Custom Objects. Custom Objects are grouped into containers, which can be used like namespaces. Within a given container, a user-defined key can be used to uniquely identify resources.

`key` String	User-defined identifier that is unique within the given container.
`container` String	Namespace to group Custom Objects.

Message Types

Messages are available in a variety of Message Types specific to a resource. These representations contain common Message fields as well as fields specific to the particular Message Type.

Order Messages

Order Messages represent a change or an action performed on an Order.

Line Item State Transition

Custom Line Item State Transition

Delivery Added

Delivery Removed

Delivery Items Updated

Parcel Added To Delivery

Parcel Removed From Delivery

Parcel Tracking Data Updated

Parcel Measurements Updated

Order State Transition

Order Customer Email Set

Order Customer Set

Order Customer Group Set

Order Shipping Address Set

Order Billing Address Set

Order Payment Added

Order Payment State Changed

Order Shipment State Changed

Order Return Shipment State Changed

Order Edit Applied

Order Custom Line Item Added

Order Custom Line Item Removed

Order Custom Line Item Quantity Changed

Order Line Item Added

Order Line Item Removed

Order Line Item Distribution Channel Set

Order Shipping Info Set

Order Shipping Rate Input Set

Order Discount Code Added

Order Discount Code Removed

Order Discount Code State Set

Order Line Item Discount Set

Order Custom Line Item Discount Set

Order Store Set

Order Deleted

Line Item State Transition

Generated after a successful Transition Line Item State 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	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	`"LineItemStateTransition"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`lineItemId` String	Unique identifier of the Line Item.
`transitionDate` DateTime	Date and time (UTC) when the transition of the Line Item State was performed.
`quantity` Int	Number of Line Items for which the State was transitioned.
`fromState` StateReference	State the Line Item was transitioned from.
`toState` StateReference	State the Line Item was transitioned to.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Custom Line Item State Transition

Generated after a successful Transition Custom Line Item State 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	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	`"CustomLineItemStateTransition"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`customLineItemId` String	Unique identifier of the Custom Line Item.
`transitionDate` DateTime	Date and time (UTC) when the transition of the Custom Line Item State was performed.
`quantity` Int	Number of Custom Line Items for which the State was transitioned.
`fromState` StateReference	State the Custom Line Item was transitioned from.
`toState` StateReference	State the Custom Line Item was transitioned to.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Delivery Added

Generated after a successful Add Delivery 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	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	`"DeliveryAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`delivery` Delivery	Delivery that was added to the Order. The Delivery in the Message body does not contain Parcels if those were part of the initial Add Delivery update action. In that case, the update action produces an additional ParcelAddedToDelivery Message containing information about the Parcels.
`shippingKey` String	User-defined unique identifier of the Shipping Method in a Cart with `Multi` ShippingMode.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Delivery Removed

Generated after a successful Remove Delivery 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	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	`"DeliveryRemoved"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`delivery` Delivery	The Delivery that was removed from the Order.
`shippingKey` String	User-defined unique identifier of the Shipping Method in a Cart with `Multi` ShippingMode.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Delivery Items Updated

Generated after a successful Set Delivery Items 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	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	`"DeliveryItemsUpdated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`deliveryId` String	Unique identifier of the Delivery.
`items` Array of DeliveryItem	Delivery Items after the Set Delivery Items update action.
`oldItems` Array of DeliveryItem	Delivery Items before the Set Delivery Items update action.
`shippingKey` String	User-defined unique identifier of the Shipping Method in a Cart with `Multi` ShippingMode.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Parcel Added To Delivery

Generated after a successful Add Parcel To Delivery 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	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	`"ParcelAddedToDelivery"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`delivery` Delivery	Unique identifier of the Delivery.
`parcel` Parcel	Parcel that was added to the Delivery.
`shippingKey` String	User-defined unique identifier of the Shipping Method in a Cart with `Multi` ShippingMode.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Parcel Removed From Delivery

Generated after a successful Remove Parcel From Delivery 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	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	`"ParcelRemovedFromDelivery"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`deliveryId` String	Unique identifier of the Delivery.
`parcel` Parcel	Parcel that was removed from the Delivery.
`shippingKey` String	User-defined unique identifier of the Shipping Method in a Cart with `Multi` ShippingMode.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Parcel Tracking Data Updated

Generated after a successful Set Parcel TrackingData 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	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	`"ParcelTrackingDataUpdated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`deliveryId` String	Unique identifier of the Delivery.
`parcelId` String	Unique identifier of the Parcel.
`trackingData` TrackingData	The Tracking Data that was added to the Parcel.
`shippingKey` String	User-defined unique identifier of the Shipping Method in a Cart with `Multi` ShippingMode.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Parcel Measurements Updated

Generated after a successful Set Parcel Measurements 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	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	`"ParcelMeasurementsUpdated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`deliveryId` String	Unique identifier of the Delivery.
`parcelId` String	Unique identifier of the Parcel.
`measurements` ParcelMeasurements	The Parcel Measurements that were set on the Parcel.
`shippingKey` String	User-defined unique identifier of the Shipping Method in a Cart with `Multi` ShippingMode.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Parcel Items Updated

Generated after a successful Set Parcel Items 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	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	`"ParcelItemsUpdated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`parcelId` String	Unique identifier of the Parcel.
`deliveryId` String	Unique identifier of the Delivery.
`items` Array of DeliveryItem	Delivery Items after the Set Parcel Items update action.
`oldItems` Array of DeliveryItem	Delivery Items before the Set Parcel Items update action.
`shippingKey` String	User-defined unique identifier of the Shipping Method in a Cart with `Multi` ShippingMode.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Delivery Address Set

Generated after a successful Set Delivery 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	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	`"DeliveryAddressSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`deliveryId` String	Unique identifier of the Parcel.
`address` Address	Address after the Set Delivery Address update action.
`oldAddress` Address	Address before the Set Delivery Address update action.
`shippingKey` String	User-defined unique identifier of the Shipping Method in a Cart with `Multi` ShippingMode.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Return Info Added

Generated after a successful Add Return Info 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	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	`"ReturnInfoAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`returnInfo` ReturnInfo	The ReturnInfo that was added to the Order.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Return Info Set

Generated after a successful Set Return Info update action on Orders and Order Edits.

`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	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	`"ReturnInfoSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`returnInfo` Array of ReturnInfo	The ReturnInfo that was set on the Order or Order Edit.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Created

Generated after a successful Create Order 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	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	`"OrderCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`order` Order	Order that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Imported

Generated after a successful Order Import.

`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	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	`"OrderImported"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`order` Order	Order that was imported.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order State Changed

Generated after a successful Change Order State 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	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	`"OrderStateChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`orderState` OrderState	OrderState after the Change Order State update action.
`oldOrderState` OrderState	OrderState before the Change Order State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order State Transition

Generated after a successful Transition State 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	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	`"OrderStateTransition"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`state` StateReference	OrderState after the Transition State update action.
`oldState` StateReference	OrderState before the Transition State update action.
`force` Boolean	Whether State transition validations were turned off during the Transition State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Customer Email Set

Generated after a successful Set Customer 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	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	`"OrderCustomerEmailSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`email` String	Email address on the Order after the Set Customer Email update action.
`oldEmail` String	Email address on the Order before the Set Customer Email update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Customer Set

Generated after a successful Set Customer Id 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	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	`"OrderCustomerSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`customer` CustomerReference	Customer on the Order after the Set Customer Id update action.
`customerGroup` CustomerGroupReference	CustomerGroup on the Order after the Set Customer Id update action.
`oldCustomer` CustomerReference	Customer on the Order before the Set Customer Id update action.
`oldCustomerGroup` CustomerGroupReference	CustomerGroup on the Order before the Set Customer Id update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Customer Group Set

Generated after a successful Set Customer Group 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	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	`"OrderCustomerGroupSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`customerGroup` CustomerGroupReference	CustomerGroup on the Order after the Set Customer Group update action.
`oldCustomerGroup` CustomerGroupReference	CustomerGroup on the Order before the Set Customer Group update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Shipping Address Set

Generated after a successful Set 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	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	`"OrderShippingAddressSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	Shipping address on the Order after the Set Shipping Address update action.
`oldAddress` Address	Shipping address on the Order before the Set Shipping Address update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Billing Address Set

Generated after a successful Set 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	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	`"OrderBillingAddressSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	Billing address on the Order after the Set Billing Address update action.
`oldAddress` Address	Billing address on the Order before the Set Billing Address update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Payment Added

Generated after a successful Add Payment update action or when a Payment is added via Order Edits.

`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	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	`"OrderPaymentAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`payment` PaymentReference	Payment that was added to the Order.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Payment State Changed

Generated after a successful Change Payment State 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	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	`"OrderPaymentStateChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`paymentState` PaymentState	PaymentState after the Change Payment State update action.
`oldPaymentState` PaymentState	PaymentState before the Change Payment State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Shipment State Changed

Generated after a successful Change Shipment State 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	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	`"OrderShipmentStateChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`shipmentState` ShipmentState	ShipmentState after the Change Shipment State update action.
`oldShipmentState` ShipmentState	ShipmentState before the Change Shipment State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Return Shipment State Changed

Generated after a successful Set Return Shipment State 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	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	`"OrderReturnShipmentStateChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`returnItemId` String	Unique identifier of the ReturnItem.
`returnShipmentState` ReturnShipmentState	State of the ReturnItem after the Set Return Shipment State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Edit Applied

Generated after a successfully applying an OrderEdit.

`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	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	`"OrderEditApplied"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`edit` OrderEdit	OrderEdit that was applied.
`result` OrderEditApplied	Information about a successfully applied OrderEdit.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Custom Line Item Added

Generated after a successful Add Custom Line Item 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	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	`"OrderCustomLineItemAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`customLineItem` CustomLineItem	Custom Line Item that was added to the Order.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Custom Line Item Removed

Generated after a successful Remove Custom Line Item 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	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	`"OrderCustomLineItemRemoved"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`customLineItemId` String	Unique identifier of the Custom Line Item.
`customLineItem` CustomLineItem	Custom Line Item that was removed from the Order.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Custom Line Item Quantity Changed

Generated after a successful Change Custom Line Item Quantity 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	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	`"OrderCustomLineItemQuantityChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`customLineItemId` String	Unique identifier of the Custom Line Item.
`quantity` Int	Custom Line Item quantity after the Change Custom Line Item Quantity update action.
`oldQuantity` Int	Custom Line Item quantity before the Change Custom Line Item Quantity update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Line Item Added

Generated after a successful Add Line Item 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	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	`"OrderLineItemAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`lineItem` LineItem	Line Item that was added to the Order.
`addedQuantity` Int	Quantity of Line Items that were added to the Order.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Line Item Removed

Generated after a successful Remove Line Item 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	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	`"OrderLineItemRemoved"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`lineItemId` String	Unique identifier of the Line Item.
`removedQuantity` Int	Quantity of Line Items that were removed during the Remove Line Item update action.
`newQuantity` Int	Line Item quantity after the Remove Line Item update action.
`newState` Array of ItemState	ItemStates after the Remove Line Item update action.
`newTotalPrice` CentPrecisionMoney	`totalPrice` of the Order after the Remove Line Item update action.
`newTaxedPrice` TaxedItemPrice	TaxedItemPrice of the Order after the Remove Line Item update action.
`newPrice` Price	Price of the Order after the Remove Line Item update action.
`newShippingDetail` ItemShippingDetails	Shipping Details of the Order after the Remove Line Item update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Line Item Distribution Channel Set

Generated after a successful Set Line Item Distribution Channel 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	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	`"OrderLineItemDistributionChannelSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`lineItemId` String	Unique identifier of the Line Item.
`distributionChannel` ChannelReference	Distribution Channel that was set.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Shipping Info Set

Generated after a successful Set Shipping Method and Set Custom Shipping Method update actions.

`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	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	`"OrderShippingInfoSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`shippingInfo` ShippingInfo	ShippingInfo after the Set Shipping Method or Set Custom Shipping Method update action.
`oldShippingInfo` ShippingInfo	ShippingInfo before the Set Shipping Method or Set Custom Shipping Method update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Shipping Rate Input Set

Generated after a successful Set ShippingRateInput 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	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	`"OrderShippingRateInputSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`shippingRateInput` ShippingRateInput	ShippingRateInput after the Set ShippingRateInput update action.
`oldShippingRateInput` ShippingRateInput	ShippingRateInput before the Set ShippingRateInput update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Discount Code Added

Generated after a successful Add Discount Code 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	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	`"OrderDiscountCodeAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`discountCode` DiscountCodeReference	DiscountCode that was added.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Discount Code Removed

Generated after a successful Remove Discount Code 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	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	`"OrderDiscountCodeRemoved"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`discountCode` DiscountCodeReference	DiscountCode that was removed.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Discount Code State Set

Generated after the DiscountCodeState changes due to a recalculation.

`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	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	`"OrderDiscountCodeStateSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`discountCode` DiscountCodeReference	DiscountCode that changed due to the recalculation.
`state` DiscountCodeState	DiscountCodeState after the recalculation.
`oldState` DiscountCodeState	DiscountCodeState before the recalculation.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Line Item Discount Set

Generated after a successful recalculation of a Discount on a Line Item.

`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	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	`"OrderLineItemDiscountSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`lineItemId` String	Unique identifier for the Line Item.
`discountedPricePerQuantity` Array of DiscountedLineItemPriceForQuantity	Array of DiscountedLineItemPriceForQuantity after the Discount recalculation.
`totalPrice` Money	Total Price of the Line Item after the Discount recalculation.
`taxedPrice` TaxedItemPrice	TaxedItemPrice of the Line Item after the Discount recalculation.
`taxedPricePortions` Array of MethodTaxedPrice	Taxed price of the Shipping Methods in a Cart with `Multi` ShippingMode..
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Custom Line Item Discount Set

Generated after a successful recalculation of a Discount on a Custom Line Item.

`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	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	`"OrderCustomLineItemDiscountSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`customLineItemId` String	Unique identifier for the Custom Line Item.
`discountedPricePerQuantity` Array of DiscountedLineItemPriceForQuantity	Array of DiscountedLineItemPriceForQuantity after the Discount recalculation.
`taxedPrice` TaxedItemPrice	TaxedItemPrice of the Custom Line Item after the Discount recalculation.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Store Set

Generated after a successful Set 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	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	`"OrderStoreSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`store` StoreKeyReference	Store that was set.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Order Deleted

Generated after a successful Delete Order 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	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	`"OrderDeleted"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`order` Order	Order that has been deleted.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Messages

Product Messages represent a change or an action performed on a Product.

Product Created

Product Published

Product Unpublished

Product State Transition

Product Slug Changed

Product Image Added

Product Reverted Staged Changes

Product Price Discounts Set -Product Price Discounts Set Updated Price

Product Price External Discount Set

Product Variant Added

Product Variant Deleted

Product Added To Category

Product Removed From Category

Product Deleted

Product Created

Generated after a successful Create Product 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	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	`"ProductCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`productProjection` ProductProjection	The staged Product Projection of the Product at the time of creation.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Published

Generated after a successful Publish 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	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	`"ProductPublished"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`removedImageUrls` Array of String	List of image URLs which were removed during the Publish update action.
`productProjection` ProductProjection	Current Product Projection of the Product at the time of creation.
`scope` ProductPublishScope	Publishing Scope that was used during the Publish update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Unpublished

Generated after a successful Unpublish Product 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	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	`"ProductUnpublished"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product State Transition

Generated after a successful Transition State 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	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	`"ProductStateTransition"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`state` StateReference	Product State after the Transition State update action.
`force` Boolean	Whether State transition validations were turned off during the Transition State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Slug Changed

Generated after a successful Change Slug 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	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	`"ProductSlugChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`slug` LocalizedString	The slug of the Product after the Change Slug update action.
`oldSlug` LocalizedString	The slug of the Product before the Change Slug update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Image Added

Generated after a successful Add External Image update action or after the successful upload of an image.

`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	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	`"ProductImageAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`variantId` Int	Unique identifier of the Product Variant to which the Image was added.
`image` Image	Image that was added.
`staged` Boolean	Whether the update was only applied to the staged Product Projection.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Reverted Staged Changes

Generated after a successful Revert Staged Changes 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	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	`"ProductRevertedStagedChanges"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`removedImageUrls` Array of String	List of image URLs that were removed during the Revert Staged Changes update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Price Discounts Set

Generated after a Price is updated due to a Product Discount.

`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	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	`"ProductPriceDiscountsSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`updatedPrices` Array of ProductPriceDiscountsSetUpdatedPrice	Array containing details about the Embedded Prices that were updated.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Price Discounts Set Updated Price

Details about a Embedded Price that was updated due to a Discount. Specific to ProductPriceDiscountsSet Message.

`variantId` Int	Unique identifier of the ProductVariant for which the Discount was set.
`variantKey` String	Key of the ProductVariant for which Discount was set.
`sku` String	SKU of the ProductVariant for which Discount was set.
`priceId` String	Unique identifier of the Embedded Price.
`discounted` DiscountedPrice	Discounted Price for the ProductVariant for which Discount was set.
`staged` Boolean	Whether the update was only applied to the staged ProductProjection.

Product Price External Discount Set

Generated after a successful Set Discounted Embedded Price 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	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	`"ProductPriceExternalDiscountSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`variantId` Int	Unique identifier of the Product Variant for which the Discount was set.
`variantKey` String	Key of the Product Variant for which the Discount was set.
`sku` String	SKU of the Product Variant for which Discount was set.
`priceId` String	Unique identifier of the Embedded Price.
`discounted` DiscountedPrice	Discounted Price for the Product Variant for which Discount was set.
`staged` Boolean	Whether the update was only applied to the staged Product Projection.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Variant Added

Generated after a successful Add Product Variant 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	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	`"ProductVariantAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`variant` ProductVariant	Unique identifier of the Product Variant that was added.
`staged` Boolean	Whether the update was only applied to the staged Product Projection.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Variant Deleted

Generated after a successful Remove Product Variant 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	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	`"ProductVariantDeleted"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`variant` ProductVariant	Unique identifier of the Product Variant that was added.
`removedImageUrls` Array of String	List of image URLs that were removed with the Remove Product Variant update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Added To Category

Generated after a successful Add To Category 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	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	`"ProductAddedToCategory"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`category` CategoryReference	Category the Product was added to.
`staged` Boolean	Whether the update was only applied to the staged Product Projection.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Removed From Category

Generated after a successful Remove From Category 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	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	`"ProductRemovedFromCategory"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`category` CategoryReference	Category the Product was removed from.
`staged` Boolean	Whether the update was only applied to the staged Product Projection.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Deleted

Generated after a successful Delete Product 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	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	`"ProductDeleted"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`removedImageUrls` Array of String	List of image URLs that were removed during the Delete Product request.
`currentProjection` ProductProjection	Current Product Projection of the deleted Product.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Selection Messages BETA

Product Selection Messages represent a change or an action performed on a Product Selection.

Product Selection Created

Product Selection Product Added

Product Selection Product Removed

Product Selection Variant Selection Changed

Product Selection Deleted

Product Selection Created

Generated after a successful Create Product Selection 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	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	`"ProductSelectionCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`productSelection` IndividualProductSelectionType	The `type` and `name` of the individual Product Selection.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Selection Product Added

Generated after a successful Add Product 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	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	`"ProductSelectionProductAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`product` ProductReference	Product that was added to the Product Selection.
`variantSelection` ProductVariantSelection	Product Variant Selection after the Add Product update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Selection Product Removed

Generated after a successful Remove Product 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	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	`"ProductSelectionProductRemoved"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`product` ProductReference	Product that was removed from the Product Selection.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Selection Variant Selection Changed

Generated after a successful Set Variant Selection 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	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	`"ProductSelectionVariantSelectionChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`product` ProductReference	Product for which the Product Variant Selection changed.
`oldVariantSelection` ProductVariantSelection	Product Variant Selection before the Set Variant Selection update action.
`newVariantSelection` ProductVariantSelection	Product Variant Selection after the Set Variant Selection update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Product Selection Deleted

Generated after a successful Delete Product Selection 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	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	`"ProductSelectionDeleted"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Category Messages

Category Messages represent a change or an action performed on a Category.

Category Created

Category Slug Changed

Category Created

Generated after a successful Create Category 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	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	`"CategoryCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`category` Category	Category that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Category Slug Changed

Generated after a successful Change Slug 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	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	`"CategorySlugChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`slug` LocalizedString	The slug of the Category after the Change Slug update action.
`oldSlug` LocalizedString	The slug of the Category before the Change Slug update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Payment Messages

Payment Messages represent a change or an action performed on a Payment.

Payment Created

Payment Interaction Added

Payment Transaction Added

Payment Transaction State Changed

Payment Status State Transition

Payment Status Interface Code Set

Payment Created

Generated after a successful Create Payment 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	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	`"PaymentCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`payment` Payment	Payment that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Payment Interaction Added

Generated after a successful Add InterfaceInteraction 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	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	`"PaymentInteractionAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`interaction` CustomFields	The interface interaction that was added to the Payment.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Payment Transaction Added

Generated after a successful Add Transaction 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	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	`"PaymentTransactionAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`transaction` Transaction	Transaction that was added to the Payment.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Payment Transaction State Changed

Generated after a successful Change Transaction State 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	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	`"PaymentTransactionStateChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`transactionId` String	Unique identifier for the Transaction for which the Transaction State changed.
`state` TransactionState	Transaction State after the Change Transaction State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Payment Status State Transition

Generated after a successful Transition State 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	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	`"PaymentStatusStateTransition"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`state` StateReference	State of the Payment after the Transition State update action.
`force` Boolean	Whether State transition validations were turned off during the Change Transaction State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Payment Status Interface Code Set

Generated after a successful Set StatusInterfaceCode 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	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	`"PaymentStatusInterfaceCodeSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`paymentId` String	Unique identifier for the Payment for which the Set StatusInterfaceCode update action was applied.
`interfaceCode` String	The `interfaceCode` that was set during the Set StatusInterfaceCode update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer Messages

Customer Messages represent a change or an action performed on a Customer.

Customer Created

Customer Deleted

Customer Address Changed

Customer Email Changed

Customer Email Verified

Customer First Name Set

Customer Last Name Set

Customer Title Set

Customer Company Name Set

Customer Date Of Birth Set

Customer Group Set

Customer Address Removed

Customer Address Added

Customer Password Updated

Customer Created

Generated after a successful Create Customer 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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`customer` Customer	Customer that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer Deleted

Generated after a successful Delete Customer 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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerDeleted"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer 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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerAddressChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	Address that was set during the Change Address update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer Email Changed

Generated after a successful Change 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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerEmailChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`email` String	The `email` that was set during the Change Email update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer Email Verified

Generated after a successful Verify Customer's Email 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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerEmailVerified"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer First Name Set

Generated after a successful Set First 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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerFirstNameSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`firstName` String	The `firstName` that was set during the Set First Name update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer Last Name Set

Generated after a successful Set Last 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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerLastNameSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`lastName` String	The `lastName` that was set during the Set Last Name update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer Title Set

Generated after a successful Set Title 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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerTitleSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`title` String	The `title` that was set during the Set Title update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer Company Name Set

Generated after a successful Set Company 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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerCompanyNameSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`companyName` String	The `companyName` that was set during the Set Company Name update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer Date Of Birth Set

Generated after a successful Set Date of Birth 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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerDateOfBirthSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`dateOfBirth` Date	The `dateOfBirth` that was set during the Set Date of Birth update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer Group Set

Generated after a successful Set Customer Group 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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerGroupSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`customerGroup` CustomerGroupReference	Customer Group that was set during the Set Customer Group update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer 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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerAddressRemoved"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	Address that was removed during the Remove Address update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer 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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerAddressAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	Address that was added during the Add Address update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Customer Password Updated

Generated after a successful Reset Customer's Password, Reset Customer's Password in a Store, Change Customer's Password, or Change Customer's Password in a Store request. This Message is also produced during equivalent requests to the My Customer Profile endpoint.

`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	Reference to the resource on which the change or action was performed.
`resourceVersion` Int	Version of the resource on which the change or action was performed.
`type` String	`"CustomerPasswordUpdated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`reset` Boolean	Whether the Customer's password was updated during the Reset password or Change password flow.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Review Messages

Review Messages represent a change or an action performed on a Review.

Review Created

Review State Transition

Review Rating Set

Review Created

Generated after a successful Create Review 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	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	`"ReviewCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`review` Review	Review that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Review State Transition

Generated after a successful Transition State 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	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	`"ReviewStateTransition"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`oldState` StateReference	State of the Review before the Transition State update action.
`newState` StateReference	State of the Review after the Transition State update action.
`oldIncludedInStatistics` Boolean	Whether the old Review was taken into account in the rating statistics of the target before the state transition.
`newIncludedInStatistics` Boolean	Whether the new Review was taken into account in the rating statistics of the target after the state transition.
`target` Reference	Reference to the resource that the Review belongs to.
`force` Boolean	Whether State transition validations were turned off during the Transition State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Review Rating Set

Generated after a successful Set Rating 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	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	`"ReviewRatingSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`oldRating` Float	The `rating` of the Review before the Set Rating update action.
`newRating` Float	The `rating` of the Review after the Set Rating update action.
`includedInStatistics` Boolean	Whether the Review was taken into account in the ratings statistics of the target.
`target` Reference	Reference to the resource that the Review belongs to.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

InventoryEntry Messages

InventoryEntry Created

InventoryEntry Deleted

InventoryEntry Quantity Set

InventoryEntry Created

Generated after a successful Create InventoryEntry 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	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	`"InventoryEntryCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`inventoryEntry` InventoryEntry	InventoryEntry that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

InventoryEntry Deleted

Generated after a successful Delete InventoryEntry 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	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	`"InventoryEntryDeleted"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`sku` String	The `sku` of the InventoryEntry that was deleted.
`supplyChannel` ChannelReference	Reference to the Channel where the InventoryEntry was deleted.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

InventoryEntry Quantity Set

Generated after a successful Add Quantity, Remove Quantity or Change Quantity update action. Inventory changes as a result of Order creation do not trigger this message.

`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	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	`"InventoryEntryQuantitySet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`oldQuantityOnStock` Int	Quantity on stock for the InventoryEntry before the quantity was updated.
`newQuantityOnStock` Int	Quantity on stock for the InventoryEntry after the quantity was updated.
`oldAvailableQuantity` Int	Available quantity for the InventoryEntry before the quantity was updated.
`newAvailableQuantity` Int	Available quantity for the InventoryEntry after the quantity was updated.
`supplyChannel` ChannelReference	Reference to the Channel where the InventoryEntry quantity was set.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Store Messages

Store Messages represent a change or an action performed on a Store.

Store Created

Store Deleted

Store Languages Changed

Store Name Set

Store Product Selections Changed

Store Distribution Channels Changed

Store Supply Channels Changed

Store Created

Generated after a successful Create Store 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	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	`"StoreCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`name` LocalizedString	The `name` of the Store that was created.
`languages` Array of String	Languages of the Store that was created. Languages are represented as IETF language tags.
`distributionChannels` Array of ChannelReference	Distribution Channels of the Store that was created.
`supplyChannels` Array of ChannelReference	Supply Channels of the Store that was created.
`productSelections` Array of ProductSelectionSetting	ProductSelectionSettings of the Store that was created.
`custom` CustomFields	Custom Fields on the Store that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Store Deleted

Generated after a successful Delete Store 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	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	`"StoreDeleted"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Store Languages Changed

Generated after a successful Set Languages 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	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	`"StoreLanguagesChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`addedLanguages` Array of Locale	Locales added to the Store after the Set Languages update action.
`removedLanguages` Array of Locale	Locales removed from the Store during the Set Languages update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Store 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	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	`"StoreNameSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`name` LocalizedString	Name of the Store set during the Set Name update action.
`nameAllLocales` Array of LocalizedString	Names set for the Store in different locales.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Store Product Selections Changed BETA

Generated by a successful Add Product Selection, Remove Product Selection, Set Product Selections, or Change Product Selections Active 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	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	`"StoreProductSelectionsChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`addedProductSelections` Array of ProductSelectionSetting	ProductSelectionSettings that were added to the Store.
`removedProductSelections` Array of ProductSelectionSetting	ProductSelectionSettings that were removed from the Store.
`updatedProductSelections` Array of ProductSelectionSetting	ProductSelectionSettings that were updated in the Store.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Store Distribution Channels Changed

Generated after a successful Add Distribution Channel, Remove Distribution Channel, or Set Distribution Channels 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	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	`"StoreDistributionChannelsChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`addedDistributionChannels` Array of ChannelReference	Product distribution Channels that have been added to the Store.
`removedDistributionChannels` Array of ChannelReference	Product distribution Channels that have been removed from the Store.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Store Supply Channels Changed

Generated after a successful Add Supply Channel, Remove Supply Channel, or Set Supply Channels 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	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	`"StoreSupplyChannelsChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`addedSupplyChannels` Array of ChannelReference	Inventory supply Channels that have been added to the Store.
`removedSupplyChannels` Array of ChannelReference	Inventory supply Channels that have been removed from the Store.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Quote Request Messages BETA

Quote Request Messages represent a change or an action performed on a QuoteRequest.

Quote Request Created

Quote Request State Changed

Quote Request State Transition

Quote Request Deleted

Quote Request Created

Generated after a successful Create Quote Request 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	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	`"QuoteRequestCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`quoteRequest` QuoteRequest	Quote Request that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Quote Request State Changed

Generated after a successful Change Quote Request State 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	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	`"QuoteRequestStateChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`quoteRequestState` QuoteRequestState	State of the Quote Request after the Change Quote Request State update action.
`oldQuoteRequestState` QuoteRequestState	State of the Quote Request before the Change Quote Request State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Quote Request State Transition

Generated after a successful Transition State 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	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	`"QuoteRequestStateTransition"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`state` StateReference	State of the Quote after the Transition State update action.
`oldState` StateReference	State of the Quote before the Transition State update action.
`force` Boolean	Whether State transition validations were turned off during the Transition State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Quote Request Deleted

Generated after a successful Delete Quote Request 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	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	`"QuoteRequestDeleted"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Staged Quote Messages BETA

Staged Quote Messages represent a change or an action performed on a StagedQuote.

Staged Quote Created

Staged Quote State Changed

Staged Quote State Transition

Staged Quote ValidTo Set

Staged Quote Seller Comment Set

Staged Quote Deleted

Staged Quote Created

Generated after a successful Create Staged Quote 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	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	`"StagedQuoteCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`stagedQuote` StagedQuote	Staged Quote that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Staged Quote State Changed

Generated after a successful Change Staged Quote State 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	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	`"StagedQuoteStateChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`stagedQuoteState` StagedQuoteState	State of the Staged Quote after the Change Staged Quote State update action.
`oldStagedQuoteState` StagedQuoteState	State of the Staged Quote before the Change Staged Quote State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Staged Quote State Transition

Generated after a successful Transition State 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	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	`"StagedQuoteStateTransition"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`state` StateReference	State of the Quote after the Transition State update action.
`oldState` StateReference	State of the Quote before the Transition State update action.
`force` Boolean	Whether State transition validations were turned off during the Transition State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Staged Quote ValidTo Set

Generated after a successful Set Valid To 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	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	`"StagedQuoteValidToSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`validTo` DateTime	Expiration date for the Staged Quote after the Set Valid To update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Staged Quote Seller Comment Set

Generated after a successful Set Seller Comment 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	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	`"StagedQuoteSellerCommentSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`sellerComment` String	`sellerComment` on the StagedQuote after a successful Set Seller Comment update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Staged Quote Deleted

Generated after a successful Delete Staged Quote 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	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	`"StagedQuoteDeleted"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Quote Messages BETA

Quote Messages represent a change or an action performed on a Quote.

Quote Created

Quote State Changed

Quote State Transition

Quote Deleted

Quote Created

Generated after a successful Create Quote 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	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	`"QuoteCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`quote` Quote	Quote that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Quote State Changed

Generated after a successful Change Quote State 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	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	`"QuoteStateChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`quoteState` QuoteState	State of the Quote after the Change Quote State update action.
`oldQuoteState` QuoteState	State of the Quote before the Change Quote State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Quote State Transition

Generated after a successful Transition State 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	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	`"QuoteStateTransition"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`state` StateReference	State of the Quote after the Transition State update action.
`oldState` StateReference	State of the Quote before the Transition State update action.
`force` Boolean	Whether State transition validations were turned off during the Transition State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Quote Deleted

Generated after a successful Delete Quote 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	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	`"QuoteDeleted"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Standalone Price Messages

Standalone Price Messages represent a change or an action performed on a StandalonePrice.

Standalone Price Created

Standalone Price Deleted

Standalone Price Value Changed

Standalone Price Discount Set

Standalone Price External Discount Set

Standalone Price Staged Changes Applied

Standalone Price Active Changed

Standalone Price Created

Generated after a successful Create StandalonePrice 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	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	`"StandalonePriceCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`standalonePrice` StandalonePrice	Standalone Price that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Standalone Price Deleted

Generated after a successful Delete StandalonePrice 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	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	`"StandalonePriceDeleted"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Standalone Price Value Changed

Generated after a successful Change Value 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	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	`"StandalonePriceValueChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`value` Money	The new value of the updated StandalonePrice.
`staged`BETA Boolean	Whether the new value was applied to the current or the staged representation of the StandalonePrice. Staged changes are stored on the StagedStandalonePrice. Default: `false`
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Standalone Price Discount Set

Generated after a Product Discount is successfully applied to a StandalonePrice.

`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	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	`"StandalonePriceDiscountSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`discounted` DiscountedPrice	The new `discounted` value of the updated StandalonePrice.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Standalone Price External Discount Set

Generated after a successful Set Discounted Price 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	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	`"StandalonePriceExternalDiscountSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`discounted` DiscountedPrice	The `discounted` value of the StandalonePrice after the Set Discounted Price update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Standalone Price Staged Changes Applied BETA

Generated after a successful Apply Staged Changes 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	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	`"StandalonePriceStagedChangesApplied"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`stagedChanges` StagedStandalonePrice	Applied changes of the StandalonePrice after the Apply Staged Changes update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Standalone Price Active Changed BETA

Generated after a successful Change Active 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	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	`"StandalonePriceActiveChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`active` Boolean	Value of the `active` field of the StandalonePrice after the Change Active update action.
`oldActive` Boolean	Value of the `active` field of the StandalonePrice before the Change Active update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Business Unit Messages BETA

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

Business Unit Created

Generated after a successful Create Business Unit 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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`businessUnit` BusinessUnit	The Business Unit that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	The address that was added to the Business Unit.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	Updated address of the Business Unit.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	The address that was removed from the Business Unit.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`associate` Associate	The Associate that was added to the Business Unit.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	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` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`associate` Associate	The Associate that was updated.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`associate` Associate	The Associate that was removed from the Business Unit.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Business Unit Parent Unit 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	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	`"BusinessUnitParentUnitChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`oldParentUnit` BusinessUnitKeyReference	Parent unit of the Business Unit before the Change Parent Unit update action.
`newParentUnit` BusinessUnitKeyReference	Parent unit of the Business Unit after the Change Parent Unit update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`store` StoreKeyReference	The Store that was added to the Business Unit.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	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` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	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	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	BusinessUnitStoreMode of the Business Unit before the Set Store Mode update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Business Unit Store Removed

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`store` StoreKeyReference	The Store that was removed from the Business Unit.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`active` BusinessUnitStatus	Updated status of the Business Unit.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	The address that was added to the Business Unit as billing address.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	The address that was removed from the billing addresses of the Business Unit.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	The address that was set as the default billing address.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	The address that was added to the Business Unit as shipping address.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	The address that was removed from shipping addresses of the Business Unit.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`address` Address	The address that was set as the default shipping address.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	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` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

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	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` UserProvidedIdentifiers	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` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Business Unit Deleted

Generated after a successful Delete Business Unit 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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	Present on resources created after 1 February 2019 except for events not tracked.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	Value of `createdBy`.

Enable querying Messages via the API

To optimize the performance of your Project, Messages are not persisted by default. To access Messages via the API, you must first enable the feature in the Settings > Developer Settings section of the Merchant Center. Alternatively, you can use the Change Messages Configuration update action.

Get Message

GET

https://api.{region}.commercetools.com/{projectKey}/messages/{id}

Deprecated scope: view_orders:{projectKey}

OAuth 2.0 Scopes:

view_messages:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the Message.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Response:

200Message

Request Example:cURL

curl -X GET https://api.{region}.commercetools.com/{projectKey}/messages/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: Messagejson

{
  "id" : "2723ca8f-283c-4add-90bc-0978d195ed3c",
  "version" : 1,
  "versionModifiedAt" : "1970-01-01T00:00:00.001Z",
  "sequenceNumber" : 4,
  "resource" : {
    "typeId" : "payment",
    "id" : "e57c8183-eb2b-4bf3-acf1-f8a7846689f8"
  },
  "resourceVersion" : 5,
  "resourceUserProvidedIdentifiers" : {
    "key" : "e57-payment-key"
  },
  "type" : "PaymentStatusInterfaceCodeSet",
  "paymentId" : "e57c8183-eb2b-4bf3-acf1-f8a7846689f8",
  "interfaceCode" : "InterfaceCodeString",
  "createdAt" : "1970-01-01T00:00:00.001Z",
  "lastModifiedAt" : "1970-01-01T00:00:00.001Z",
  "lastModifiedBy" : {
    "clientId" : "ey8aTsYwE0_kxFvT1rJeglpC",
    "isPlatformClient" : false
  },
  "createdBy" : {
    "clientId" : "ey8aTsYwE0_kxFvT1rJeglpC",
    "isPlatformClient" : false
  }
}

Query Messages

GET

https://api.{region}.commercetools.com/{projectKey}/messages

Deprecated scope: view_orders:{projectKey}

OAuth 2.0 Scopes:

view_messages:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

`where` QueryPredicate	The parameter can be passed multiple times.
`/^var[.][a-zA-Z0-9]+$/` Any string parameter matching this regular expression	Predicate parameter values. The parameter can be passed multiple times.
`sort` Sort	The parameter can be passed multiple times.
`expand` Expansion	The parameter can be passed multiple times.
`limit` Int	Number of results requested.
`offset` Int	Number of elements skipped.
`withTotal` Boolean	Controls the calculation of the total number of query results. Set to `false` to improve query performance when the `total` is not needed.

Response:

200MessagePagedQueryResponse

Request Example:cURL

curl -X GET https://api.{region}.commercetools.com/{projectKey}/messages -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: MessagePagedQueryResponsejson

{
  "limit" : 20,
  "offset" : 0,
  "count" : 1,
  "total" : 1,
  "results" : [ {
    "id" : "2723ca8f-283c-4add-90bc-0978d195ed3c",
    "version" : 1,
    "versionModifiedAt" : "1970-01-01T00:00:00.001Z",
    "sequenceNumber" : 4,
    "resource" : {
      "typeId" : "payment",
      "id" : "e57c8183-eb2b-4bf3-acf1-f8a7846689f8"
    },
    "resourceVersion" : 5,
    "resourceUserProvidedIdentifiers" : {
      "key" : "e57-payment-key"
    },
    "type" : "PaymentStatusInterfaceCodeSet",
    "paymentId" : "e57c8183-eb2b-4bf3-acf1-f8a7846689f8",
    "interfaceCode" : "InterfaceCodeString",
    "createdAt" : "1970-01-01T00:00:00.001Z",
    "lastModifiedAt" : "1970-01-01T00:00:00.001Z",
    "lastModifiedBy" : {
      "clientId" : "ey8aTsYwE0_kxFvT1rJeglpC",
      "isPlatformClient" : false
    },
    "createdBy" : {
      "clientId" : "ey8aTsYwE0_kxFvT1rJeglpC",
      "isPlatformClient" : false
    }
  } ]
}