Messages

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

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

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

Representations

Message

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

Number of results requested.

count
Int

Actual number of results returned.

total
Int

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

offset
Int

Number of elements skipped.

results
Array of Message

Messages matching the query.

UserProvidedIdentifiers

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

key
String

User-provided unique identifier of the resource.

externalId
String

User-provided unique identifier of the resource.

orderNumber
String

User-provided unique identifier of an Order.

customerNumber
String

User-provided unique identifier of a Customer.

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.

Line Item State Transition

Generated after a successful Transition Line Item State update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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.

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.

Custom Line Item State Transition

Generated after a successful Transition Custom Line Item State update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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.

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.

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 ParcelAddedToDelivery Message containing information about the Parcels.

shippingKey
String

User-defined unique identifier of the Shipping Method in a Cart with Multi 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 Multi 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 Multi 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 Multi 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 Multi 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 TrackingData update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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 Multi 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 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 Multi 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 Multi 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 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 Multi 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 Return Info update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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 Return Info update action on Orders and Order Edits.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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 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 State Changed

Generated after a successful Change Order State update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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 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 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 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 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 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 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
PaymentReference

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 Payment State update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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 Shipment State Changed

Generated after a successful Change Shipment State update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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.

Order Return Shipment State Changed

Generated after a successful Set Return Shipment State update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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.

Order Edit Applied

Generated after a successfully applying an OrderEdit.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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 Custom Line Item Added

Generated after a successful Add Custom Line Item update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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 Custom Line Item update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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.

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 Custom Line Item Quantity Changed

Generated after a successful Change Custom Line Item Quantity update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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.

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 Line Item Added

Generated after a successful Add Line Item update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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 Line Item update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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.

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 Line Item Distribution Channel Set

Generated after a successful Set Line Item Distribution Channel update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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.

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 Shipping Info Set

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

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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

ShippingInfo after the Set Shipping Method or Set Custom Shipping Method update action.

oldShippingInfo

ShippingInfo before the Set Shipping Method or Set Custom Shipping Method update action.

createdAt

Date and time (UTC) the Message was generated.

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 Discount Code Added

Generated after a successful Add Discount Code update action.

id
String

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

version
Int

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

sequenceNumber
Int

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

resource

Reference to the resource 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 Discount Code update action.

id
String

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

version
Int

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