Overview of actions
Below is a listing of all actions offered for user accounts. Actions that thematically belong to a different area can be found in the corresponding sections of this documentation or in the alphabetical overview of actions.Excerpt of the basic actions structure
Action overview
actions.account* - User
The actions described in this section relate to processes around the user account. They are always triggered when the user performs a corresponding action in the shop, for example when registering, when making profile changes or when deleting the account.
actions.accountDelete - Account deletion
The accountDelete action controls the error messages for requests to delete a customer account. At the same time, this is where you configure which confirmation email is sent after successful deletion and whether a double-opt-in email is additionally used to confirm the deletion request.
Example configuration
Parameter overview
actions.accountDisplayNameUpdate - Change display name
The accountDisplayNameUpdate action controls the error messages when updating the public display name. This name is only shown for submitted customer reviews and replaces the real name there.
Example configuration
Parameter overview
actions.accountRegister - Register user
The accountRegister action controls the error messages when registering a new user account in the shop. After a successful registration, the shop sends the email configured via verifyEmail, with which the customer can confirm their email address.
Example configuration
Parameter overview
actions.accountActivate - Activate existing customers
The accountActivate action controls the opt-in email and the error messages for the activation of a customer account already present in the shop by existing customers. The prerequisite is that the customer record has been created in the shop beforehand (for example via an import). Further information on configuring the existing-customer registration can be found under accounts.account.
Example configuration
actions.accountActivateConfirm - Existing-customer activation opt-in confirmation
The accountActivateConfirm configuration node controls the verification email and the error messages of the AccountActivateOptIn action. This action confirms the existing-customer activation after the customer has opened the opt-in link from the email sent by accountActivate.
Example configuration
actions.address* - Address data
This section contains all actions relating to the management of address data in the user account. It documents the messages that are output when creating, changing or deleting invoice and shipping addresses in the shop.
actions.addressCreate - Create address
The addressCreate action controls the error messages when creating a new address in the customer account.
Example configuration
Parameter overview
actions.addressDelete - Delete address
The addressDelete action controls the error messages when deleting an existing address in the customer account.
Example configuration
Parameter overview
actions.addressUpdate - Edit address
The addressUpdate action controls the error messages that occur when editing an existing address in the customer account.
Example configuration
Parameter overview
actions.creditCardDelete - Delete stored credit card
The creditCardDelete action defines the error messages that are output when deleting a stored credit card.
Example configuration
Parameter overview
actions.confirmZipCode - Confirm postal code
The confirmZipCode action defines the error messages for the check whether the supplied postal code matches a specified order.
Example configuration
Parameter overview
actions.email* - Email address for sign-in
This section covers all actions around the email address used for sign-in. Here you can configure the emails and error messages used when changing the sign-in email address as well as when confirming or verifying the email address via confirmation links.
actions.emailUpdate - Change email address
With the emailUpdate action, you define the emails and error messages that are sent when changing the email address of an existing customer account. Two email types are used. The optional double-opt-in email must be confirmed before the change is carried out. The verification email is sent to the new address after the change.
Example configuration
Parameter overview
actions.emailVerify - Confirm email address
The emailVerify action lets you define error messages that occur when a customer is asked to verify their email address via a confirmation link (double opt-in).
Example configuration
Parameter overview
actions.set* - Data assignment & update
This section covers actions that set or update specific data or values in the running shop context.
actions.setCustomerData - Additional customer data
The setCustomerData action lets you control error messages when processing additional customer data. This data is captured, for example, via forms in the customer account or in the checkout.
Example configuration
Parameter overview
If a check from a field’s
validations fails, the error code is fieldCheckFailed. This node no longer has a separate error text for it. Instead, the shop outputs the exact text of the failed check, for example “The input is too short.”. These texts are stored in general.dataCheckerValidationErrors.
actions.setMainAddress - Set main address
With the setMainAddress action, you define error messages that occur when setting the main address in the customer account.
Example configuration
Parameter overview
actions.subAccountCreate - Create sub-accounts
The subAccountCreate action defines error messages that occur when registering a sub-account under an existing main customer account (for example, for staff, branch or team accounts). The invitation email for the new sub-account is not configured here but under b2b.subAccounts.
Example configuration
Parameter overview
actions.triggerMemberPasswordReset - Password email for staff accounts
The triggerMemberPasswordReset action defines the error messages that occur when the administrator of a company account sends a staff account an email for resetting the password. The email itself is configured under email in actions.passwordForgotten.
Example configuration
Parameter overview
actions.paymentVault* - Link with the payment provider
In this section, the account at the payment provider is linked. When the customer signs in with their customer account, they do not have to go through the process on the payment provider’s side again for subsequent orders. The actions described here control the links on a separate page. These can be created and removed independently of an order. Alternatively, a link can also be created during the ordering process. That path does not go through the actions described here, but through the order completion (see actions - Basket & checkout).
Which payment methods support a link is decided by the payment provider. Currently, PayPal Checkout is the only provider that supports this feature.
A link is uniquely assigned via the merchant ID of the payment provider. If several sub-shops use the same merchant ID, a link once created is valid for all these sub-shops. If different merchant IDs are stored for the sub-shops, the accounts must be linked separately.
actions.paymentVaultSetup - Prepare link
The paymentVaultSetup action controls the error messages when preparing the link between the account at the payment provider and the current customer account.
Example configuration
Parameter overview
actions.paymentVaultCreate - Create link
The paymentVaultCreate action controls the error messages when creating the payment token and thus the link. The action requires the token generated via paymentVaultSetup.
Example configuration
Parameter overview
actions.paymentVaultRemove - Remove link
The paymentVaultRemove action controls the error messages when removing an existing link.