Messages that represent a change or an action performed on an Order, Order Edit, or Payment.
Order Messages
globally
Order Created
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Imported
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderImported" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
order | Order that was imported. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Edit Applied
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderEditApplied" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
edit | OrderEdit that was applied. |
result | Information about a successfully applied OrderEdit. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Deleted
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
order | Order that has been deleted. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Purchase Order Number Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderPurchaseOrderNumberSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
purchaseOrderNumber String | Purchase order number on the Order after the Set Purchase Order Number update action. |
oldPurchaseOrderNumber String | Purchase order number on the Order before the Set Purchase Order Number update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Customer Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomerSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customer | |
customerGroup | |
oldCustomer | |
oldCustomerGroup | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Customer Email Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomerEmailSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
email String | Email address on the Order after the Set Customer Email update action. |
oldEmail String | Email address on the Order before the Set Customer Email update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Customer Group Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomerGroupSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customerGroup | |
oldCustomerGroup | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Line Item Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderLineItemAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
lineItem | |
addedQuantity Int | Quantity of Line Items that were added to the Order. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Line Item Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderLineItemRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
lineItemId String | Unique identifier of the Line Item. |
lineItemKey String | User-defined unique identifier of the LineItem. |
removedQuantity Int | Quantity of Line Items that were removed during the Remove LineItem update action. |
newQuantity Int | Line Item quantity after the Remove LineItem update action. |
newState Array of ItemState | ItemStates after the Remove LineItem update action. |
newTotalPrice | |
newTaxedPrice | |
newPrice | |
newShippingDetail | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Custom Line Item Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomLineItemAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customLineItem | Custom Line Item that was added to the Order. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Custom Line Item Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomLineItemRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customLineItemId String | Unique identifier of the Custom Line Item. |
customLineItemKey String | User-defined unique identifier of the Custom Line Item. |
customLineItem | Custom Line Item that was removed from the Order. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Discount Code Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderDiscountCodeAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
discountCode | DiscountCode that was added. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Discount Code Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderDiscountCodeRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
discountCode | DiscountCode that was removed. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Discount Code State Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderDiscountCodeStateSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
discountCode | DiscountCode that changed due to the recalculation. |
state | DiscountCodeState after the recalculation. |
oldState | DiscountCodeState before the recalculation. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Payment Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderPaymentAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
payment | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Payment State Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Billing Address Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderBillingAddressSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
address | Billing address on the Order after the Set Billing Address update action. |
oldAddress | Billing address on the Order before the Set Billing Address update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Shipping Address Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderShippingAddressSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
address | Shipping address on the Order after the Set Shipping Address update action. |
oldAddress | Shipping address on the Order before the Set Shipping Address update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Shipping Info Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderShippingInfoSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
shippingInfo | |
oldShippingInfo | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Shipping Rate Input Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderShippingRateInputSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
shippingRateInput | ShippingRateInput after the Set ShippingRateInput update action. |
oldShippingRateInput | ShippingRateInput before the Set ShippingRateInput update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Shipment State Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Delivery Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DeliveryAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
delivery | Delivery that was added to the Order. The Delivery in the Message body does not contain Parcels if those were part of the initial Add Delivery update action. In that case, the update action produces an additional Parcel Added To Delivery Message containing information about the Parcels. |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Delivery Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DeliveryRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
delivery | |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Return Info Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ReturnInfoAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
returnInfo | The ReturnInfo that was added to the Order. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Return Info Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ReturnInfoSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
returnInfo Array of ReturnInfo | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order State Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order State Transition
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderStateTransition" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
state | OrderState after the Transition State update action. |
oldState | OrderState before the Transition State update action. |
force Boolean | Whether State transition validations were turned off during the Transition State update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Store Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderStoreSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
store | Store that was set. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Business Unit Set B2B
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
on Line Item
Order Line Item Distribution Channel Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderLineItemDistributionChannelSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
lineItemId String | Unique identifier of the Line Item. |
lineItemKey String | User-defined unique identifier of the LineItem. |
distributionChannel | Distribution Channel that was set. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Line Item Discount Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderLineItemDiscountSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
lineItemId String | Unique identifier for the Line Item. |
lineItemKey String | User-defined unique identifier of the LineItem. |
discountedPricePerQuantity Array of DiscountedLineItemPriceForQuantity | Array of DiscountedLineItemPriceForQuantity after the Discount recalculation. |
totalPrice | Total Price of the Line Item after the Discount recalculation. |
taxedPrice | TaxedItemPrice of the Line Item after the Discount recalculation. |
taxedPricePortions Array of MethodTaxedPrice | Total taxed prices based on the quantity of Line Item assigned to each Shipping Method. Only applicable for Carts with Multiple ShippingMode.
Automatically set after perMethodTaxRate is set. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Line Item State Transition
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "LineItemStateTransition" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
lineItemId String | Unique identifier of the Line Item. |
lineItemKey String | User-defined unique identifier of the LineItem. |
transitionDate DateTime | |
quantity Int | Number of Line Items for which the State was transitioned. |
fromState | |
toState | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
on Custom Line Item
Order Custom Line Item Quantity Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomLineItemQuantityChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customLineItemId String | Unique identifier of the Custom Line Item. |
customLineItemKey String | User-defined unique identifier of the Custom Line Item. |
quantity Int | Custom Line Item quantity after the Change Custom Line Item Quantity update action. |
oldQuantity Int | Custom Line Item quantity before the Change Custom Line Item Quantity update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Custom Line Item Discount Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomLineItemDiscountSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customLineItemId String | Unique identifier for the Custom Line Item. |
customLineItemKey String | User-defined unique identifier of the Custom Line Item. |
discountedPricePerQuantity Array of DiscountedLineItemPriceForQuantity | Array of DiscountedLineItemPriceForQuantity after the Discount recalculation. |
taxedPrice | TaxedItemPrice of the Custom Line Item after the Discount recalculation. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Custom Line Item State Transition
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CustomLineItemStateTransition" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customLineItemId String | Unique identifier of the Custom Line Item. |
customLineItemKey String | User-defined unique identifier of the Custom Line Item. |
transitionDate DateTime | Date and time (UTC) the transition of the Custom Line Item State was performed. |
quantity Int | Number of Custom Line Items for which the State was transitioned. |
fromState | State the Custom Line Item was transitioned from. |
toState | State the Custom Line Item was transitioned to. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
on Delivery
Delivery Address Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DeliveryAddressSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
deliveryId String | Unique identifier of the Delivery. |
address | Address after the Set Delivery Address update action. |
oldAddress | Address before the Set Delivery Address update action. |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Parcel Added To Delivery
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ParcelAddedToDelivery" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
delivery | Unique identifier of the Delivery. |
parcel | |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Parcel Removed From Delivery
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ParcelRemovedFromDelivery" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
deliveryId String | Unique identifier of the Delivery. |
parcel | |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Delivery Items Updated
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DeliveryItemsUpdated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
deliveryId String | Unique identifier of the Delivery. |
items Array of DeliveryItem | Delivery Items after the Set Delivery Items update action. |
oldItems Array of DeliveryItem | Delivery Items before the Set Delivery Items update action. |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Delivery Custom Field Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DeliveryCustomFieldAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was added. |
value | The added CustomFieldValue based on the FieldType. |
deliveryId String | Unique identifier of the Delivery. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Delivery Custom Field Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DeliveryCustomFieldChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that changed. |
value | |
previousValue | CustomFieldValue based on the FieldType before the Set CustomField update action.
When there has not been a Custom Field with the name on the Delivery before, a Delivery Custom Field Added Message is generated instead. |
deliveryId String | Unique identifier of the Delivery. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Delivery Custom Field Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DeliveryCustomFieldRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was removed. |
deliveryId String | Unique identifier of the Delivery. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Delivery Custom Type Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DeliveryCustomTypeSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customFields | The Custom Fields that have been set. |
previousTypeId String | id of the previous Custom Type. Absent if there was no previous Custom Type present. |
deliveryId String | Unique identifier of the Delivery. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Delivery Custom Type Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DeliveryCustomTypeRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
previousTypeId String | id of the Custom Type that was removed. Absent if there was no previous Custom Type present. |
deliveryId String | Unique identifier of the Delivery. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
on Parcel
Parcel Measurements Updated
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ParcelMeasurementsUpdated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
deliveryId String | Unique identifier of the Delivery. |
parcelId String | Unique identifier of the Parcel. |
measurements | The Parcel Measurements that were set on the Parcel. |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Parcel Tracking Data Updated
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ParcelTrackingDataUpdated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
deliveryId String | Unique identifier of the Delivery. |
parcelId String | Unique identifier of the Parcel. |
trackingData | The Tracking Data that was added to the Parcel. |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Parcel Items Updated
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "ParcelItemsUpdated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
parcelId String | Unique identifier of the Parcel. |
deliveryId String | Unique identifier of the Delivery. |
items Array of DeliveryItem | Delivery Items after the Set Parcel Items update action. |
oldItems Array of DeliveryItem | Delivery Items before the Set Parcel Items update action. |
shippingKey String | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
on Return Item
Order Return Shipment State Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderReturnShipmentStateChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
returnItemId String | Unique identifier of the ReturnItem. |
returnShipmentState | State of the ReturnItem after the Set Return Shipment State update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
on Custom Fields and Types
Order Custom Field Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomFieldAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was added. |
value | The added CustomFieldValue based on the FieldType. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Custom Field Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomFieldChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that changed. |
value | |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Custom Field Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomFieldRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was removed. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Custom Type Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomTypeSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customFields | The Custom Fields that have been set. |
previousTypeId String | id of the previous Custom Type. Absent if there was no previous Custom Type present. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Order Custom Type Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "OrderCustomTypeRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
previousTypeId String | id of the Custom Type that was removed. Absent if there was no previous Custom Type present. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Messages BETA
Payment Method Created
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
paymentMethod | PaymentMethod that was created. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Deleted
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
paymentMethod | The PaymentMethod that was deleted. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Default Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodDefaultSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
default Boolean | Default Payment Method after the Set Default update action. |
oldDefault Boolean | Default Payment Method before the Set Default update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Interface Account Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodInterfaceAccountSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
interfaceAccount String | Interface account of the Payment Method after the Set InterfaceAccount update action. |
oldInterfaceAccount String | Interface account of the Payment Method before the Set InterfaceAccount update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Payment Interface Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodPaymentInterfaceSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
paymentInterface String | Payment interface of the Payment Method after the Set PaymentInterface update action. |
oldPaymentInterface String | Payment interface of the Payment Method before the Set PaymentInterface update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodMethodSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
method String | Payment Method after the Set Method update action. |
oldMethod String | Payment Method before the Set Method update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Key Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
key String | |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodKeySet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
oldKey String | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Name Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodNameSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name | Name of the Payment Method after the Set Name update action. |
oldName | Name of the Payment Method before the Set Name update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Status Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodPaymentMethodStatusSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
status | Status of the Payment Method after the Set PaymentMethodStatus update action. |
oldStatus | Status of the Payment Method before the Set PaymentMethodStatus update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Custom Type Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodCustomTypeSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customFields | The Custom Fields that were set. |
oldTypeId String | id of the previous Custom Type. Absent if there was no previous Custom Type present. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Custom Type Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodCustomTypeRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
oldTypeId String | id of the Custom Type that was removed. Absent if there was no previous Custom Type present. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Custom Field Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodCustomFieldAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was added. |
value | The added CustomFieldValue based on the FieldType. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Custom Field Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodCustomFieldChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that changed. |
value | |
oldValue | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Custom Field Removed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodCustomFieldRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was removed. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Messages
Payment Created
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
payment | Payment that was created. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Interaction Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentInteractionAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
interaction | The interface interaction that was added to the Payment. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Transaction Added
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentTransactionAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
transaction | Transaction that was added to the Payment. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Transaction State Changed
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentTransactionStateChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
transactionId String | Unique identifier for the Transaction for which the Transaction State changed. |
state | Transaction State after the Change Transaction State update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Status State Transition
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentStatusStateTransition" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
state | |
force Boolean | Whether State transition validations were turned off during the Change Transaction State update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Status Interface Code Set
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentStatusInterfaceCodeSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
interfaceCode String | The interfaceCode that was set during the Set StatusInterfaceCode update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Interface ID Set BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentInterfaceIdSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
interfaceId String | Interface ID of the Payment after the Set InterfaceId update action. |
oldInterfaceId String | Interface ID of the Payment before the Set InterfaceId update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Info Interface Set BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodInfoInterfaceSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
interface String | Payment interface of the Payment Method after the Set MethodInfo Interface update action. |
oldInterface String | Payment interface of the Payment Method before the Set MethodInfo Interface update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Info Method Set BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodInfoMethodSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
method String | Payment Method after the Set MethodInfo Method update action. |
oldMethod String | Payment Method before the Set MethodInfo Method update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Info Name Set BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodInfoNameSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name | Name of the Payment Method after the Set MethodInfo Name update action. |
oldName | Name of the Payment Method before the Set MethodInfo Name update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Info Token Set BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodInfoTokenSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
token | Token of the Payment Method after the Set MethodInfo Token update action. |
oldToken | Token of the Payment Method before the Set MethodInfo Token update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Info Interface Account Set BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodInfoInterfaceAccountSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
interfaceAccount String | Interface account of the Payment Method after the Set MethodInfo InterfaceAccount update action. |
oldInterfaceAccount String | Interface account of the Payment Method before the Set MethodInfo InterfaceAccount update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Info Custom Type Set BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodInfoCustomTypeSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
customFields | The Custom Fields that were set. |
oldTypeId String | id of the previous Type. Absent if there was no previous Custom Type present. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Info Custom Type Removed BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodInfoCustomTypeRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
oldTypeId String | id of the Type that was removed. Absent if there was no previous Custom Type present. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Info Custom Field Added BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodInfoCustomFieldAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was added. |
value | The added CustomFieldValue based on the FieldType. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Info Custom Field Changed BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodInfoCustomFieldChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that changed. |
value | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Payment Method Info Custom Field Removed BETA
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always 1 . |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1.
sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource. |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "PaymentMethodInfoCustomFieldRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as key or externalId . Only present if the resource has such identifiers. |
name String | Name of the Custom Field that was removed. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |