Messages that represent a change or an action performed on a Cart, Order, Order Edit, or Recurring Order.

Messages are available in a variety of Message Types specific to a resource. Common fields across all Message Types are represented by a base resource, Message.
You can access Messages either by querying the Messages API, or by subscribing to them with a Subscription. To query Messages using the API, you must enable the feature first.

Cart Messages

Messages that represent a change or an action performed on a Cart.

Cart Estimated Delivery Set

Generated after a successful Set Estimated Delivery update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"CartEstimatedDeliverySet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
estimatedDelivery​
Estimated delivery window on the Cart after the Set Estimated Delivery update action.
shippingKey​
String​
key of the Shipping that was updated. Only present for Carts with Multiple ShippingMode.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Cart Frozen

Generated after a successful Freeze Cart update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"CartFrozen"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Cart Locked

Generated after a successful Lock Cart update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"CartLocked"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Cart Purchase Order Number Set

Generated after a successful Set Purchase Order Number update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"CartPurchaseOrderNumberSet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
purchaseOrderNumber​
String​
Purchase order number on the Cart after the Set Purchase Order Number update action.
oldPurchaseOrderNumber​
String​
Purchase order number on the Cart before the Set Purchase Order Number update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Cart Unfrozen

Generated after a successful Unfreeze Cart update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"CartUnfrozen"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Cart Unlocked

Generated after a successful Unlock Cart update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"CartUnlocked"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Messages

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

globally

Order Created

Generated after a successful Create Order request, for the initial Order created directly from a Cart.
Orders generated by a Recurring Order schedule do not emit this Message. They emit the OrderCreatedFromRecurringOrder Message instead.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
order​
Order that was created.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Created From Recurring Order

Generated after an Order is successfully created according to the defined schedule of a Recurring Order.

This Message is emitted in place of the standard OrderCreated Message: Orders generated by a Recurring Order schedule do not emit the OrderCreated Message.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"OrderCreatedFromRecurringOrder"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
order​
Order that was created.
recurringOrderRef​
Reference to the origin Recurring Order.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
order​
Order that was imported.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Edit Applied

Generated after successfully applying an OrderEdit.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
edit​
OrderEdit that was applied.
result​
Information about a successfully applied OrderEdit.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
order​
Order that has been deleted.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Purchase Order Number Set

Generated after a successful Set Purchase Order Number update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
purchaseOrderNumber​
String​
Purchase order number on the Order after the Set Purchase Order Number update action.
oldPurchaseOrderNumber​
String​
Purchase order number on the Order before the Set Purchase Order Number update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 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​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Line Item Added

Generated after a successful Add LineItem update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
lineItem​
Line Item that was added to the Order.
addedQuantity​
Int64​
Quantity of Line Items that were added to the Order.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Line Item Removed

Generated after a successful Remove LineItem update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
lineItemId​
String​
Unique identifier of the Line Item.
lineItemKey​
String​

User-defined identifier of the LineItem. Unique among LineItems in the Order.

removedQuantity​
Int64​
Quantity of Line Items that were removed during the Remove LineItem update action.
newQuantity​
Int64​
Line Item quantity after the Remove LineItem update action.
newState​
Array of ItemState​
ItemStates after the Remove LineItem update action.
newTotalPrice​
totalPrice of the Order after the Remove LineItem update action.
newTaxedPrice​
TaxedItemPrice of the Order after the Remove LineItem update action.
newPrice​
Price of the Order after the Remove LineItem update action.
newShippingDetail​
Shipping Details of the Order after the Remove LineItem update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Custom Line Item Added

Generated after a successful Add CustomLineItem update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
customLineItem​
Custom Line Item that was added to the Order.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Custom Line Item Removed

Generated after a successful Remove CustomLineItem update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
customLineItemId​
String​
Unique identifier of the Custom Line Item.
customLineItemKey​
String​
User-defined 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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Discount Code Added

Generated after a successful Add DiscountCode update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
discountCode​
DiscountCode that was added.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Discount Code Removed

Generated after a successful Remove DiscountCode update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
discountCode​
DiscountCode that was removed.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
discountCode​
DiscountCode that changed due to the recalculation.
DiscountCodeState after the recalculation.
oldState​
DiscountCodeState before the recalculation.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
paymentRef​
Payment that was added to the Order.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Payment Removed

Generated after a successful Remove Payment update action or when a Payment is removed via Order Edits.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"OrderPaymentRemoved"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
paymentRef​
Payment that was removed from the Order.
removedPaymentInfo​
Boolean​
Indicates whether the removal of the Payment resulted in no Payments remaining on the Order. The value is true if all Payments have been removed (none remain), and false if there are still Payments associated with the Order after the removal.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Payment State Changed

Generated after a successful Change PaymentState update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Estimated Delivery Set

Generated after a successful Set Estimated Delivery update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"OrderEstimatedDeliverySet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
estimatedDelivery​
Estimated delivery window on the Order after the Set Estimated Delivery update action.
shippingKey​
String​
key of the Shipping that was updated. Only present for Orders with Multiple ShippingMode.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Shipping Info Set

Generated after a successful Set ShippingMethod and Set Custom ShippingMethod update actions.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
shippingInfo​
oldShippingInfo​
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Shipment State Changed

Generated after a successful Change ShipmentState update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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 Parcel Added To Delivery Message containing information about the Parcels.
shippingKey​
String​
User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
delivery​
The Delivery that was removed from the Order.
shippingKey​
String​
User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Return Info Added

Generated after a successful Add ReturnInfo update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
returnInfo​
The ReturnInfo that was added to the Order.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Return Info Set

Generated after a successful Set ReturnInfo 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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 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​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order State Changed

Generated after a successful Change OrderState update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
store​
Store that was set.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Business Unit Set B2B B2X

Generated after a successful Set Business Unit update action on Orders or Set Business Unit update action on Order Edits.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"OrderBusinessUnitSet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
businessUnit​
BusinessUnit on the Order after the Set Business Unit update action on Orders or Set Business Unit update action on Order Edits.
oldbusinessUnit​
BusinessUnit on the Order before the Set Business Unit update action on Orders or Set Business Unit update action on Order Edits.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

on Line Item

Order Line Item Distribution Channel Set

Generated after a successful Set LineItem DistributionChannel update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
lineItemId​
String​
Unique identifier of the Line Item.
lineItemKey​
String​

User-defined identifier of the LineItem. Unique among LineItems in the Order.

distributionChannel​
Distribution Channel that was set.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
lineItemId​
String​
Unique identifier for the Line Item.
lineItemKey​
String​

User-defined identifier of the LineItem. Unique among LineItems in the Order.

discountedPricePerQuantity​
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​
Total taxed prices based on the quantity of Line Item assigned to each Shipping Method. Only applicable for Carts with Multiple ShippingMode. Automatically set after perMethodTaxRate is set.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Line Item State Transition

Generated after a successful Transition LineItem State update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
lineItemId​
String​
Unique identifier of the Line Item.
lineItemKey​
String​

User-defined identifier of the LineItem. Unique among LineItems in the Order.

transitionDate​
Date and time (UTC) the transition of the Line Item State was performed.
quantity​
Int64​
Number of Line Items for which the State was transitioned.
fromState​
State the Line Item was transitioned from.
toState​
State the Line Item was transitioned to.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

on Custom Line Item

Order Custom Line Item Quantity Changed

Generated after a successful Change CustomLineItem Quantity update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
customLineItemId​
String​
Unique identifier of the Custom Line Item.
customLineItemKey​
String​
User-defined unique identifier of the Custom Line Item.
quantity​
Int64​
Custom Line Item quantity after the Change Custom Line Item Quantity update action.
oldQuantity​
Int64​
Custom Line Item quantity before the Change Custom Line Item Quantity update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
customLineItemId​
String​
Unique identifier for the Custom Line Item.
customLineItemKey​
String​
User-defined unique identifier of the Custom Line Item.
discountedPricePerQuantity​
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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Custom Line Item State Transition

Generated after a successful Transition CustomLineItem State update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
customLineItemId​
String​
Unique identifier of the Custom Line Item.
customLineItemKey​
String​
User-defined unique identifier of the Custom Line Item.
transitionDate​
Date and time (UTC) the transition of the Custom Line Item State was performed.
quantity​
Int64​
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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

on Delivery

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
deliveryId​
String​
Unique identifier of the Delivery.
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 Multiple ShippingMode.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
delivery​
Unique identifier of the Delivery.
parcel​
Parcel that was added to the Delivery.
shippingKey​
String​
User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
deliveryId​
String​
Unique identifier of the Delivery.
parcel​
Parcel that was removed from the Delivery.
shippingKey​
String​
User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 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 Multiple ShippingMode.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Delivery Custom Field Added

Generated after adding a Custom Field to a Delivery using the Set CustomField update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"DeliveryCustomFieldAdded"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
name​
String​

Name of the Custom Field that was added.

value​
The added CustomFieldValue based on the FieldType.
deliveryId​
String​
Unique identifier of the Delivery.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Delivery Custom Field Changed

Generated when an existing Custom Field on a Delivery has been changed using the Set CustomField update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"DeliveryCustomFieldChanged"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
name​
String​

Name of the Custom Field that changed.

value​
CustomFieldValue based on the FieldType after the Set CustomField update action.
previousValue​
CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the name on the Delivery before, a Delivery Custom Field Added Message is generated instead.
deliveryId​
String​
Unique identifier of the Delivery.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Delivery Custom Field Removed

Generated when a Custom Field has been removed from the Delivery using the Set CustomField update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"DeliveryCustomFieldRemoved"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
name​
String​

Name of the Custom Field that was removed.

deliveryId​
String​
Unique identifier of the Delivery.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Delivery Custom Type Set

Generated after adding a Custom Type to a Delivery using the Set Custom Type update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"DeliveryCustomTypeSet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
customFields​

The Custom Fields that have been set.

previousTypeId​
String​
id of the previous Custom Type. Absent if there was no previous Custom Type present.
deliveryId​
String​
Unique identifier of the Delivery.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Delivery Custom Type Removed

Generated after removing a Custom Type from a Delivery using the Set Custom Type update action with empty parameters.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"DeliveryCustomTypeRemoved"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
previousTypeId​
String​
id of the Custom Type that was removed. Absent if there was no previous Custom Type present.
deliveryId​
String​
Unique identifier of the Delivery.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

on Parcel

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 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​
The Parcel Measurements that were set on the Parcel.
shippingKey​
String​
User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Parcel Tracking Data Updated

Generated after a successful Set Parcel Tracking Data update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 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​
The Tracking Data that was added to the Parcel.
shippingKey​
String​
User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 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 Multiple ShippingMode.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

on Return Item

Order Return Shipment State Changed

Generated after a successful Set ReturnShipmentState 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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

on Custom Fields and Types

Order Custom Field Added

Generated after adding a Custom Field using the Set CustomField.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"OrderCustomFieldAdded"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
name​
String​

Name of the Custom Field that was added.

value​
The added CustomFieldValue based on the FieldType.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Custom Field Changed

Generated when an existing Custom Field has been changed using the Set CustomField action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"OrderCustomFieldChanged"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
name​
String​

Name of the Custom Field that changed.

value​
CustomFieldValue based on the FieldType after the Set CustomField update action.
previousValue​
CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the name on the Order before, an Order Custom Field Added Message is generated instead.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Custom Field Removed

Generated when a Custom Field has been removed from the Order using the Set CustomField action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"OrderCustomFieldRemoved"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
name​
String​

Name of the Custom Field that was removed.

createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Custom Type Set

Generated after a successful Set Custom Type.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"OrderCustomTypeSet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
customFields​

The Custom Fields that have been set.

previousTypeId​
String​
id of the previous Custom Type. Absent if there was no previous Custom Type present.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Order Custom Type Removed

Generated after a successful Set Custom Type with empty parameters.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"OrderCustomTypeRemoved"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
previousTypeId​
String​
id of the Custom Type that was removed. Absent if there was no previous Custom Type present.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Recurring Order Messages

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

Recurring Order Created

Generated after a successful Create RecurringOrder request.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderCreated"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
recurringOrder​
RecurringOrder that was created.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Recurring Order Deleted

Generated after a successful Delete RecurringOrder request.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderDeleted"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
recurringOrder​
RecurringOrder that was deleted.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Recurring Order State Changed

Generated after a successful Set RecurringOrderState update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderStateChanged"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
oldState​
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Recurring Order Failed

Generated after a RecurringOrder failed to process an Order.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderFailed"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
cartId​
String​
ID of the Cart used in the failed Order creation attempt.
failedAt​

Date and time (UTC) when the Order creation attempt failed.

failureReason​
String​

Description of why the Order creation failed, such as insufficient stock.

orderScheduledAt​

Date and time (UTC) the Order was scheduled to be created.

errors​

Errors due to which the Order creation failed.

createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Recurring 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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderStateTransition"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
state​
RecurringOrderState after the Transition State update action.
oldState​
RecurringOrderState 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

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Recurring Order Starts At Set

Generated after a successful Set Starts At update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderStartsAtSet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
startsAt​
Start date and time of the Recurring Order after the Set Starts At update action.
oldStartsAt​
Start date and time of the Recurring Order before the Set Starts At update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Recurring Order Expires At Set

Generated after a successful Set Expires At update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderExpiresAtSet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
newExpiresAt​
Expiration date and time of the Recurring Order after the Set Expires At update action.
oldExpiresAt​
Expiration date and time of the Recurring Order before the Set Expires At update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Recurring Order Schedule Set

Generated after a successful Set Schedule update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderScheduleSet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
recurrencePolicySchedule​
Schedule of the Recurring Order after the Set Schedule update action.
oldRecurrencePolicySchedule​
Schedule of the Recurring Order before the Set Schedule update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Recurring Order Key Set

Generated after a successful Set Key update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
key​
String​
key value of the RecurringOrder after the Set Key update action.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderKeySet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
oldKey​
String​
key value of the RecurringOrder before the Set Key update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

on Custom Fields and Types

Recurring Order Custom Type Set

Generated after a successful Set Custom Type.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderCustomTypeSet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
customFields​

The Custom Fields that have been set.

previousTypeId​
String​
id of the previous Custom Type. Absent if there was no previous Custom Type present.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Recurring Order Custom Type Removed

Generated after a successful Set Custom Type with empty parameters.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderCustomTypeRemoved"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
previousTypeId​
String​
id of the Custom Type that was removed. Absent if there was no previous Custom Type present.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Recurring Order Custom Field Added

Generated after adding a Custom Field using the Set CustomField.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderCustomFieldAdded"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
name​
String​

Name of the Custom Field that was added.

value​
The added CustomFieldValue based on the FieldType.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Recurring Order Custom Field Changed

Generated when an existing Custom Field has been changed using the Set CustomField action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderCustomFieldChanged"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
name​
String​

Name of the Custom Field that changed.

value​
CustomFieldValue based on the FieldType after the Set CustomField update action.
previousValue​
CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the name on the Order before, an Order Custom Field Added Message is generated instead.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Recurring Order Custom Field Removed

Generated when a Custom Field has been removed from the Order using the Set CustomField action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"RecurringOrderCustomFieldRemoved"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
name​
String​

Name of the Custom Field that was removed.

createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.