actions - User account - WEBSALE Dokumentation

This page contains all actions relating to the user account and therefore all messages and email templates that occur when creating, changing, deleting and checking account data.

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

{
  "actions": {
    ...
    "accountActivate": {...},
    "accountActivateOptIn": {...},
    "accountDelete": {...},
    "accountDisplayNameUpdate": {...},
    "accountRegister": {...},
    "addressCreate": {...},
    "addressDelete": {...},
    "addressUpdate": {...},
    "creditCardDelete": {...},
    "confirmZipCode": {...},
    "emailUpdate": {...},
    "emailVerify": {...},
    "setCustomerData": {...},
    "setMainAddress": {...},
    "subAccountCreate": {...},
    "userInvitation": {...},
    ...
  }
}

Action overview

Action	Description
`accountActivate`	Configures the opt-in email and the error messages for the activation of an existing customer account by existing customers.
`accountActivateOptIn`	Configures the verification email and the error messages when confirming the opt-in link as part of the existing-customer activation.
`accountDelete`	Configures the email templates used for confirmation and double-opt-in emails as well as possible error messages during account deletion.
`accountDisplayNameUpdate`	Defines which error texts are output for missing inputs or non-signed-in users during the change of the name.
`accountRegister`	Defines the error texts when registering new customers.
`addressCreate`	Defines the error messages when creating new addresses in the customer account.
`addressUpdate`	Defines the error messages when updating existing addresses in the customer account.
`addressDelete`	Defines the error messages when deleting addresses in the customer account.
`creditCardDelete`	Defines the error messages when removing saved pseudo credit card data from the customer account.
`confirmZipCode`	Defines the error messages when validating a possibly invalid ZIP code.
`emailUpdate`	Defines the error messages when updating the email address in the customer account.
`emailVerify`	Defines the error messages when verifying the email address in the customer account.
`setCustomerData`	Defines the error messages when saving or updating customer data in the shop.
`setMainAddress`	Defines the error messages when setting a main address in the customer account.
`subAccountCreate`	Defines the error messages when creating new sub-accounts within an existing customer account.
`userInvitation`	Defines the error messages when inviting new users, for example to sub-accounts or shared customer accounts. Both the invitation email and possible error messages for the invitation check are defined here.

`actions.account*` - User

The actions described in this section concern operations around the user account. They are triggered whenever the user performs a corresponding action in the shop — for example during registration, when changing the profile 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 it configures which confirmation email is sent after successful deletion and whether an additional double-opt-in email is used to confirm the deletion request.

Example configuration

{
  "confirmationEmail": {
    "fromAddress": "noreply@websale.de",
    "fromName": "Mein Onlineshop",
    "subject": "Mein Onlineshop | Löschung ihres Kontos",
    "template": "accountDelete.htm"
  },
  "doubleOptInEmail": {
    "enabled": false,
    "fromAddress": "noreply@websale.de",
    "fromName": "Mein Onlineshop",
    "subject": "Mein Onlineshop | Löschung ihres Kontos",
    "template": "accountDeleteOptIn.htm"
  },
  "errorCodes": {
    "actionNotAllowed": "<Textbaustein>",
    "notLoggedIn": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`confirmationEmail`	object	Configures the confirmation email that is sent to the customer after the account deletion. Dispatch can be enabled or disabled via `enabled`. Subject, sender and template are controlled via the general email parameters, see here: Emails & email settings
`doubleOptInEmail`	object	Configures the optional double-opt-in email with which the customer must confirm the account deletion before it is executed. Dispatch can be enabled or disabled via `enabled`. Subject, sender and template are controlled via the general email parameters, see here: Emails & email settings
`errorCodes`	object	Configures the error codes used for problems during the action.
`notLoggedIn`	string	Error message output when the user is not signed in.
`actionNotAllowed`	string	Error message output when the action is not allowed.

`actions.accountDisplayNameUpdate` - Change display name

The accountDisplayNameUpdate action controls the error messages when updating the public display name. This is only shown for submitted customer reviews, where it replaces the real name.

Example configuration

{
  "errorCodes": {
    "missingDisplayName": "<Textbaustein>",
    "notLoggedIn": "<Textbaustein>",
    "insufficientPrivileges": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`missingDisplayName`	string	Error message output when the display name was not supplied.
`notLoggedIn`	string	Error message output when the user is not signed in.
`insufficientPrivileges`	string	Error message output when a staff account (sub-account) does not have the necessary permission to change its own display name.

`actions.accountRegister` - Register user

The accountRegister action controls the error messages when registering a new user account in the shop. Optionally, a confirmation/verification email can be sent via verifyEmail after successful registration.

Example configuration

{
  "errorCodes": {
    "accountAlreadyExists": "<Textbaustein>",
    "duplicateAccountFound": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "missingEmail": "<Textbaustein>",
    "missingId": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "passwordCheckFailed": "<Textbaustein>",
    "passwordMismatch": "<Textbaustein>"
  },
  "verifyEmail": {
    "fromAddress": "noreply@websale.de",
    "fromName": "Mein Onlineshop",
    "subject": "Mein Onlineshop | Registrierung",
    "template": "accountRegister.htm"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`accountAlreadyExists`	string	Error message output when the account already exists.
`duplicateAccountFound`	string	Error message output when a duplicate was detected during registration (duplicate check via accounts.account → `duplicate`).
`emailCheckFailed`	string	Error message output when the provided email address is considered invalid.
`missingEmail`	string	Error message output when no email address was supplied.
`missingId`	string	Error message output when no login ID was supplied.
`missingPassword`	string	Error message output when no password was supplied.
`passwordCheckFailed`	string	Error message output when the password does not meet the minimum requirements.
`passwordMismatch`	string	Error message output when the password and password confirmation do not match.
`verifyEmail`	object	Configures the email through which the customer can confirm their registration. Subject, sender and template are controlled via the general email parameters, see here: Emails & email settings

`actions.accountActivate` - Activate existing customer

The accountActivate action controls the opt-in email and the error messages when an existing customer account already present in the shop is activated by an existing customer. The precondition is that the customer record was previously created in the shop (e.g. via an import). Further information about the configuration of existing-customer registration can be found under accounts.account. Example configuration

{
  "optInEmail": {
    "template": "account/activateAccountOptIn.htm",
    "subject": "Registration attempt for your Account",
    "fromAddress": "no-reply@websale.de",
    "fromName": "Websale Shop"
  },
  "errorCodes": {
    "disabled": "<Textbaustein>",
    "missingId": "<Textbaustein>",
    "missingCustomerNumber": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "passwordMismatch": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "passwordCheckFailed": "<Textbaustein>",
    "accountNotFound": "<Textbaustein>",
    "accountAlreadyActivated": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`optInEmail`	object	Configures the opt-in email that is sent to the address stored in the customer account after activation. The customer must confirm the registration once more via this email. Dispatch can be disabled in accounts.account via `requireOptIn`. Subject, sender and template are controlled via the general email parameters.
`errorCodes`	object	Configures the error codes used for problems during the action.
`disabled`	string	Error message output when existing-customer registration is disabled.
`missingId`	string	Error message output when no email address was supplied.
`missingCustomerNumber`	string	Error message output when no customer number was supplied.
`missingPassword`	string	Error message output when no password was supplied.
`passwordMismatch`	string	Error message output when the password and password confirmation do not match.
`emailCheckFailed`	string	Error message output when the provided email address is considered invalid.
`passwordCheckFailed`	string	Error message output when the password does not meet the minimum requirements.
`accountNotFound`	string	Error message output when no account could be found with the supplied data.
`accountAlreadyActivated`	string	Error message output when the account has already been activated.

`actions.accountActivateOptIn` - Existing-customer activation opt-in confirmation

The accountActivateOptIn action controls the verification email and the error messages that occur when the opt-in link is confirmed as part of the existing-customer activation. This action takes effect after the customer has called the opt-in link from the email sent by accountActivate. Example configuration

{
  "verifyEmail": {
    "template": "account/email_verify.htm",
    "subject": "Verify your Email-Address",
    "fromAddress": "no-reply@websale.de",
    "fromName": "Websale Shop"
  },
  "errorCodes": {
    "actionNotAllowed": "<Textbaustein>",
    "accountAlreadyExists": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`verifyEmail`	object	Configures the verification email that is sent to the customer after successful confirmation of the opt-in link. Subject, sender and template are controlled via the general email parameters.
`errorCodes`	object	Configures the error codes used for problems during the action.
`actionNotAllowed`	string	Error message output when the opt-in token is invalid or has expired.
`accountAlreadyExists`	string	Error message output when a split into company/staff accounts is configured and the staff account could not be created because the email address is already in use.

`actions.address*` - Address data

This section contains all actions relating to the management of address data in the user account. The messages that are output when creating, changing or deleting billing and shipping addresses in the shop are documented here.

`actions.addressCreate` - Create address

The addressCreate action controls the error messages when creating a new address in the customer account.

Example configuration

{
  "errorCodes": {
    "notLoggedIn": "<Textbaustein>",
    "emptyAddress": "<Textbaustein>",
    "unknownField": "<Textbaustein>",
    "invalidFieldType": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`notLoggedIn`	string	Error message output when the user is not signed in.
`emptyAddress`	string	Error message output when no or incomplete address data was supplied.
`unknownField`	string	Error message output when fields were supplied that are not known to the system.
`invalidFieldType`	string	Error message output when fields are filled with an invalid data type.

`actions.addressDelete` - Delete address

The addressDelete action controls the error messages when deleting an existing address in the customer account.

Example configuration

{
  "errorCodes": {
    "notLoggedIn": "<Textbaustein>",
    "invalidAddressId": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`notLoggedIn`	string	Error message output when the user is not signed in.
`invalidAddressId`	string	Error message output when the supplied address ID is invalid or the address cannot be found.

`actions.addressUpdate` - Edit address

The addressUpdate action controls the error messages that occur when editing an existing address in the customer account.

Example configuration

{
  "errorCodes": {
    "emptyAddress": "<Textbaustein>",
    "invalidAddressId": "<Textbaustein>",
    "unknownField": "<Textbaustein>",
    "invalidFieldType": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>",
    "readOnlyField": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`emptyAddress`	string	Error message output when no or incomplete address data was supplied.
`invalidAddressId`	string	Error message output when the supplied address ID is invalid or the address cannot be found.
`unknownField`	string	Error message output when fields were supplied that are not known to the system.
`invalidFieldType`	string	Error message output when fields are filled with an invalid data type.
`expressCheckoutNotAllowed`	string	Error message output when the address must not be changed during an express checkout.
`readOnlyField`	string	Error message output when an attempt is made to change a read-only field.

`actions.creditCardDelete` - Delete saved credit card

The creditCardDelete action defines the error messages output when deleting a saved credit card.

Example configuration

{
  "errorCodes": {
    "notLoggedIn": "<Textbaustein>",
    "missingPseudoId": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`notLoggedIn`	string	Error message output when the user is not signed in.
`missingPseudoId`	string	Error message output when no or an invalid card reference was supplied, or the card cannot be found.

`actions.confirmZipCode` - Confirm ZIP code

The confirmZipCode action defines the error messages for the check whether the supplied ZIP code matches a given order.

Example configuration

{
  "errorCodes": {
    "missingZipCode": "<Textbaustein>",
    "missingOrderId": "<Textbaustein>",
    "invalidZipCode": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`missingZipCode`	string	Error message output when no ZIP code was supplied.
`missingOrderId`	string	Error message output when no order number was supplied.
`invalidZipCode`	string	Error message output when the ZIP code does not match the order.

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 login email address, as well as when confirming or verifying the email address via confirmation links.

`actions.emailUpdate` - Change email address

The emailUpdate action defines emails and error messages for changing the email address of an existing customer account. Two email types can be used: an optional double-opt-in email and a confirmation/verification email to the new address.

Example configuration

{
  "verifyEmail": {
    "template": "email_update_verify.htm",
    "subject": "Bitte bestätigen Sie Ihre neue E-Mail-Adresse",
    "fromAddress": "noreply@meinshop.de",
    "fromName": "Mein Onlineshop"
  },
  "doubleOptInEmail": {
    "template": "email_update_double_opt_in.htm",
    "subject": "Bestätigung zur Änderung Ihrer E-Mail-Adresse",
    "fromAddress": "noreply@meinshop.de",
    "fromName": "Mein Onlineshop",
    "enabled": false
  },
  "errorCodes": {
    "missingEmail": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "accountAlreadyExists": "<Textbaustein>",
    "actionNotAllowed": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`verifyEmail`	object	Configures the email through which the customer can confirm the change. Subject, sender and template are controlled via the general email parameters, see here: Emails & email settings
`doubleOptInEmail`	object	Configures the optional double-opt-in email with which the customer must confirm the account deletion before it is executed. Dispatch can be enabled or disabled via `enabled`. Subject, sender and template are controlled via the general email parameters, see here: Emails & email settings
`errorCodes`	object	Configures the error codes used for problems during the action.
`missingEmail`	string	Error message output when no email address was supplied.
`emailCheckFailed`	string	Error message output when the provided email address is considered invalid.
`accountAlreadyExists`	string	Error message output when an account with this email address already exists.
`actionNotAllowed`	string	Error message output when the action is not allowed.

`actions.emailVerify` - Confirm email address

The emailVerify action defines error messages that occur when a customer verifies their email address via a confirmation link (double opt-in).

Example configuration

{
  "errorCodes": {
    "actionNotAllowed": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`actionNotAllowed`	string	Error message output when the action is not allowed.

`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 controls error messages when processing additional customer data. This data is captured, for example, via forms in the customer account or during checkout.

Example configuration

{
  "errorCodes": {
    "fieldCheckFailed": "<Textbaustein>",
    "invalidNumberValue": "<Textbaustein>",
    "invalidCheckboxValue": "<Textbaustein>",
    "requiredCheckboxUnchecked": "<Textbaustein>",
    "requiredTextfieldEmpty": "<Textbaustein>",
    "requiredNumberfieldEmpty": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`fieldCheckFailed`	string	Error message output when a field check fails (e.g. required field violated or format error).
`invalidNumberValue`	string	Error message output when no valid numeric value was supplied for a number field.
`invalidCheckboxValue`	string	Error message output when an invalid value was supplied for a checkbox.
`requiredCheckboxUnchecked`	string	Error message output when a checkbox marked as required was not ticked.
`requiredTextfieldEmpty`	string	Error message output when a required text field was left empty.
`requiredNumberfieldEmpty`	string	Error message output when a required number field was left empty.

`actions.setMainAddress` - Set main address

The setMainAddress action defines the error messages that occur when setting the main address in the customer account.

Example configuration

{
  "errorCodes": {
    "notLoggedIn": "<Textbaustein>",
    "missingAddressId": "<Textbaustein>",
    "invalidAddressId": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`notLoggedIn`	string	Error message output when the user is not signed in.
`missingAddressId`	string	Error message output when no address ID was supplied (no address selected).
`invalidAddressId`	string	Error message output when the supplied address ID is invalid or the address cannot be found.

`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).

Example configuration

{
  "errorCodes": {
    "disabled": "<Textbaustein>",
    "notLoggedIn": "<Textbaustein>",
    "accountNotVerified": "<Textbaustein>",
    "missingId": "<Textbaustein>",
    "missingEmail": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "passwordMismatch": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "passwordCheckFailed": "<Textbaustein>",
    "accountAlreadyExists": "<Textbaustein>",
    "mailSendFailed": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`disabled`	string	Error message output when the creation of sub-accounts is generally disabled in the shop.
`notLoggedIn`	string	Error message output when the user is not signed in.
`accountNotVerified`	string	Error message output when the main account has not yet been verified and is therefore not allowed to create sub-accounts.
`missingId`	string	Error message output when no login ID was supplied.
`missingEmail`	string	Error message output when no email address was supplied.
`missingPassword`	string	Error message output when no password was supplied.
`passwordMismatch`	string	Error message output when the password and password confirmation do not match.
`emailCheckFailed`	string	Error message output when the provided email address is considered invalid.
`passwordCheckFailed`	string	Error message output when the password does not meet the minimum requirements.
`accountAlreadyExists`	string	Error message output when an account with this email address already exists.
`mailSendFailed`	string	Error message output when the invitation email to the new sub-account could not be sent.

​Overview of actions

​Excerpt of the basic actions structure

​Action overview

​actions.account* - User

​actions.accountDelete - Account deletion

​Example configuration

​Parameter overview

​actions.accountDisplayNameUpdate - Change display name

​Example configuration

​Parameter overview

​actions.accountRegister - Register user

​Example configuration

​Parameter overview

​actions.accountActivate - Activate existing customer

​actions.accountActivateOptIn - Existing-customer activation opt-in confirmation

​actions.address* - Address data

​actions.addressCreate - Create address

​Example configuration

​Parameter overview

​actions.addressDelete - Delete address

​Example configuration

​Parameter overview

​actions.addressUpdate - Edit address

​Example configuration

​Parameter overview

​actions.creditCardDelete - Delete saved credit card

​Example configuration

​Parameter overview

​actions.confirmZipCode - Confirm ZIP code

​Example configuration

​Parameter overview

​actions.email* - Email address for the login

​actions.emailUpdate - Change email address

​Example configuration

​Parameter overview

​actions.emailVerify - Confirm email address

​Example configuration

​Parameter overview

​actions.set* - Data assignment & update

​actions.setCustomerData - Additional customer data

​Example configuration

​Parameter overview

​actions.setMainAddress - Set main address

​Example configuration

​Parameter overview

​actions.subAccountCreate - Create sub-accounts

​Example configuration

​Parameter overview

Overview of actions

Excerpt of the basic `actions` structure

Action overview

`actions.account*` - User

`actions.accountDelete` - Account deletion

Example configuration

Parameter overview

`actions.accountDisplayNameUpdate` - Change display name

Example configuration

Parameter overview

`actions.accountRegister` - Register user

Example configuration

Parameter overview

`actions.accountActivate` - Activate existing customer

`actions.accountActivateOptIn` - Existing-customer activation opt-in confirmation

`actions.address*` - Address data

`actions.addressCreate` - Create address

Example configuration

Parameter overview

`actions.addressDelete` - Delete address

Example configuration

Parameter overview

`actions.addressUpdate` - Edit address

Example configuration

Parameter overview

`actions.creditCardDelete` - Delete saved credit card

Example configuration

Parameter overview

`actions.confirmZipCode` - Confirm ZIP code

Example configuration

Parameter overview

`actions.email*` - Email address for the login

`actions.emailUpdate` - Change email address

Example configuration

Parameter overview

`actions.emailVerify` - Confirm email address

Example configuration

Parameter overview

`actions.set*` - Data assignment & update

`actions.setCustomerData` - Additional customer data

Example configuration

Parameter overview

`actions.setMainAddress` - Set main address

Example configuration

Parameter overview

`actions.subAccountCreate` - Create sub-accounts

Example configuration

Parameter overview