This is the early access documentation preview for Custom Views. This documentation might not be in sync with our official documentation.

Messages

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

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

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

Representations

Message

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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

MessagePagedQueryResponse

PagedQueryResult with results containing an array of Message.

limit
Int
count
Int

Actual number of results returned.

total
Int

Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. When the results are filtered with a Query Predicate, total is subject to a limit.

offset
Int

Number of elements skipped.

results
Array of Message

Messages matching the query.

UserProvidedIdentifiers

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

key
String

User-provided unique identifier of the resource.

customerNumber
String

User-provided unique identifier of a Customer.

externalId
String

User-provided unique identifier of the resource.

orderNumber
String

User-provided unique identifier of an Order.

sku
String

Unique SKU of a Product Variant.

slug

Unique identifier usually used in deep-link URLs for a Product. The value corresponds to the slug in the current Product Projection.

containerAndKey

Unique identifier of a Custom Object.

ContainerAndKey

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

key
String

User-defined identifier that is unique within the given container.

container
String

Namespace to group Custom Objects.

Message Types

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

Order Messages

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

globally

Order Created

Generated after a successful Create Order request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderCreated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order Imported

Generated after a successful Order Import.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderImported"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order Deleted

Generated after a successful Delete Order request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order Customer Set

Generated after a successful Set Customer ID update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderCustomerSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order Customer Email Set

Generated after a successful Set Customer Email update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderCustomerEmailSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order Customer Group Set

Generated after a successful Set Customer Group update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderCustomerGroupSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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
Int

Quantity of Line Items that were added to the Order.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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 unique identifier of the LineItem.

removedQuantity
Int

Quantity of Line Items that were removed during the Remove Line Item update action.

newQuantity
Int

Line Item quantity after the Remove Line Item update action.

newState
Array of ItemState

ItemStates after the Remove Line Item update action.

newTotalPrice

totalPrice of the Order after the Remove Line Item update action.

newTaxedPrice

TaxedItemPrice of the Order after the Remove Line Item update action.

newPrice

Price of the Order after the Remove Line Item update action.

newShippingDetail

Shipping Details of the Order after the Remove Line Item update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order Discount Code State Set

Generated after the DiscountCodeState changes due to a recalculation.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderDiscountCodeStateSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order Payment Added

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderPaymentAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

payment

Payment that was added to the Order.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order Billing Address Set

Generated after a successful Set Billing Address update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderBillingAddressSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order Shipping Address Set

Generated after a successful Set Shipping Address update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderShippingAddressSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order Shipping Rate Input Set

Generated after a successful Set ShippingRateInput update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderShippingRateInputSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Delivery Added

Generated after a successful Add Delivery update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"DeliveryAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Delivery Removed

Generated after a successful Remove Delivery update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"DeliveryRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order State Transition

Generated after a successful Transition State update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderStateTransition"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order Store Set

Generated after a successful Set Store update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderStoreSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

Store that was set.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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 unique identifier of the LineItem.

distributionChannel

Distribution Channel that was set.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order Line Item Discount Set

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderLineItemDiscountSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

lineItemId
String

Unique identifier for the Line Item.

lineItemKey
String

User-defined unique identifier of the LineItem.

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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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 unique identifier of the LineItem.

transitionDate

Date and time (UTC) when the transition of the Line Item State was performed.

quantity
Int

Number of Line Items for which the State was transitioned.

fromState

State the Line Item was transitioned from.

toState

State the Line Item was transitioned to.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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
Int

Custom Line Item quantity after the Change Custom Line Item Quantity update action.

oldQuantity
Int

Custom Line Item quantity before the Change Custom Line Item Quantity update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Order Custom Line Item Discount Set

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"OrderCustomLineItemDiscountSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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) when the transition of the Custom Line Item State was performed.

quantity
Int

Number of Custom Line Items for which the State was transitioned.

fromState

State the Custom Line Item was transitioned from.

toState

State the Custom Line Item was transitioned to.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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 Parcel.

address

Address after the Set Delivery Address update action.

oldAddress

Address before the Set Delivery Address update action.

shippingKey
String

User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Parcel Added To Delivery

Generated after a successful Add Parcel to Delivery update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ParcelAddedToDelivery"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Parcel Removed From Delivery

Generated after a successful Remove Parcel from Delivery update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ParcelRemovedFromDelivery"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Delivery Items Updated

Generated after a successful Set Delivery Items update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"DeliveryItemsUpdated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Parcel Items Updated

Generated after a successful Set Parcel Items update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ParcelItemsUpdated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as 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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Messages

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

Product Created

Generated after a successful Create Product request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductCreated"

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.

productProjection

The staged Product Projection of the Product at the time of creation.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Published

Generated after a successful Publish update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductPublished"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

removedImageUrls
Array of String

List of image URLs which were removed during the Publish update action.

productProjection

Current Product Projection of the Product at the time of creation.

Publishing Scope that was used during the Publish update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Unpublished

Generated after a successful Unpublish Product update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductUnpublished"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product State Transition

Generated after a successful Transition State update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductStateTransition"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

state

Product State after the Transition State update action.

force
Boolean

Whether State transition validations were turned off during the Transition State update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Slug Changed

Generated after a successful Change Slug update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductSlugChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

slug

The slug of the Product after the Change Slug update action.

oldSlug

The slug of the Product before the Change Slug update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Image Added

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductImageAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

variantId
Int

Unique identifier of the Product Variant to which the Image was added.

image

Image that was added.

staged
Boolean

Whether the update was only applied to the staged Product Projection.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Reverted Staged Changes

Generated after a successful Revert Staged Changes update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductRevertedStagedChanges"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

removedImageUrls
Array of String

List of image URLs that were removed during the Revert Staged Changes update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Price Key Set

Generated after a successful Set Price Key update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

key
String

key value of the Price after the Set Price Key update action.

MinLength: 2MaxLength: 256Pattern: ^[A-Za-z0-9_-]+$
sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductPriceKeySet"

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.

variantId
Int
priceId
String

Unique identifier of the Price.

oldKey
String

key value of the Price before the Set Price Key update action.

MinLength: 2MaxLength: 256Pattern: ^[A-Za-z0-9_-]+$
staged
Boolean

Whether the update was only applied to the staged Product Projection.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Price Discounts Set

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductPriceDiscountsSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

updatedPrices

Array containing details about the Embedded Prices that were updated.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Price Discounts Set Updated Price

Details about a Embedded Price that was updated due to a Discount. Specific to Product Price Discounts Set Message.

variantId
Int

Unique identifier of the ProductVariant for which the Discount was set.

variantKey
String

Key of the ProductVariant for which Discount was set.

sku
String

SKU of the ProductVariant for which Discount was set.

priceId
String

Unique identifier of the Price.

discounted

Discounted Price for the ProductVariant for which Discount was set.

staged
Boolean

Whether the update was only applied to the staged ProductProjection.

Product Price External Discount Set

Generated after a successful Set Discounted Price update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductPriceExternalDiscountSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

variantId
Int

Unique identifier of the Product Variant for which the Discount was set.

variantKey
String

Key of the Product Variant for which the Discount was set.

sku
String

SKU of the Product Variant for which Discount was set.

priceId
String

Unique identifier of the Price.

discounted

Discounted Price for the Product Variant for which Discount was set.

staged
Boolean

Whether the update was only applied to the staged Product Projection.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Price Added

Generated after a successful Add Price update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductPriceAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

variantId
Int

Unique identifier of the ProductVariant for which the Price was added.

price

The Embedded Price that was added to the ProductVariant.

staged
Boolean

Whether the update was only applied to the staged Product Projection.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Price Changed

Generated after a successful Change Price update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductPriceChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

variantId
Int

Unique identifier of the ProductVariant for which the Price was changed.

oldPrice

The current Embedded Price before the Change Embedded Price update action.

newPrice

The Embedded Price after the Change Embedded Price update action.

staged
Boolean

Whether the update was only applied to the staged Product Projection.

oldStagedPrice

The staged Embedded Price before the Change Embedded Price update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Prices Set

Generated after a successful Set Prices update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductPricesSet"

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.

variantId
Int

Unique identifier of the ProductVariant for which the Price was set.

prices
Array of Price

The Embedded Prices that were set on the ProductVariant.

staged
Boolean

Whether the update was only applied to the staged Product Projection.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Price Removed

Generated after a successful Remove Price update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductPriceRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

variantId
Int

Unique identifier of the ProductVariant for which the Price was removed.

price

The Embedded Price that was removed from the ProductVariant.

staged
Boolean

Whether the update was only applied to the staged Product Projection.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Price Mode Set

Generated after a successful Set PriceMode update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductPriceModeSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

The PriceMode that was set.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Variant Added

Generated after a successful Add ProductVariant update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductVariantAdded"

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.

variant

Unique identifier of the Product Variant that was added.

staged
Boolean

Whether the update was only applied to the staged Product Projection.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Variant Deleted

Generated after a successful Remove ProductVariant update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductVariantDeleted"

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.

variant

Unique identifier of the Product Variant that was added.

removedImageUrls
Array of String

List of image URLs that were removed with the Remove Product Variant update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Added To Category

Generated after a successful Add to Category update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductAddedToCategory"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

category

Category the Product was added to.

staged
Boolean

Whether the update was only applied to the staged Product Projection.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Removed From Category

Generated after a successful Remove from Category update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductRemovedFromCategory"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

category

Category the Product was removed from.

staged
Boolean

Whether the update was only applied to the staged Product Projection.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Deleted

Generated after a successful Delete Product request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

removedImageUrls
Array of String

List of image URLs that were removed during the Delete Product request.

currentProjection

Current Product Projection of the deleted Product.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Selection Messages

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

Product Selection Created

Generated after a successful Create Product Selection request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductSelectionCreated"

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.

productSelection

Product Selection that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Selection Product Added

Generated after a successful Add Product update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductSelectionProductAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

product

Product that was added to the Product Selection.

variantSelection

Product Variant Selection after the Add Product update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Selection Product Excluded

Generated after a successful Exclude Product update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductSelectionProductExcluded"

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.

product

Product that was excluded from the Product Selection.

variantExclusion

Product Variant Exclusion after the Exclude Product update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Selection Product Removed

Generated after a successful Remove Product update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductSelectionProductRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

product

Product that was removed from the Product Selection.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Selection Variant Selection Changed

Generated after a successful Set Variant Selection update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductSelectionVariantSelectionChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

product

Product for which the Product Variant Selection changed.

oldVariantSelection

Product Variant Selection before the Set Variant Selection update action.

newVariantSelection

Product Variant Selection after the Set Variant Selection update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Selection Variant Exclusion Changed

Generated after a successful Set Variant Exclusion update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductSelectionVariantExclusionChanged"

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.

product

Product for which the Product Variant Exclusion changed.

oldVariantExclusion

Product Variant Exclusion before the Set Variant Exclusion update action.

newVariantExclusion

Product Variant Exclusion after the Set Variant Exclusion update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Product Selection Deleted

Generated after a successful Delete Product Selection request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ProductSelectionDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Category Messages

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

Category Created

Generated after a successful Create Category request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CategoryCreated"

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.

category

Category that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Category Slug Changed

Generated after a successful Change Slug update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CategorySlugChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

slug

The slug of the Category after the Change Slug update action.

oldSlug

The slug of the Category before the Change Slug update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Payment Messages

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

Payment Created

Generated after a successful Create Payment request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"PaymentCreated"

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.

payment

Payment that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Payment Interaction Added

Generated after a successful Add InterfaceInteraction update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"PaymentInteractionAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

interaction

The interface interaction that was added to the Payment.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Payment Transaction Added

Generated after a successful Add Transaction update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"PaymentTransactionAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

transaction

Transaction that was added to the Payment.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Payment Transaction State Changed

Generated after a successful Change TransactionState update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"PaymentTransactionStateChanged"

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.

transactionId
String

Unique identifier for the Transaction for which the Transaction State changed.

state
createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Payment Status State Transition

Generated after a successful Transition State update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"PaymentStatusStateTransition"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

state

State of the Payment after the Transition State update action.

force
Boolean

Whether State transition validations were turned off during the Change Transaction State update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Payment Status Interface Code Set

Generated after a successful Set StatusInterfaceCode update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"PaymentStatusInterfaceCodeSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

interfaceCode
String

The interfaceCode that was set during the Set StatusInterfaceCode update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Messages

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

Customer Created

Generated after a successful Create Customer request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerCreated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

customer

Customer that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Deleted

Generated after a successful Delete Customer request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Address Changed

Generated after a successful Change Address update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerAddressChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

address

Address that was set during the Change Address update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Email Changed

Generated after a successful Change Email update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerEmailChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

email
String

The email that was set during the Change Email update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Email Verified

Generated after a successful Verify Customer's Email request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerEmailVerified"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer First Name Set

Generated after a successful Set First Name update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerFirstNameSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

firstName
String

The firstName that was set during the Set First Name update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Last Name Set

Generated after a successful Set Last Name update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerLastNameSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

lastName
String

The lastName that was set during the Set Last Name update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Title Set

Generated after a successful Set Title update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerTitleSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

title
String

The title that was set during the Set Title update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Company Name Set

Generated after a successful Set Company Name update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerCompanyNameSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

companyName
String

The companyName that was set during the Set Company Name update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Date Of Birth Set

Generated after a successful Set Date of Birth update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerDateOfBirthSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

dateOfBirth
Date

The dateOfBirth that was set during the Set Date of Birth update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Group Set

Generated after a successful Set Customer Group update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerGroupSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

customerGroup

Customer Group that was set during the Set Customer Group update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Address Removed

Generated after a successful Remove Address update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerAddressRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

address

Address that was removed during the Remove Address update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Address Added

Generated after a successful Add Address update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerAddressAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

address

Address that was added during the Add Address update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Password Updated

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerPasswordUpdated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

reset
Boolean

Whether the Customer's password was updated during the Reset password or Change password flow.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Custom Field Added

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerCustomFieldAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Name of the Custom Field that was added.

value

The added CustomFieldValue based on the FieldType.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Custom Field Changed

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerCustomFieldChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

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 Customer before, a Customer Custom Field Added Message is generated instead.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Custom Field Removed

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerCustomFieldRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Name of the Custom Field that was removed.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Custom Type Set

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerCustomTypeSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

customFields

The Custom Fields that have been set.

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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Custom Type Removed

Generated after removing a Custom Type from a Customer 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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerCustomTypeRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Address Custom Field Added

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerAddressCustomFieldAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Name of the Custom Field that was added.

value

The added CustomFieldValue based on the FieldType.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Address Custom Field Changed

Generated after changing an existing Custom Field on an Address of a Customer using the Set CustomField in Address update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerAddressCustomFieldChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

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 Customer Address before, a Customer Address Custom Field Added Message is generated instead.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Address Custom Field Removed

Generated after removing a Custom Field from an Address of a Customer using the Set CustomField in Address update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerAddressCustomFieldRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Name of the Custom Field that was removed.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Address Custom Type Set

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerAddressCustomTypeSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

customFields

The Custom Fields that have been set.

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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Address Custom Type Removed

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerAddressCustomTypeRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

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.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Token Messages

These Messages represent a change or an action performed on a CustomerToken.

Customer Email Token Created

Generated after a successful Create email token for Customer request. The resource property of the Message is a CustomerEmailTokenReference.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerEmailTokenCreated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

customerId
String

Unique identifier of the Customer.

expiresAt

Date and time (UTC) the email token expires.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Password Token Created

Generated after a successful Create password reset token for Customer request. The resource property of the Message is a CustomerPasswordTokenReference.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerPasswordTokenCreated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

customerId
String

Unique identifier of the Customer.

expiresAt

Date and time (UTC) the password token expires.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Group Messages

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

Customer Group Custom Field Added

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerGroupCustomFieldAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Name of the Custom Field that was added.

value

The added CustomFieldValue based on the FieldType.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Group Custom Field Changed

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerGroupCustomFieldChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Name of the Custom Field that changed.

value

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

oldValue

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

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Group Custom Field Removed

Generated after removing a Custom Field from a Customer Group using the Set CustomField update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerGroupCustomFieldRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Name of the Custom Field that was removed.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Group Custom Type Set

Generated after adding a Custom Type to a Customer Group using the Set Custom Type update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerGroupCustomTypeSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

customFields

The Custom Fields that have been set.

oldTypeId
String

id of the previous Custom Type. Absent if there was no previous Custom Type present.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Customer Group Custom Type Removed

Generated after removing a Custom Type from a Customer Group 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
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CustomerGroupCustomTypeRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

oldTypeId
String

id of the Custom Type that was removed. Absent if there was no previous Custom Type present.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Review Messages

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

Review Created

Generated after a successful Create Review request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ReviewCreated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

review

Review that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Review State Transition

Generated after a successful Transition State update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ReviewStateTransition"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

oldState

State of the Review before the Transition State update action.

newState

State of the Review after the Transition State update action.

oldIncludedInStatistics
Boolean

Whether the old Review was taken into account in the rating statistics of the target before the state transition.

newIncludedInStatistics
Boolean

Whether the new Review was taken into account in the rating statistics of the target after the state transition.

target

Reference to the resource that the Review belongs to.

force
Boolean

Whether State transition validations were turned off during the Transition State update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Review Rating Set

Generated after a successful Set Rating update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ReviewRatingSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

oldRating
Float

The rating of the Review before the Set Rating update action.

newRating
Float

The rating of the Review after the Set Rating update action.

includedInStatistics
Boolean

Whether the Review was taken into account in the ratings statistics of the target.

target

Reference to the resource that the Review belongs to.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

InventoryEntry Messages

InventoryEntry Created

Generated after a successful Create InventoryEntry request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"InventoryEntryCreated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

inventoryEntry

InventoryEntry that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

InventoryEntry Deleted

Generated after a successful Delete InventoryEntry request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"InventoryEntryDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

sku
String

The sku of the InventoryEntry that was deleted.

supplyChannel

Reference to the Channel where the InventoryEntry was deleted.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

InventoryEntry Quantity Set

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"InventoryEntryQuantitySet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

oldQuantityOnStock
Int

Quantity on stock for the InventoryEntry before the quantity was updated.

newQuantityOnStock
Int

Quantity on stock for the InventoryEntry after the quantity was updated.

oldAvailableQuantity
Int

Available quantity for the InventoryEntry before the quantity was updated.

newAvailableQuantity
Int

Available quantity for the InventoryEntry after the quantity was updated.

supplyChannel

Reference to the Channel where the InventoryEntry quantity was set.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Store Messages

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

Store Created

Generated after a successful Create Store request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StoreCreated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name

The name of the Store that was created.

languages
Array of String

Languages of the Store that was created. Languages are represented as IETF language tags.

countries
Array of StoreCountry

Countries of the Store that was created.

distributionChannels
Array of ChannelReference

Distribution Channels of the Store that was created.

supplyChannels
Array of ChannelReference

Supply Channels of the Store that was created.

productSelections

ProductSelectionSettings of the Store that was created.

custom

Custom Fields on the Store that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Store Deleted

Generated after a successful Delete Store request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StoreDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Store Languages Changed

Generated after a successful Set Languages update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StoreLanguagesChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

addedLanguages
Array of Locale

Locales added to the Store after the Set Languages update action.

removedLanguages
Array of Locale

Locales removed from the Store during the Set Languages update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Store Countries Changed

Generated after a successful Add Country, Remove Country, or Set Countries update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StoreCountriesChanged"

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.

addedCountries
Array of StoreCountry

Countries added to the Store.

removedCountries
Array of StoreCountry

Countries removed from the Store.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Store Name Set

Generated after a successful Set Name update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StoreNameSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name

Name of the Store set during the Set Name update action.

nameAllLocales
Array of LocalizedString

Names set for the Store in different locales.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Store Product Selections Changed

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StoreProductSelectionsChanged"

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.

addedProductSelections

ProductSelectionSettings that were added to the Store.

removedProductSelections

ProductSelectionSettings that were removed from the Store.

updatedProductSelections

ProductSelectionSettings that were updated in the Store.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Store Distribution Channels Changed

Generated after a successful Add Distribution Channel, Remove Distribution Channel, or Set Distribution Channels update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StoreDistributionChannelsChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

addedDistributionChannels
Array of ChannelReference

Product distribution Channels that have been added to the Store.

removedDistributionChannels
Array of ChannelReference

Product distribution Channels that have been removed from the Store.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Store Supply Channels Changed

Generated after a successful Add Supply Channel, Remove Supply Channel, or Set Supply Channels update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StoreSupplyChannelsChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

addedSupplyChannels
Array of ChannelReference

Inventory supply Channels that have been added to the Store.

removedSupplyChannels
Array of ChannelReference

Inventory supply Channels that have been removed from the Store.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Quote Request Messages

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

Quote Request Created

Generated after a successful Create QuoteRequest request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"QuoteRequestCreated"

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.

quoteRequest

Quote Request that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Quote Request State Changed

Generated after a successful Change Quote Request State update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"QuoteRequestStateChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

quoteRequestState

State of the Quote Request after the Change Quote Request State update action.

oldQuoteRequestState

State of the Quote Request before the Change Quote Request State update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Quote Request State Transition

Generated after a successful Transition State update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"QuoteRequestStateTransition"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

state

State of the Quote after the Transition State update action.

oldState

State of the Quote before the Transition State update action.

force
Boolean

Whether State transition validations were turned off during the Transition State update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Quote Request Customer Changed

Generated after a successful Change Customer update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"QuoteRequestCustomerChanged"

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

The Buyer who now owns the Quote Request.

previousCustomer

The previous Buyer.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Quote Request Deleted

Generated after a successful Delete QuoteRequest request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"QuoteRequestDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Staged Quote Messages

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

Staged Quote Created

Generated after a successful Create StagedQuote request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StagedQuoteCreated"

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.

stagedQuote

Staged Quote that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Staged Quote State Changed

Generated after a successful Change Staged Quote State update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StagedQuoteStateChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

stagedQuoteState

State of the Staged Quote after the Change Staged Quote State update action.

oldStagedQuoteState

State of the Staged Quote before the Change Staged Quote State update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Staged Quote State Transition

Generated after a successful Transition State update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StagedQuoteStateTransition"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

state

State of the Quote after the Transition State update action.

oldState

State of the Quote before the Transition State update action.

force
Boolean

Whether State transition validations were turned off during the Transition State update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Staged Quote ValidTo Set

Generated after a successful Set Valid To update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StagedQuoteValidToSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

validTo

Expiration date for the Staged Quote after the Set Valid To update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Staged Quote Seller Comment Set

Generated after a successful Set Seller Comment update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StagedQuoteSellerCommentSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

sellerComment
String

sellerComment on the StagedQuote after a successful Set Seller Comment update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Staged Quote Deleted

Generated after a successful Delete StagedQuote request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StagedQuoteDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Quote Messages

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

Quote Created

Generated after a successful Create Quote request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"QuoteCreated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

quote

Quote that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Quote Renegotiation Requested

Generated after a successful Request Quote Renegotiation update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"QuoteRenegotiationRequested"

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.

buyerComment
String

Message from the Buyer regarding the Quote renegotiation request.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Quote State Changed

Generated after a successful Change Quote State update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"QuoteStateChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

quoteState

State of the Quote after the Change Quote State update action.

oldQuoteState

State of the Quote before the Change Quote State update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Quote State Transition

Generated after a successful Transition State update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"QuoteStateTransition"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

state

State of the Quote after the Transition State update action.

oldState

State of the Quote before the Transition State update action.

force
Boolean

Whether State transition validations were turned off during the Transition State update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Quote Customer Changed

Generated after a successful Change Customer update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"QuoteCustomerChanged"

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

The Buyer who now owns the Quote.

previousCustomer

The previous Buyer.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Quote Deleted

Generated after a successful Delete Quote request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"QuoteDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price Messages

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

Standalone Price Created

Generated after a successful Create StandalonePrice request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceCreated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

standalonePrice

Standalone Price that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price Deleted

Generated after a successful Delete StandalonePrice request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

sku
String

SKU of the ProductVariant to which the deleted Standalone Price was associated.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price Value Changed

Generated after a successful Change Value update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceValueChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

value

The new value of the updated StandalonePrice.

staged
Boolean

Whether the new value was applied to the current or the staged representation of the StandalonePrice. Staged changes are stored on the StagedStandalonePrice.

Default: false
oldValue

The old value of the updated StandalonePrice. Present on Messages created after 3 February 2023. Optional for backwards compatibility.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price 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
Int

Version of a resource. In case of Messages, this is always 1.

key
String

key value of the StandalonePrice after the Set Key update action.

MinLength: 2MaxLength: 256Pattern: ^[A-Za-z0-9_-]+$
sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceKeySet"

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 StandalonePrice before the Set Key update action.

MinLength: 2MaxLength: 256Pattern: ^[A-Za-z0-9_-]+$
createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price Discount Set

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceDiscountSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

discounted

The new discounted value of the updated StandalonePrice.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price External Discount Set

Generated after a successful Set Discounted Price update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceExternalDiscountSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

discounted

The discounted value of the StandalonePrice after the Set Discounted Price update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price Staged Changes Applied

Generated after a successful Apply Staged Changes update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceStagedChangesApplied"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

stagedChanges

Applied changes of the StandalonePrice after the Apply Staged Changes update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price Staged Changes Removed

Generated after a successful Remove Staged Changes update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceStagedChangesRemoved"

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.

stagedChanges

Removed changes of the StandalonePrice after the Remove Staged Changes update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price Active Changed

Generated after a successful Change Active update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceActiveChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

active
Boolean

Value of the active field of the StandalonePrice after the Change Active update action.

oldActive
Boolean

Value of the active field of the StandalonePrice before the Change Active update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price Valid From Set

Generated after a successful Set Valid From update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceValidFromSet"

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.

validFrom

Value of StandalonePrice validFrom after the Set Valid From update action.

previousValidFrom

Value of StandalonePrice validFrom before the Set Valid From update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price Valid Until Set

Generated after a successful Set Valid Until update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceValidUntilSet"

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.

validUntil

Value of StandalonePrice validUntil after the Set Valid Until update action.

previousValidUntil

Value of StandalonePrice validUntil before the Set Valid Until update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price Valid From and Until Set

Generated after a successful Set Valid From and Until update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceValidFromAndUntilSet"

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.

validFrom

Value of StandalonePrice validFrom after the Set Valid From and Until update action.

previousValidFrom

Value of StandalonePrice validFrom before the Set Valid From and Until update action.

validUntil

Value of StandalonePrice validUntil after the Set Valid From and Until update action.

previousValidUntil

Value of StandalonePrice validUntil before the Set Valid From and Until update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price Tier Added

Generated after a successful Add Price Tier update action

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceTierAdded"

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.

tier

The Price Tier that has been added to the array field tiers for the StandalonePrice.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price Tier Removed

Generated after a successful Remove Price Tier update action

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceTierRemoved"

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.

removedTier

The Price Tier that has been removed from the array field tiers for the StandalonePrice.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Standalone Price Tiers Set

Generated after a successful Set Price Tier update action

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"StandalonePriceTiersSet"

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.

tiers
Array of PriceTier

The updated content of the field tiers of the affected StandalonePrice.

previousTiers
Array of PriceTier

The previous content of the field tiers of the affected StandalonePrice.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Cart Discount Messages

These Messages represent a change or an action performed on a Cart Discount.

Cart Discount Created

Generated after a successful Create CartDiscount request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CartDiscountCreated"

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.

cartDiscount

The Cart Discount that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Cart Discount Deleted

Generated after a successful Delete CartDiscount request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CartDiscountDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Cart Discount Store Added

Generated after a successful Add Store update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CartDiscountStoreAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

The Store that was added to the Cart Discount.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Cart Discount Store Removed

Generated after a successful Remove Store update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CartDiscountStoreRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

The Store that was removed from the Cart Discount.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Cart Discount Stores Set

Generated after a successful Set Stores update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"CartDiscountStoresSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

stores
Array of StoreKeyReference

Stores of the Cart Discount after the Set Stores update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Discount Code Messages

These Messages represent a change or an action performed on a Discount Code.

Discount Code Created

Generated after a successful Create DiscountCode request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"DiscountCodeCreated"

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

The Discount Code that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Discount Code Deleted

Generated after a successful Delete DiscountCode request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"DiscountCodeDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Discount Code 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
Int

Version of a resource. In case of Messages, this is always 1.

key
String

key value of the Discount Code after the Set Key update action.

MinLength: 2MaxLength: 256Pattern: ^[A-Za-z0-9_-]+$
sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"DiscountCodeKeySet"

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 Discount Code before the Set Key update action.

MinLength: 2MaxLength: 256Pattern: ^[A-Za-z0-9_-]+$
createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Messages

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

Business Unit Created

Generated after a successful Create BusinessUnit request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitCreated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

businessUnit

The Business Unit that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Address Added

Generated after a successful Add Address update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitAddressAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

address

The address that was added to the Business Unit.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Address Changed

Generated after a successful Change Address update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitAddressChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

address

Updated address of the Business Unit.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Address Removed

Generated after a successful Remove Address update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitAddressRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

address

The address that was removed from the Business Unit.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Associate Added

Generated after a successful Add Associate update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitAssociateAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

associate

The Associate that was added to the Business Unit.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Associates Set

Generated after a successful Set Associates update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitAssociatesSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

associates
Array of Associate

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

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Associate Changed

Generated after a successful Change Associate update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitAssociateChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

associate

The Associate that was updated.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Associate Mode Changed

Generated after a successful Change Associate Mode update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitAssociateModeChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

associateMode

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

oldAssociateMode

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

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Associate Removed

Generated after a successful Remove Associate update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitAssociateRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

associate

The Associate that was removed from the Business Unit.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Parent Changed

Generated after a successful Change Parent Unit update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitParentChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

oldParentUnit

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

newParentUnit

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

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Store Added

Generated after a successful Add Store update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitStoreAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

The Store that was added to the Business Unit.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Stores Set

Generated after a successful Set Stores update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitStoresSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

stores
Array of StoreKeyReference

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

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Store Mode Changed

Generated after a successful Set Store Mode update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitStoreModeChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

stores
Array of StoreKeyReference

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

storeMode

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

oldStores
Array of StoreKeyReference

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

oldStoreMode

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

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Store Removed

Generated after a successful Remove Store update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitStoreRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

The Store that was removed from the Business Unit.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Status Changed

Generated after a successful Change Status update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitStatusChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

active

Updated status of the Business Unit.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Billing Address Added

Generated after a successful Add Billing Address Identifier update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitBillingAddressAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

address

The address that was added to the Business Unit as billing address.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Billing Address Removed

Generated after a successful Remove Billing Address Identifier update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitBillingAddressRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

address

The address that was removed from the billing addresses of the Business Unit.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Default Billing Address Set

Generated after a successful Set Default Billing Address update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitDefaultBillingAddressSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

address

The address that was set as the default billing address.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Shipping Address Added

Generated after a successful Add Shipping Address Identifier update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitShippingAddressAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

address

The address that was added to the Business Unit as shipping address.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Shipping Address Removed

Generated after a successful Remove Shipping Address Identifier update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitShippingAddressRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

address

The address that was removed from shipping addresses of the Business Unit.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Default Shipping Address Set

Generated after a successful Set Default Shipping Address update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitDefaultShippingAddressSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

address

The address that was set as the default shipping address.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Contact Email Set

Generated after a successful Set Contact Email update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitContactEmailSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

contactEmail
String

The contact email that was updated on the Business Unit.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Name Changed

Generated after a successful Change Name update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitNameChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Updated name of the Business Unit.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Deleted

Generated after a successful Delete BusinessUnit request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Custom Field Added

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitCustomFieldAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Name of the Custom Field that was added.

value

The added CustomFieldValue based on the FieldType.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Custom Field Changed

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitCustomFieldChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Name of the Custom Field that changed.

value

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

oldValue

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

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Custom Field Removed

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitCustomFieldRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Name of the Custom Field that was removed.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Custom Type Set

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitCustomTypeSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

customFields

The Custom Fields that were set.

oldTypeId
String

id of the previous Custom Type. Absent if there was no previous Custom Type present.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Custom Type Removed

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitCustomTypeRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

oldTypeId
String

id of the Custom Type that was removed. Absent if there was no previous Custom Type present.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Address Custom Field Added

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitAddressCustomFieldAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Name of the Custom Field that was added.

value

The added CustomFieldValue based on the FieldType.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Address Custom Field Changed

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitAddressCustomFieldChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Name of the Custom Field that changed.

value

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

oldValue

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

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Address Custom Field Removed

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitAddressCustomFieldRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Name of the Custom Field that was removed.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Address Custom Type Set

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitAddressCustomTypeSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

customFields

The Custom Fields that were set.

oldTypeId
String

id of the previous Custom Type. Absent if there was no previous Custom Type present.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Business Unit Address Custom Type Removed

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

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"BusinessUnitAddressCustomTypeRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

oldTypeId
String

id of the Custom Type that was removed. Absent if there was no previous Custom Type present.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Associate Role Messages

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

Associate Role Created

Generated after a successful Create AssociateRole request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"AssociateRoleCreated"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

associateRole

The AssociateRole that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Associate Role BuyerAssignable Changed

Generated after a successful Change BuyerAssignable update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"AssociateRoleBuyerAssignableChanged"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

buyerAssignable
Boolean

The new value of the buyerAssignable field of the AssociateRole.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Associate Role Permission Added

Generated after a successful Add Permissions update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"AssociateRolePermissionAdded"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

permission

The Permission that was added to the AssociateRole.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Associate Role Permission Removed

Generated after a successful Remove Permissions update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"AssociateRolePermissionRemoved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

permission

The Permission that was removed from the AssociateRole.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Associate Role Permissions Set

Generated after a successful Set Permissions update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"AssociateRolePermissionsSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

permissions
Array of Permission

Permission assigned to the AssociateRole.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Associate Role Name Set

Generated after a successful Set Name update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"AssociateRoleNameSet"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

name
String

Updated name of the AssociateRole.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Associate Role Deleted

Generated after a successful Delete AssociateRole request.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"AssociateRoleDeleted"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Approval Rule Messages

These Messages represent a change or an action performed on an Approval Rule.

Approval Rule Created

Generated after an Approval Rule is created.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ApprovalRuleCreated"

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.

approvalRule

The Approval Rule that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Approval Rule Status Set

Generated after a successful Set Status update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ApprovalRuleStatusSet"

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.

status

Status of the ApprovalRule after the Set Status update action.

oldStatus

Status of the ApprovalRule before the Set Status update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Approval Rule Name Set

Generated after a successful Set Name update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ApprovalRuleNameSet"

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 ApprovalRule after the Set Name update action.

oldName
String

Name of the ApprovalRule before the Set Name update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Approval Rule Description Set

Generated after a successful Set Description update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ApprovalRuleDescriptionSet"

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.

description
String

Description of the ApprovalRule after the Set Description update action.

oldDescription
String

Description of the ApprovalRule before the Set Description update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Approval Rule 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
Int

Version of a resource. In case of Messages, this is always 1.

key
String

Description of the ApprovalRule after the Set Key update action.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ApprovalRuleKeySet"

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

Description of the ApprovalRule before the Set Key update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Approval Rule Predicate Set

Generated after a successful Set Predicate update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ApprovalRulePredicateSet"

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.

predicate
String

Name of the ApprovalRule after the Set Predicate update action.

oldPredicate
String

Name of the ApprovalRule before the Set Predicate update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Approval Rule Approvers Set

Generated after a successful Set Approvers update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ApprovalRuleApproversSet"

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.

approvers

Approver hierarchy of the ApprovalRule after the Set Approvers update action.

oldApprovers

Approver hierarchy of the ApprovalRule before the Set Approvers update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Approval Rule Requesters Set

Generated after a successful Set Requester update action.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ApprovalRuleRequestersSet"

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.

requesters
Array of RuleRequester

RuleRequester of the ApprovalRule after the Set Requester update action.

oldRequesters
Array of RuleRequester

RuleRequester of the ApprovalRule after the Set Requester update action.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Approval Flow Messages

These Messages represent a change or an action performed on an Approval Flow.

Approval Flow Created

Generated after an Approval Flow is created.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ApprovalFlowCreated"

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.

approvalFlow

The Approval Flow that was created.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Approval Flow Approved

Generated after an approval in the Approval Flow.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ApprovalFlowApproved"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

associate

Reference to the Customer who approved the Approval Flow.

order

Reference to the Order that received the approval.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Approval Flow Rejected

Generated after an Approval Flow is rejected.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ApprovalFlowRejected"

Message Type of the Message.

resourceUserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

associate

Reference to the Customer who rejected the Approval Flow.

rejectionReason
String

Description of the reason why the Approval Flow was rejected.

order

Reference to the Order that received the rejection.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Approval Flow Completed

Generated after an Approval Flow is completed and reaches a final status.

id
String

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

version
Int

Version of a resource. In case of Messages, this is always 1.

sequenceNumber
Int

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

resource

Reference to the resource on which the change or action was performed.

resourceVersion
Int

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

type
String
"ApprovalFlowCompleted"

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.

status

Final status of the Approval Flow.

order

Reference to the Order related to the completed Approval Flow.

createdAt

Date and time (UTC) the Message was generated.

createdByBETA

Present on resources created after 1 February 2019 except for events not tracked.

lastModifiedAt

Value of createdAt.

lastModifiedByBETA

Value of createdBy.

Enable querying Messages via the API

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

Get Message

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

Deprecated scope: view_orders:{projectKey}

OAuth 2.0 Scopes:
view_messages:{projectKey}
Path parameters:
region
String

Region in which the Project is hosted.

projectKey
String

key of the Project.

id
String

id of the Message.

Query parameters:
expand
The parameter can be passed multiple times.
Response:
200Messageasapplication/json
Request Example:cURL
curl --get https://api.{region}.commercetools.com/{projectKey}/messages/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'
200 Response Example: Messagejson
{
"id": "2723ca8f-283c-4add-90bc-0978d195ed3c",
"version": 1,
"sequenceNumber": 4,
"resource": {
"typeId": "payment",
"id": "e57c8183-eb2b-4bf3-acf1-f8a7846689f8"
},
"resourceVersion": 5,
"resourceUserProvidedIdentifiers": {
"key": "e57-payment-key"
},
"type": "PaymentStatusInterfaceCodeSet",
"paymentId": "e57c8183-eb2b-4bf3-acf1-f8a7846689f8",
"interfaceCode": "InterfaceCodeString",
"createdAt": "1970-01-01T00:00:00.001Z",
"lastModifiedAt": "1970-01-01T00:00:00.001Z",
"lastModifiedBy": {
"clientId": "ey8aTsYwE0_kxFvT1rJeglpC",
"isPlatformClient": false
},
"createdBy": {
"clientId": "ey8aTsYwE0_kxFvT1rJeglpC",
"isPlatformClient": false
}
}

Query Messages

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

Deprecated scope: view_orders:{projectKey}

OAuth 2.0 Scopes:
view_messages:{projectKey}
Path parameters:
region
String

Region in which the Project is hosted.

projectKey
String

key of the Project.

Query parameters:
where
The parameter can be passed multiple times.
/^var[.][a-zA-Z0-9]+$/
Any string parameter matching this regular expression

Predicate parameter values.

The parameter can be passed multiple times.
sort
The parameter can be passed multiple times.
expand
The parameter can be passed multiple times.
limit
Int
offset
Int

Number of elements skipped.

withTotal
Boolean

Controls the calculation of the total number of query results. Set to false to improve query performance when the total is not needed.

Response:
200MessagePagedQueryResponseasapplication/json
Request Example:cURL
curl --get https://api.{region}.commercetools.com/{projectKey}/messages -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'
200 Response Example: MessagePagedQueryResponsejson
{
"limit": 20,
"offset": 0,
"count": 1,
"total": 1,
"results": [
{
"id": "2723ca8f-283c-4add-90bc-0978d195ed3c",
"version": 1,
"sequenceNumber": 4,
"resource": {
"typeId": "payment",
"id": "e57c8183-eb2b-4bf3-acf1-f8a7846689f8"
},
"resourceVersion": 5,
"resourceUserProvidedIdentifiers": {
"key": "e57-payment-key"
},
"type": "PaymentStatusInterfaceCodeSet",
"paymentId": "e57c8183-eb2b-4bf3-acf1-f8a7846689f8",
"interfaceCode": "InterfaceCodeString",
"createdAt": "1970-01-01T00:00:00.001Z",
"lastModifiedAt": "1970-01-01T00:00:00.001Z",
"lastModifiedBy": {
"clientId": "ey8aTsYwE0_kxFvT1rJeglpC",
"isPlatformClient": false
},
"createdBy": {
"clientId": "ey8aTsYwE0_kxFvT1rJeglpC",
"isPlatformClient": false
}
}
]
}

Check if Message exists

Check if Message exists by ID

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

Checks if a Message exists for a given id. Returns a 200 OK status if the Message exists or a 404 Not Found otherwise.

OAuth 2.0 Scopes:
view_messages:{projectKey}
Path parameters:
region
String

Region in which the Project is hosted.

projectKey
String

key of the Project.

id
String

id of the Message.

Response:
200
Request Example:cURL
curl --head https://api.{region}.commercetools.com/{projectKey}/messages/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

Check if Message exists by Query Predicate

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

Checks if a Message exists for a given Query Predicate. Returns a 200 OK status if any Messages match the Query Predicate or a 404 Not Found otherwise.

OAuth 2.0 Scopes:
view_messages:{projectKey}
Path parameters:
region
String

Region in which the Project is hosted.

projectKey
String

key of the Project.

Query parameters:
where

Query Predicates on Messages are limited to Text, Enum, Boolean, Number, Date, Time, and DateTime attribute types.

The parameter can be passed multiple times.
Response:
200
Request Example:cURL
curl --head https://api.{region}.commercetools.com/{projectKey}/messages -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'