Messages that represent a change or an action performed on a Cart, Order, Order Edit, or Recurring Order.
Cart Messages
Cart Frozen
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "CartFrozen"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Cart Unfrozen
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "CartUnfrozen"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Messages
globally
Order Created
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Created From Recurring Order
Generated after an Order is successfully created according to the defined schedule of a Recurring Order.
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "OrderCreatedFromRecurringOrder"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
order | Order that was created. |
recurringOrderRef | Reference to the origin Recurring Order. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Imported
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Edit Applied
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Deleted
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Purchase Order Number Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
purchaseOrderNumberString | Purchase order number on the Order after the Set Purchase Order Number update action. |
oldPurchaseOrderNumberString | Purchase order number on the Order before the Set Purchase Order Number update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Customer Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | |
customerGroup | |
oldCustomer | |
oldCustomerGroup | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Customer Email Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
emailString | Email address on the Order after the Set Customer Email update action. |
oldEmailString | Email address on the Order before the Set Customer Email update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Customer Group Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | |
oldCustomerGroup | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Line Item Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | |
addedQuantityInt | Quantity of Line Items that were added to the Order. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Line Item Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
lineItemIdString | Unique identifier of the Line Item. |
lineItemKeyString | User-defined unique identifier of the LineItem. |
removedQuantityInt | Quantity of Line Items that were removed during the Remove LineItem update action. |
newQuantityInt | Line Item quantity after the Remove LineItem update action. |
newStateArray of ItemState | ItemStates after the Remove LineItem update action. |
newTotalPrice | |
newTaxedPrice | |
newPrice | |
newShippingDetail | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Custom Line Item Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Custom Line Item Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
customLineItemIdString | Unique identifier of the Custom Line Item. |
customLineItemKeyString | 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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Discount Code Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Discount Code Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Discount Code State Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
state | DiscountCodeState after the recalculation. |
oldState | DiscountCodeState before the recalculation. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Payment Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Payment State Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Billing Address Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Shipping Address Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Shipping Info Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Shipping Rate Input Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Shipment State Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Delivery Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
shippingKeyString | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Delivery Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | |
shippingKeyString | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Return Info Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Return Info Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
returnInfoArray of ReturnInfo | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order State Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order State Transition
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
forceBoolean | Whether State transition validations were turned off during the Transition State update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Store Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "OrderStoreSet"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
store | Store that was set. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Business Unit Set B2B
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "OrderBusinessUnitSet"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
businessUnit | BusinessUnit on the Order after the Set Business Unit update action on Orders or Set Business Unit update action on Order Edits. |
oldbusinessUnit | BusinessUnit on the Order before the Set Business Unit update action on Orders or Set Business Unit update action on Order Edits. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
on Line Item
Order Line Item Distribution Channel Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
lineItemIdString | Unique identifier of the Line Item. |
lineItemKeyString | User-defined unique identifier of the LineItem. |
distributionChannel | Distribution Channel that was set. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Line Item Discount Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
lineItemIdString | Unique identifier for the Line Item. |
lineItemKeyString | User-defined unique identifier of the LineItem. |
discountedPricePerQuantityArray of DiscountedLineItemPriceForQuantity | Array of DiscountedLineItemPriceForQuantity after the Discount recalculation. |
totalPrice | Total Price of the Line Item after the Discount recalculation. |
taxedPrice | TaxedItemPrice of the Line Item after the Discount recalculation. |
taxedPricePortionsArray 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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Line Item State Transition
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
lineItemIdString | Unique identifier of the Line Item. |
lineItemKeyString | User-defined unique identifier of the LineItem. |
transitionDate | |
quantityInt | Number of Line Items for which the State was transitioned. |
fromState | |
toState | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
on Custom Line Item
Order Custom Line Item Quantity Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
customLineItemIdString | Unique identifier of the Custom Line Item. |
customLineItemKeyString | User-defined unique identifier of the Custom Line Item. |
quantityInt | Custom Line Item quantity after the Change Custom Line Item Quantity update action. |
oldQuantityInt | Custom Line Item quantity before the Change Custom Line Item Quantity update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Custom Line Item Discount Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
customLineItemIdString | Unique identifier for the Custom Line Item. |
customLineItemKeyString | User-defined unique identifier of the Custom Line Item. |
discountedPricePerQuantityArray of DiscountedLineItemPriceForQuantity | Array of DiscountedLineItemPriceForQuantity after the Discount recalculation. |
taxedPrice | TaxedItemPrice of the Custom Line Item after the Discount recalculation. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Custom Line Item State Transition
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
customLineItemIdString | Unique identifier of the Custom Line Item. |
customLineItemKeyString | User-defined unique identifier of the Custom Line Item. |
transitionDate | Date and time (UTC) the transition of the Custom Line Item State was performed. |
quantityInt | 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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
on Delivery
Delivery Address Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
deliveryIdString | Unique identifier of the Delivery. |
address | Address after the Set Delivery Address update action. |
oldAddress | Address before the Set Delivery Address update action. |
shippingKeyString | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Parcel Added To Delivery
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | |
shippingKeyString | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Parcel Removed From Delivery
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
deliveryIdString | Unique identifier of the Delivery. |
parcel | |
shippingKeyString | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Delivery Items Updated
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
deliveryIdString | Unique identifier of the Delivery. |
itemsArray of DeliveryItem | Delivery Items after the Set Delivery Items update action. |
oldItemsArray of DeliveryItem | Delivery Items before the Set Delivery Items update action. |
shippingKeyString | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Delivery Custom Field Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "DeliveryCustomFieldAdded"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
nameString | Name of the Custom Field that was added. |
value | The added CustomFieldValue based on the FieldType. |
deliveryIdString | Unique identifier of the Delivery. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Delivery Custom Field Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "DeliveryCustomFieldChanged"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
nameString | Name of the Custom Field that changed. |
value | |
previousValue | CustomFieldValue based on the FieldType before the Set CustomField update action.
When there has not been a Custom Field with the name on the Delivery before, a Delivery Custom Field Added Message is generated instead. |
deliveryIdString | Unique identifier of the Delivery. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Delivery Custom Field Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "DeliveryCustomFieldRemoved"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
nameString | Name of the Custom Field that was removed. |
deliveryIdString | Unique identifier of the Delivery. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Delivery Custom Type Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "DeliveryCustomTypeSet"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
customFields | The Custom Fields that have been set. |
previousTypeIdString | id of the previous Custom Type. Absent if there was no previous Custom Type present. |
deliveryIdString | Unique identifier of the Delivery. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Delivery Custom Type Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "DeliveryCustomTypeRemoved"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
previousTypeIdString | id of the Custom Type that was removed. Absent if there was no previous Custom Type present. |
deliveryIdString | Unique identifier of the Delivery. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
on Parcel
Parcel Measurements Updated
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
deliveryIdString | Unique identifier of the Delivery. |
parcelIdString | Unique identifier of the Parcel. |
measurements | The Parcel Measurements that were set on the Parcel. |
shippingKeyString | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Parcel Tracking Data Updated
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
deliveryIdString | Unique identifier of the Delivery. |
parcelIdString | Unique identifier of the Parcel. |
trackingData | The Tracking Data that was added to the Parcel. |
shippingKeyString | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Parcel Items Updated
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
parcelIdString | Unique identifier of the Parcel. |
deliveryIdString | Unique identifier of the Delivery. |
itemsArray of DeliveryItem | Delivery Items after the Set Parcel Items update action. |
oldItemsArray of DeliveryItem | Delivery Items before the Set Parcel Items update action. |
shippingKeyString | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
on Return Item
Order Return Shipment State Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
returnItemIdString | 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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
on Custom Fields and Types
Order Custom Field Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
nameString | 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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Custom Field Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
nameString | Name of the Custom Field that changed. |
value | |
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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Custom Field Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
nameString | Name of the Custom Field that was removed. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Custom Type Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
previousTypeIdString | 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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Order Custom Type Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
previousTypeIdString | 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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Recurring Order Messages
Recurring Order Created
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderCreated"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
order | RecurringOrder that was created. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Recurring Order Deleted
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderDeleted"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
recurringOrder | RecurringOrder that was deleted. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Recurring Order State Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderStateChanged"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
state | RecurringOrderState after the Set RecurringOrderState update action. |
oldState | RecurringOrderState before the Set RecurringOrderState update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Recurring Order Failed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderFailed"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
cartIdString | ID of the Cart used in the failed Order creation attempt. |
failedAt | Date and time (UTC) when the Order creation attempt failed. |
failureReasonString | Description of why the Order creation failed, such as insufficient stock. |
orderScheduledAt | Date and time (UTC) the Order was scheduled to be created. |
errorsArray of RecurringOrderFailureError | Errors due to which the Order creation failed. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Recurring Order State Transition
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderStateTransition"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
state | RecurringOrderState after the Transition State update action. |
oldState | RecurringOrderState before the Transition State update action. |
forceBoolean | Whether State transition validations were turned off during the Transition State update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Recurring Order Starts At Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderStartsAtSet"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
startsAt | Start date and time of the Recurring Order after the Set Starts At update action. |
oldStartsAt | Start date and time of the Recurring Order before the Set Starts At update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Recurring Order Expires At Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderExpiresAtSet"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
newExpiresAt | Expiration date and time of the Recurring Order after the Set Expires At update action. |
oldExpiresAt | Expiration date and time of the Recurring Order before the Set Expires At update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Recurring Order Schedule Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderScheduleSet"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
recurrencePolicySchedule | Schedule of the Recurring Order after the Set Schedule update action. |
oldRecurrencePolicySchedule | Schedule of the Recurring Order before the Set Schedule update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Recurring Order Key Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
keyString | |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderKeySet"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
oldKeyString | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
on Custom Fields and Types
Recurring Order Custom Type Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderCustomTypeSet"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
customFields | The Custom Fields that have been set. |
previousTypeIdString | 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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Recurring Order Custom Type Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderCustomTypeRemoved"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
previousTypeIdString | 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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Recurring Order Custom Field Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderCustomFieldAdded"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
nameString | 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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Recurring Order Custom Field Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderCustomFieldChanged"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
nameString | Name of the Custom Field that changed. |
value | |
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 | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Recurring Order Custom Field Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "RecurringOrderCustomFieldRemoved"Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers. |
nameString | Name of the Custom Field that was removed. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |