Changelog
Introduction
1.
General Architecture
2.
Custom workflows and workflow instances
2.1.
Extension points - Sales Order
2.1.1.
ConfigureLineItem
2.1.2.
AssembleProduct
2.1.3.
CancelLineItem
2.1.4.
RefundLineItem
2.2.
Extension points - External Payment Methods
2.2.1.
AuthorizeOrCapturePayment
2.2.2.
CapturePayment
2.2.3.
CancelPayment
2.2.4.
RevertPayment
2.2.5.
GrantPayout
2.2.6.
CancelPayout
2.3.
Extension points - External Invoicing Methods
2.3.1.
InvoiceSalesOrder
2.3.2.
ViewExternalInvoice
2.4.
Extension points - Kiosk
2.5.
Extension points - Child CUWOs
2.5.1.
CustomerLevelUI
2.6.
Extension points - Refunds
2.6.1.
AuthorizeRefund
2.6.2.
ProcessRefund
2.6.3.
CancelRefund
3.
API specifications
3.1.
NFON
3.2.
CUWO messages API
3.2.1.
Generic messages
3.2.1.1.
Error
3.2.1.2.
StatusNotification
3.2.2.
Lifecycle messages
3.2.2.1.
TerminationRequested
3.2.2.2.
TerminationConfirmationMessage
3.2.2.3.
TerminationNotification
3.2.2.4.
KillNotification
3.2.3.
Operation messages
3.2.3.1.
Operation-related messages
3.2.3.1.1.
OperationAcknowledged
3.2.3.1.2.
OperationFinished
3.2.3.2.
Printing-related messages
3.2.3.2.1.
PrintBusinessDocumentOperation
3.2.3.2.2.
PrintDocumentOperation
3.2.3.3.
Scanning/Capture-related messages
3.2.3.3.1.
ScanBarcodesStartOperation
3.2.3.3.2.
ScanBarcodesStopOperation
3.2.3.3.3.
BarcodeScanned
3.2.3.3.4.
CaptureImageOperation
3.2.3.4.
Basket-related messages
3.2.3.4.1.
CheckoutBasketOperation
3.2.3.4.2.
EvaluateBasketOperation
3.2.3.5.
Business day-related messages
3.2.3.5.1.
StartCurrentRegisterBusinessDayOperation
3.2.3.5.2.
StartCurrentStaffMemberBusinessDayOperation
3.2.3.5.3.
EndCurrentRegisterBusinessDayOperation
3.2.3.5.4.
EndCurrentStaffMemberBusinessDayOperation
3.2.3.6.
Locker-related messages
3.2.3.6.1.
OpenLockerOperation
3.2.3.6.2.
CloseLockerOperation
3.2.3.7.
Parent/child CUWO-related messages
3.2.3.7.1.
SpawnCustomerLevelUIChildCUWOOperation
3.2.3.7.2.
TerminateChildCUWOOperation
3.2.3.7.3.
ChildCUWOTerminated
3.2.3.7.4.
PassMessageToCUWOOperation
3.2.3.7.5.
MessageReceived
3.2.3.8.
Other messages
3.2.3.8.1.
UpdateLineItemStatus
3.2.3.8.2.
UpdatePaymentProcessingDataOperation
3.2.3.8.3.
UpdatePayoutProcessingDataOperation
3.2.3.8.4.
UpdateRefundProcessingDataOperation
3.3.
CUWO callback API
3.3.1.
Methods related to workflow parameters & context
3.3.1.1.
getStartURL
3.3.1.2.
getOrganizationInfo
3.3.1.3.
getSalesChannelInfo
3.3.1.4.
getRegisterInfo
3.3.1.5.
getCUWOContextInformation
3.3.1.6.
getWorkflowParameters
3.3.1.7.
getLineItems
3.3.1.8.
getLineItemInfo
3.3.1.9.
getProductInfo
3.3.2.
Methods related to workflow termination
3.3.2.1.
terminateSuccess
3.3.2.2.
terminateFailure
3.3.2.3.
terminateCanceled
3.3.3.
Type definitions
3.3.4.
NFON examples
Light (default)
Rust
Coal
Navy
Ayu
Enfore Custom Workflow Architecture & APIs
Lifecycle messages
Lifecycle messages are used to control the lifecycle of a workflow.