Here you will find the associated messages and email templates used when adding, removing or updating items as well as when finalising an order or registering as a guest.
Overview of actions
The actions listed here are grouped thematically to provide a clear overview of the associated error messages and email templates. 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
| Action | Description |
|---|---|
basketItemAdd | Defines error messages when adding an item to the basket. |
basketItemDelete | Defines error messages when removing an item from the basket. |
basketItemUpdate | Defines error messages when changing a basket position. |
checkoutAccountTypeSelect | Defines error messages for the account type selection in checkout. |
checkoutBillAddressSelect | Defines error messages when selecting the billing address in checkout. |
checkoutConfirm | Defines emails and error messages for finalising the order. |
checkoutPaymentUpdate | Defines error messages when changing the payment method in checkout. |
checkoutPseudoCCSelect | Defines error messages when selecting a stored (pseudo) credit card in checkout. |
checkoutSetFreeFields | Defines error messages when validating free text fields in checkout. |
checkoutSetGuestEmail | Defines error messages when entering the email address for a guest order. |
checkoutShippingAddressSelect | Defines the error messages when selecting the delivery address in checkout. |
checkoutShippingMethodUpdate | Defines error messages when changing the shipping method in checkout. |
guestRegister | Defines emails and error messages for creating a customer account after a guest order. |
directOrder | Defines error messages for direct orders. |
voucherAdd | Defines error messages when adding a voucher to the basket. |
voucherDelete | Defines error messages when removing a voucher from the basket. |
inventoryReserve | Defines error messages when reserving stock for basket positions. |
actions.basketItem* - Basket position
actions.basketItemAdd - Add basket position
The basketItemAdd action controls the error messages when adding an item to the basket.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
accountNotVerified | string | Error message output when the customer account has not yet been verified. |
missingProductId | string | Error message output when no product ID was supplied. |
missingQuantity | string | Error message output when no order quantity was supplied. |
invalidQuantity | string | Error message output when the supplied order quantity is invalid. |
invalidProductId | string | Error message output when the supplied product ID is invalid. |
invalidVariantId | string | Error message output when the selected variant is invalid or unavailable. |
insufficientAmount | string | Error message output when there is not enough stock for the requested quantity. |
quantityExceeded | string | Error message output when a defined maximum order quantity is exceeded. |
childProductOnly | string | Error message output when an attempt is made to directly order a product that is only configurable as a “child” product. |
expressCheckoutNotAllowed | string | Error message output when the item may not be added to the basket in express checkout. |
noVariantFound | string | Error message output when no matching product variant can be found for the selected options. |
invalidStore | string | Error message output when the selected pickup location is invalid or unavailable for the item. |
actions.basketItemDelete - Delete basket position
The basketItemDelete action controls the error messages when removing an item from the basket.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
accountNotVerified | string | Error message output when the customer account has not yet been verified. |
missingBasketItemId | string | Error message output when no basket position ID was supplied. |
invalidBasketItemId | string | Error message output when the supplied basket position is invalid or cannot be found. |
basketItemIsSetChild | string | Error message output when an attempt is made to remove a variant that can only be removed via the main product. |
itemNotRemovable | string | Error message output when the position in question generally must not be removed. |
internalError | string | Error message output when an unexpected system error occurs. |
invalidChildItem | string | Error message output when an invalid variant is referenced. |
expressCheckoutNotAllowed | string | Error message output when removing the position is not allowed as part of an express checkout. |
actions.basketItemUpdate - Update basket position
The basketItemUpdate action controls the error messages when changing a basket position.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
accountNotVerified | string | Error message output when the customer account has not yet been verified. |
missingBasketItemId | string | Error message output when no basket position ID was supplied. |
missingQuantity | string | Error message output when no order quantity was supplied. |
invalidBasketItemId | string | Error message output when the supplied basket position is invalid or cannot be found. |
invalidQuantity | string | Error message output when the supplied order quantity is invalid. |
invalidProductId | string | Error message output when the supplied product ID is invalid. |
invalidVariantId | string | Error message output when the selected variant is invalid or unavailable. |
insufficientAmount | string | Error message output when there is not enough stock for the requested quantity. |
quantityExceeded | string | Error message output when a defined maximum order quantity is exceeded. |
childProductOnly | string | Error message output when an attempt is made to directly order a product that is only configurable as a “child” product. |
itemNotChangeable | string | Error message output when the basket position in question generally must not be changed. |
internalError | string | Error message output when an unexpected system error occurs. |
invalidChildItem | string | Error message output when an invalid variant is referenced. |
expressCheckoutNotAllowed | string | Error message output when the item may not be added to the basket in express checkout. |
noVariantFound | string | Error message output when no matching product variant can be found for the selected options. |
actions.checkout* - Order process
actions.checkoutAccountTypeSelect - Select account type
Controls the selection between guest order, existing customer and new customer to start the order in checkout.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
missingAccountType | string | Error message output when no account type was selected. |
invalidAccountType | string | Error message output when an invalid or unsupported account type was supplied. |
actions.checkoutBillAddressSelect - Choose billing address
The checkoutBillAddressSelect action controls the error messages when selecting the billing address in checkout.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
missingAddressId | string | Error message output when no address ID was supplied. |
invalidAddressId | string | Error message output when the supplied address ID is invalid or the address could not be found. |
invalidBillAddress | string | Error message output when the address may not be used as a billing address. |
actions.checkoutConfirm - Finalise order
The checkoutConfirm action controls error messages and emails for finalising the order.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
customerEmail | object | Configures the order confirmation email to the customer (including an optional copy to the merchant and attachments). Subject, sender and template are controlled via the general email parameters, see here: Email settings |
paymentFailedEmail | object | Configures the email that can be sent if payment fails. Subject, sender and template are controlled via the general email parameters, see here: Email settings |
errorCodes | object | Configures the error codes used for problems during the action. |
accountNotVerified | string | Error message output when the customer account has not yet been verified. |
invalid | string | Error message output when the order cannot be confirmed. |
requiredCheckboxUnchecked | string | Error message output when a required checkbox has not been checked. |
requiredTextfieldEmpty | string | Error message output when a required input field is empty. |
voucherGenerateError | string | Error message output when an error occurs while generating a voucher. |
clearingFailed | string | Error message output when the payment clearance by the payment service provider fails. |
invalidVoucherId | string | Error message output when the entered voucher code does not exist or is not recognised. |
voucherDeactivated | string | Error message output when the voucher is deactivated and can no longer be redeemed. |
voucherExpired | string | Error message output when the voucher has expired. |
voucherNotYetValid | string | Error message output when the voucher is not yet valid until a later point in time. |
voucherValueSpent | string | Error message output when the voucher has already been fully redeemed. |
voucherInsuffientAmount | string | Error message output when the voucher amount is not sufficient for this order. |
voucherCurrencyMismatch | string | Error message output when the voucher was issued for a different currency than the one used in the current basket. |
voucherInvalidCustomer | string | Error message output when the voucher is tied to a different customer. |
voucherInvalidSubshop | string | Error message output when the voucher is not valid in the current subshop. |
checkoutCompletedError | string | Error message output when the checkout has already been completed and cannot be executed again. |
itemsExpired | string | Error message output when the item in the basket is no longer available. |
expiredReservation | string | Error message output when a previously created basket reservation has expired. |
guestAccountsDisabled | string | Error message output when guest orders are disabled and a customer wants to order without an account. |
actions.checkoutPaymentUpdate - Change payment method
The checkoutPaymentUpdate action controls the error messages when changing the payment method in checkout.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
missingPaymentId | string | Error message output when no payment method was selected. |
inactivePayment | string | Error message output when the selected payment method is disabled in the shop. |
invalidPaymentId | string | Error message output when the supplied payment ID is invalid or the payment method could not be found. |
expressCheckoutNotAllowed | string | Error message output when changing the payment method is not allowed in express checkout. |
actions.checkoutPseudoCCSelect - Choose credit card
The checkoutPseudoCCSelect action controls the error messages when selecting a stored credit card in checkout.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
notLoggedIn | string | Error message output when a non-signed-in user tries to use a stored credit card. |
missingPseudoId | string | Error message output when no card reference (pseudo ID) was supplied. |
notAllowed | string | Error message output when the selected credit card may not be used in the current context. |
actions.checkoutSetFreeFields - Free text fields in checkout
The checkoutSetFreeFields action controls the error messages for validating free text fields in checkout.
Example configuration actions.checkoutSetFreeFields
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
textfieldCheckFailed | string | Error message output when the validation of one or more free text fields fails (e.g. required field empty). |
actions.checkoutSetGuestEmail - Guest order
The checkoutSetGuestEmail action controls the error messages when entering the email address for a guest order.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
missingGuestEmail | string | Error message output when no email address was entered. |
invalidGuestEmail | string | Error message output when the supplied email address does not meet the expected format. |
guestEmailAlreadyUsed | string | Error message output when the email address is already associated with a registered customer account. |
actions.checkoutShippingAddressSelect - Choose delivery address
The checkoutShippingAddressSelect action controls the error messages when selecting the delivery address in checkout.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
missingAddressId | string | Error message output when no address ID was supplied. |
invalidAddressId | string | Error message output when the supplied address ID is invalid or the address cannot be found. |
expressCheckoutNotAllowed | string | Error message output when selecting/changing the delivery address is not allowed in express checkout. |
invalidShippingAddress | string | Error message output when the selected address may not be used as a delivery address. |
actions.checkoutShippingMethodUpdate - Choose / change shipping method
The checkoutShippingMethodUpdate action controls the error messages when changing the shipping method in checkout.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
missingShippingMethodId | string | Error message output when no shipping method was selected or no shipping method ID was supplied. |
inactiveShippingMethodId | string | Error message output when the selected shipping method is disabled in the shop or temporarily unavailable. |
invalidShippingMethodId | string | Error message output when the supplied shipping method ID is invalid or the shipping method cannot be found. |
reservationFailed | string | Error message output when a required reservation for the shipping method fails. |
actions.guestRegister - Registration after guest order
The guestRegister action controls the error messages and emails when creating a full customer account from a guest order.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
verifyEmail | object | Configures the email through which the former guest customer can confirm their registration or email address. Subject, sender and template are controlled via the general email parameters, see here: Email settings |
errorCodes | object | Configures the error codes used for problems during the action. |
nonGuestAccount | string | Error message output when an attempt is made to register an account that is not a guest account. |
duplicateEmail | string | Error message output when a customer account already exists for the supplied email address. |
missingEmail | string | Error message output when no email address is supplied. |
missingPassword | string | Error message output when no password for the new customer account is supplied. |
passwordMismatch | string | Error message output when the password and password confirmation do not match. |
passwordCheckFailed | string | Error message output when the chosen password does not meet the password rules. |
createError | string | Error message output when the customer account could not be technically created. |
actions.directOrder - Direct order
The directOrder action controls the error messages for direct orders by item number.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
invalidId | string | Error message output when the entered item/order number is invalid or no matching item can be found. |
missingId | string | Error message output when no item/order number has been entered. |
invalidQuantity | string | Error message output when the supplied quantity is invalid. |
missingQuantity | string | Error message output when no order quantity has been supplied. |
productHasNoVariants | string | Error message output when the selected item does not have any variants although a variant was expected. |
variantDoesNotExist | string | Error message output when the supplied variant does not exist. |
baseProductCanNotBeChosen | string | Error message output when the base product cannot be selected directly and a variant must be chosen instead. |
actions.voucher* - Voucher
actions.voucherAdd - Redeem / add voucher
The voucherAdd action controls the error messages when adding a voucher to the basket.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
missingId | string | Error message output when no voucher code has been entered. |
duplicateId | string | Error message output when the same voucher code is already stored in the basket. |
invalidVoucherId | string | Error message output when the voucher code is invalid or no voucher can be found. |
deactivated | string | Error message output when the voucher has been deactivated in the system. |
expired | string | Error message output when the validity period of the voucher has expired. |
notYetValid | string | Error message output when the voucher is not yet valid until a later point in time. |
maxCountExceeded | string | Error message output when the maximum number of allowed redemptions has been exceeded. |
valueSpent | string | Error message output when the voucher has already been fully redeemed and no remaining value is available. |
insuffientAmount | string | Error message output when the voucher value is not sufficient for the current order. |
currencyMismatch | string | Error message output when the voucher was issued for a different currency than the one used in the current basket. |
invalidCustomer | string | Error message output when the voucher is tied to a customer other than the currently signed-in one. |
invalidSubshop | string | Error message output when the voucher may not be redeemed in the current subshop/shop. |
actions.voucherDelete - Delete voucher
The voucherDelete action controls the error messages when removing a voucher from the basket.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
invalidVoucherId | string | Error message output when the supplied voucher cannot be found in the basket or cannot be assigned. |
actions.inventoryReserve - Reservation in the basket
The inventoryReserve action controls the error messages when reserving stock for basket positions.
Example configuration
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | object | Configures the error codes used for problems during the action. |
missingBasketItemId | string | Error message output when no basket position ID was supplied. |
invalidBasketItemId | string | Error message output when the supplied basket position is invalid or cannot be found. |
noReservationFound | string | Error message output when no matching reservation can be found or created. |
insufficientAmount | string | Error message output when not enough stock is available for the requested quantity. |
inventoryInactive | string | Error message output when stock management or the reservation function is disabled in the system. |
setChildReserveActionInvalid | string | Error message output when no reservation is allowed for a set / child position in the requested form. |
