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 the API, or by subscribing to them with a Subscription. To query them using the API, you must enable the feature first.
Representations
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
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 | Unique identifier usually used in deep-link URLs for a Product. The value corresponds to the slug in the |
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
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "LineItemStateTransition" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
lineItemId String | Unique identifier of the Line Item. |
transitionDate | |
quantity Int | Number of Line Items for which the State was transitioned. |
fromState | |
toState | |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomLineItemStateTransition" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
customLineItemId String | Unique identifier of the Custom Line Item. |
transitionDate | 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 | State the Custom Line Item was transitioned from. |
toState | State the Custom Line Item was transitioned to. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DeliveryAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
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 |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DeliveryRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
delivery | |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DeliveryItemsUpdated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
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 |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ParcelAddedToDelivery" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
delivery | Unique identifier of the Delivery. |
parcel | |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ParcelRemovedFromDelivery" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
deliveryId String | Unique identifier of the Delivery. |
parcel | |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ParcelTrackingDataUpdated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
deliveryId String | Unique identifier of the Delivery. |
parcelId String | Unique identifier of the Parcel. |
trackingData | The Tracking Data that was added to the Parcel. |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ParcelMeasurementsUpdated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
deliveryId String | Unique identifier of the Delivery. |
parcelId String | Unique identifier of the Parcel. |
measurements | The Parcel Measurements that were set on the Parcel. |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ParcelItemsUpdated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
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 |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DeliveryAddressSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
deliveryId String | Unique identifier of the Parcel. |
address | Address after the Set Delivery Address update action. |
oldAddress | Address before the Set Delivery Address update action. |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ReturnInfoAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
returnInfo | The ReturnInfo that was added to the Order. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ReturnInfoSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
returnInfo Array of ReturnInfo | The ReturnInfo that was set on the Order or Order Edit. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
order | Order that was created. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderImported" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
order | Order that was imported. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderStateChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
orderState | OrderState after the Change Order State update action. |
oldOrderState | OrderState before the Change Order State update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderStateTransition" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
state | OrderState after the Transition State update action. |
oldState | OrderState before the Transition State update action. |
force Boolean | Whether State transition validations were turned off during the Transition State update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomerEmailSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
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 | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomerSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
customer | Customer on the Order after the Set Customer Id update action. |
customerGroup | CustomerGroup on the Order after the Set Customer Id update action. |
oldCustomer | Customer on the Order before the Set Customer Id update action. |
oldCustomerGroup | CustomerGroup on the Order before the Set Customer Id update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomerGroupSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
customerGroup | CustomerGroup on the Order after the Set Customer Group update action. |
oldCustomerGroup | CustomerGroup on the Order before the Set Customer Group update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderShippingAddressSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
address | Shipping address on the Order after the Set Shipping Address update action. |
oldAddress | Shipping address on the Order before the Set Shipping Address update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderBillingAddressSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
address | Billing address on the Order after the Set Billing Address update action. |
oldAddress | Billing address on the Order before the Set Billing Address update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderPaymentAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
payment | |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderPaymentStateChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
paymentState | PaymentState after the Change Payment State update action. |
oldPaymentState | PaymentState before the Change Payment State update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderShipmentStateChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
shipmentState | ShipmentState after the Change Shipment State update action. |
oldShipmentState | ShipmentState before the Change Shipment State update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderReturnShipmentStateChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
returnItemId String | Unique identifier of the ReturnItem. |
returnShipmentState | State of the ReturnItem after the Set Return Shipment State update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderEditApplied" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
edit | OrderEdit that was applied. |
result | Information about a successfully applied OrderEdit. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomLineItemAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
customLineItem | Custom Line Item that was added to the Order. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomLineItemRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
customLineItemId String | Unique identifier of the Custom Line Item. |
customLineItem | Custom Line Item that was removed from the Order. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomLineItemQuantityChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
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 | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderLineItemAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
lineItem | |
addedQuantity Int | Quantity of Line Items that were added to the Order. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderLineItemRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
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 |
|
newTaxedPrice | TaxedItemPrice of the Order after the Remove Line Item update action. |
newPrice | Price of the Order after the Remove Line Item update action. |
newShippingDetail | Shipping Details of the Order after the Remove Line Item update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderLineItemDistributionChannelSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
lineItemId String | Unique identifier of the Line Item. |
distributionChannel | Distribution Channel that was set. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderShippingInfoSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
shippingInfo | ShippingInfo after the Set Shipping Method or Set Custom Shipping Method update action. |
oldShippingInfo | ShippingInfo before the Set Shipping Method or Set Custom Shipping Method update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderShippingRateInputSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
shippingRateInput | ShippingRateInput after the Set ShippingRateInput update action. |
oldShippingRateInput | ShippingRateInput before the Set ShippingRateInput update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderDiscountCodeAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
discountCode | DiscountCode that was added. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderDiscountCodeRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
discountCode | DiscountCode that was removed. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderDiscountCodeStateSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
discountCode | DiscountCode that changed due to the recalculation. |
state | DiscountCodeState after the recalculation. |
oldState | DiscountCodeState before the recalculation. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderLineItemDiscountSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
lineItemId String | Unique identifier for the Line Item. |
discountedPricePerQuantity Array of DiscountedLineItemPriceForQuantity | Array of DiscountedLineItemPriceForQuantity after the Discount recalculation. |
totalPrice | Total Price of the Line Item after the Discount recalculation. |
taxedPrice | TaxedItemPrice of the Line Item after the Discount recalculation. |
taxedPricePortions Array of MethodTaxedPrice | Taxed price of the Shipping Methods in a Cart with |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomLineItemDiscountSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
customLineItemId String | Unique identifier for the Custom Line Item. |
discountedPricePerQuantity Array of DiscountedLineItemPriceForQuantity | Array of DiscountedLineItemPriceForQuantity after the Discount recalculation. |
taxedPrice | TaxedItemPrice of the Custom Line Item after the Discount recalculation. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderStoreSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | Store that was set. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
Purchase Order Number Set
Generated after a successful Set PurchaseOrderNumber 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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderPurchaseOrderNumberSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
purchaseOrderNumber String | Purchase order number on the Order after the Set PurchaseOrderNumber update action. |
oldPurchaseOrderNumber String | Purchase order number on the Order before the Set PurchaseOrderNumber update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
order | Order that has been deleted. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
Product Messages
Product Messages represent a change or an action performed on a Product.
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
productProjection | The staged Product Projection of the Product at the time of creation. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductPublished" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
removedImageUrls Array of String | List of image URLs which were removed during the Publish update action. |
productProjection | Current Product Projection of the Product at the time of creation. |
scope | Publishing Scope that was used during the Publish update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductUnpublished" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductStateTransition" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
state | Product State after the Transition State update action. |
force Boolean | Whether State transition validations were turned off during the Transition State update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductSlugChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
slug | The slug of the Product after the Change Slug update action. |
oldSlug | The slug of the Product before the Change Slug update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductImageAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variantId Int | Unique identifier of the Product Variant to which the Image was added. |
image | Image that was added. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductRevertedStagedChanges" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
removedImageUrls Array of String | List of image URLs that were removed during the Revert Staged Changes update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
Product Price Key Set
Generated after a successful Set Price Key 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 |
key String |
2 MaxLength: 256 Pattern: ^[A-Za-z0-9_-]+$ |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductPriceKeySet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variantId Int | |
priceId String | Unique identifier of the Price. |
oldKey String |
2 MaxLength: 256 Pattern: ^[A-Za-z0-9_-]+$ |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductPriceDiscountsSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
updatedPrices Array of ProductPriceDiscountsSetUpdatedPrice | Array containing details about the Embedded Prices that were updated. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 Price. |
discounted | 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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductPriceExternalDiscountSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
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 Price. |
discounted | 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 | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
Product Price Added
Generated after a successful Add 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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductPriceAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variantId Int | Unique identifier of the ProductVariant for which the Price was added. |
price | The Embedded Price that was added to the ProductVariant. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
Product Price Changed
Generated after a successful Change 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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductPriceChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variantId Int | Unique identifier of the ProductVariant for which the Price was changed. |
oldPrice | The current Embedded Price before the Change Embedded Price update action. |
newPrice | The Embedded Price after the Change Embedded Price update action. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
oldStagedPrice | The staged Embedded Price before the Change Embedded Price update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
Product Prices Set
Generated after a successful Set Embedded Prices 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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductPricesSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variantId Int | Unique identifier of the ProductVariant for which the Price was set. |
prices Array of Price | The Embedded Prices that were set on the ProductVariant. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
Product Price Removed
Generated after a successful Remove 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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductPriceRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variantId Int | Unique identifier of the ProductVariant for which the Price was removed. |
price | The Embedded Price that was removed from the ProductVariant. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
Product Price Mode Set
Generated after a successful Set PriceMode 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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductPriceModeSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
The PriceMode that was set. | |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductVariantAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variant | Unique identifier of the Product Variant that was added. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductVariantDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variant | 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 | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductAddedToCategory" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
category | |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductRemovedFromCategory" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
category | |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
removedImageUrls Array of String | List of image URLs that were removed during the Delete Product request. |
currentProjection | Current Product Projection of the deleted Product. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
Product Selection Messages
Product Selection Messages represent a change or an action performed on a Product Selection.
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductSelectionCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
productSelection | Product Selection that was created. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductSelectionProductAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
product | Product that was added to the Product Selection. |
variantSelection | Product Variant Selection after the Add Product update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
Product Selection Product Excluded BETA
Generated after a successful Exclude 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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductSelectionProductExcluded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
product | Product that was excluded from the Product Selection. |
variantExclusion | Product Variant Exclusion after the Exclude Product update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductSelectionProductRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
product | Product that was removed from the Product Selection. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductSelectionVariantSelectionChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
product | Product for which the Product Variant Selection changed. |
oldVariantSelection | Product Variant Selection before the Set Variant Selection update action. |
newVariantSelection | Product Variant Selection after the Set Variant Selection update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
Product Selection Variant Exclusion Changed BETA
Generated after a successful Set Variant Exclusion 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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductSelectionVariantExclusionChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
product | Product for which the Product Variant Exclusion changed. |
oldVariantExclusion | Product Variant Exclusion before the Set Variant Exclusion update action. |
newVariantExclusion | Product Variant Exclusion after the Set Variant Exclusion update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ProductSelectionDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
Category Messages
Category Messages represent a change or an action performed on a Category.
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CategoryCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
category | Category that was created. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CategorySlugChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
slug | The slug of the Category after the Change Slug update action. |
oldSlug | The slug of the Category before the Change Slug update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
Payment Messages
Payment Messages represent a change or an action performed on a Payment.
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
payment | Payment that was created. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentInteractionAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
interaction | The interface interaction that was added to the Payment. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentTransactionAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
transaction | Transaction that was added to the Payment. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt | Value of |
lastModifiedBy BETA | Value of |
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 |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentTransactionStateChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
transactionId String | Unique identifier for the Transaction for which the Transaction State changed. |
state | Transaction State after the Change Transaction State update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | Present on resources created after 1 February 2019 except for events not tracked. |
lastModifiedAt |