Broadleaf Microservices
  • v1.0.0-latest-prod

Order Operations Messaging

Order Operations Message Inputs and Listeners

Table 1. Order Operations Message Inputs and Listeners
Destination Listener Purpose

checkoutCompletion

CheckoutCompletionListener

Generates Order and Fulfillments after checkout (see Order Submission)

orderCreated

AutoCaptureVirtualOrderCreatedListener

Starts capturing payment virtual Fulfillments after Order is created (see Configuration)

AutoFulfillsVirtualOrderCreatedListener

Fulfills virtual Fulfillments after Order is created (see Configuration)

VoucherCodeGenerationOrderCreatedListener

Validates Order’s vouchers, generates voucher codes, and sending a VoucherGenerationCompletionEvent message after Order is created (see Configuration)

fulfillmentCapturingPayment

FulfillmentCapturingPaymentListener

Captures payment for "Capturing Payment" Fulfillment (see Statuses and Transitions)

paymentCaptureAttempted

AutoFulfillPaymentCapturedListener

Fulfills virtual Fulfillments after a successful capture (see Configuration)

fulfillmentCancelled

PaymentReversalFulfillmentCancelledListener

Cancels payment for "Cancelled" Fulfillment (see Statuses and Transitions)

returnConfirmed

PaymentRefundReturnConfirmedListener

Refunds payment for Return Confirmations (see Return Flow)

paymentTransactionWebhook

FulfillmentCaptureWebhookListener

Updates the associated fulfillment based on the capture transaction results that were asynchronously received from a webhook

ReturnConfirmationRefundWebhookListener

Updates the associated return confirmation and authorization based the refund transaction results that were asynchronously received from a webhook

Order Operations Message Outputs

Table 2. Order Operations Message Outputs
Destination Payload When

orderCreated

OrderCreatedEvent

Sent by CheckoutCompletionListener after Order and Fulfillments are generated from checkout (see Order Submission)

voucherGenerationCompletion

voucherGenerationCompletion

Sent by VoucherCodeGenerationOrderCreatedListener after Vouchers are validated and voucher codes are generated (see Voucher Code Generation)

fulfillmentCapturingPayment

FulfillmentStatusChangeEvent

Sent by CapturingPaymentStatusChangeHandler after Fulfillment changed into the "Capturing Payment" status (see Statuses and Transitions)

fulfillmentCancelled

FulfillmentStatusChangeEvent

Sent by CancelStatusChangeHandler after Fulfillment changed into the "Cancelled" status (see Statuses and Transitions)

fulfillmentFulfilling

FulfillmentStatusChangeEvent

Sent by FulfillingStatusChangeHandler after Fulfillment changed into the "Fulfilling" status (see Statuses and Transitions)

fulfillmentFulfillFailed

FulfillmentStatusChangeEvent

Sent by FulfillFailedStatusChangeHandler after Fulfillment changed into the "Capturing Payment" status (see Statuses and Transitions)

fulfillmentFulfilled

FulfillmentStatusChangeEvent

Sent by FulfilledStatusChangeHandler after Fulfillment changed into the "Fulfilled" status (see Statuses and Transitions)

paymentCaptureAttempted

PaymentCaptureAttemptResult

Sent by FulfillmentCapturingPaymentListener after a successful or failed payment capture attempt (see Payment Interactions). Can also be sent by FulfillmentCaptureWebhookListener after capture transaction results are asynchronously received from a webhook.

returnCreated

ReturnCreatedEvent

Sent by DefaultReturnOperationService after a Return Authorization is created (see Return Flow)

returnConfirmed

ReturnConfirmedEvent

Sent by DefaultReturnOperationService after a Return Confirmation is created (see Return Flow)

returnCancelled

ReturnCancelledEvent

Sent by DefaultReturnOperationService after a Return Authorization is cancelled (see Return Flow)