OnOrderBeforeCreated

This hook runs before any command have been applied to an Order Actor from the create message. Commands returned will be applied to the order before the create message's commands.

The order field in the input will contain only basic information, such as orderId, currencyCode. taxIncluded and createdAt. Note that orderNumber is not yet set, and generateOrderNumberByPrefix command can be used to set a different the order number serie than the default.

Type

{
  hook: 'OnOrderBeforeCreated'
  order: Order
}

Effects

validationError

Prevents the operation and returns an error to the caller.

orderCommand

Applies a command to the order before the `create` message's commands.

Examples

Custom Order Number Prefix

param input: OnOrderBeforeCreated

from effects.order.command.generateOrderNumberByPrefix {
  prefix = 'CUSTOM'
}