actions - Basket & checkout - WEBSALE Dokumentation

This page contains all actions that are executed during the order process in the shop.
Here you will find the associated messages and email templates used when adding, removing or updating items as well as when completing an order or during guest registrations.

**Fehlertexte sind schreibgeschützt.** Die Fehlercode-Felder auf dieser Seite enthalten den Namen eines Textbausteins (ws.error.<configId>.<errorCode>), nicht den Fehlertext. Gepflegt wird der Text ausschließlich im Textbaustein-Dienst des Admin-Interface – Änderungen an der Konfiguration werden beim Speichern abgewiesen, auch über die [REST API](/schnittstellen/admin-interface-api/api-referenz-konfiguration). E-Mail-Vorlagen sind nicht betroffen.

Overview of actions

The actions listed here have been 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

{
    "actions": {
      ...
      "basketItemAdd": {...},
      "basketItemDelete": {...},
      "basketItemUpdate": {...},
      "checkoutAccountTypeSelect": {...},
      "checkoutBillAddressSelect": {...},
      "checkoutConfirm": {...},
      "checkoutPaymentUpdate": {...},
      "checkoutPseudoCCSelect": {...},
      "checkoutSetFreeFields": {...},
      "checkoutSetGuestEmail": {...},
      "checkoutShippingAddressSelect": {...},
      "checkoutShippingMethodUpdate": {...},
      "checkoutUseDifferentShippingAddress": {...},
      "guestRegister": {...},
      "directOrder": {...},
      "voucherAdd": {...},
      "voucherDelete": {...},
      "inventoryReserve": {...},
      ...
    }
}

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 line.
`checkoutAccountTypeSelect`	Defines error messages for the selection of the account type in the checkout.
`checkoutBillAddressSelect`	Defines error messages when selecting the invoice address in the checkout.
`checkoutConfirm`	Defines emails and error messages for the order completion.
`checkoutPaymentUpdate`	Defines error messages when changing the payment method in the checkout.
`checkoutPseudoCCSelect`	Defines error messages when selecting a stored (pseudo) credit card in the checkout.
`checkoutSetFreeFields`	Defines error messages when validating free-text fields in the checkout.
`checkoutSetGuestEmail`	Defines error messages when entering the email address for a guest order.
`checkoutShippingAddressSelect`	Defines the error messages when selecting the shipping address in the checkout.
`checkoutShippingMethodUpdate`	Defines error messages when changing the shipping method in the 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 lines.

`actions.basketItem*` - Basket line

`actions.basketItemAdd` - Add basket line

The basketItemAdd action controls the error messages when adding an item to the basket.

Example configuration

{
  "errorCodes": {
    "accountNotVerified": "<Textbaustein>",
    "basketLocked": "<Textbaustein>",
    "missingProductId": "<Textbaustein>",
    "missingQuantity": "<Textbaustein>",
    "invalidQuantity": "<Textbaustein>",
    "invalidProductId": "<Textbaustein>",
    "invalidVariantId": "<Textbaustein>",
    "insufficientAmount": "<Textbaustein>",
    "quantityExceeded": "<Textbaustein>",
    "childProductOnly": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>",
    "noVariantFound": "<Textbaustein>",
    "invalidStore": "<Textbaustein>"
  }
}

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. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`basketLocked`	string	Error message output when the basket is locked and cannot currently be changed (for example, during an ongoing express checkout). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`missingProductId`	string	Error message output when no product ID was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`missingQuantity`	string	Error message output when no order quantity was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidQuantity`	string	Error message output when the supplied order quantity is invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidProductId`	string	Error message output when the supplied product ID is invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidVariantId`	string	Error message output when the selected variant is invalid or not available. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`insufficientAmount`	string	Error message output when there is not enough stock available for the requested quantity. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`quantityExceeded`	string	Error message output when a defined maximum order quantity is exceeded. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`childProductOnly`	string	Error message output when an attempt is made to order a product directly that can only be configured as a “child” product. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`expressCheckoutNotAllowed`	string	Error message output when the item may not be added to the basket in the express checkout. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`noVariantFound`	string	Error message output when no matching product variant is found for the selected options. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidStore`	string	Error message output when the selected pickup location is invalid or not available for the item. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.basketItemDelete` - Delete basket line

The basketItemDelete action controls the error messages when removing an item from the basket.

Example configuration

{
  "errorCodes": {
    "accountNotVerified": "<Textbaustein>",
    "basketLocked": "<Textbaustein>",
    "missingBasketItemId": "<Textbaustein>",
    "invalidBasketItemId": "<Textbaustein>",
    "basketItemIsSetChild": "<Textbaustein>",
    "itemNotRemovable": "<Textbaustein>",
    "internalError": "<Textbaustein>",
    "invalidChildItem": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>"
  }
}

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. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`basketLocked`	string	Error message output when the basket is locked and cannot currently be changed (for example, during an ongoing express checkout). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`missingBasketItemId`	string	Error message output when no basket line ID was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidBasketItemId`	string	Error message output when the supplied basket line is invalid or cannot be found. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`basketItemIsSetChild`	string	Error message output when an attempt is made to remove a variant that may only be removed via the main product. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`itemNotRemovable`	string	Error message output when the line in question generally may not be removed. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`internalError`	string	Error message output when an unexpected system error occurs. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidChildItem`	string	Error message output when an invalid variant is referenced. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`expressCheckoutNotAllowed`	string	Error message output when removing the line is not allowed during an express checkout. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.basketItemUpdate` - Change basket line

The basketItemUpdate action controls the error messages when changing a basket line.

Example configuration

{
  "errorCodes": {
    "accountNotVerified": "<Textbaustein>",
    "basketLocked": "<Textbaustein>",
    "missingBasketItemId": "<Textbaustein>",
    "missingQuantity": "<Textbaustein>",
    "invalidBasketItemId": "<Textbaustein>",
    "invalidQuantity": "<Textbaustein>",
    "invalidProductId": "<Textbaustein>",
    "invalidVariantId": "<Textbaustein>",
    "insufficientAmount": "<Textbaustein>",
    "quantityExceeded": "<Textbaustein>",
    "childProductOnly": "<Textbaustein>",
    "itemNotChangeable": "<Textbaustein>",
    "internalError": "<Textbaustein>",
    "invalidChildItem": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>",
    "noVariantFound": "<Textbaustein>"
  }
}

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. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`basketLocked`	string	Error message output when the basket is locked and cannot currently be changed (for example, during an ongoing express checkout). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`missingBasketItemId`	string	Error message output when no basket line ID was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`missingQuantity`	string	Error message output when no order quantity was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidBasketItemId`	string	Error message output when the supplied basket line is invalid or cannot be found. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidQuantity`	string	Error message output when the supplied order quantity is invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidProductId`	string	Error message output when the supplied product ID is invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidVariantId`	string	Error message output when the selected variant is invalid or not available. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`insufficientAmount`	string	Error message output when there is not enough stock available for the requested quantity. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`quantityExceeded`	string	Error message output when a defined maximum order quantity is exceeded. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`childProductOnly`	string	Error message output when an attempt is made to order a product directly that can only be configured as a “child” product. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`itemNotChangeable`	string	Error message output when the basket line in question generally may not be changed. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`internalError`	string	Error message output when an unexpected system error occurs. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidChildItem`	string	Error message output when an invalid variant is referenced. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`expressCheckoutNotAllowed`	string	Error message output when the item may not be added to the basket in the express checkout. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`noVariantFound`	string	Error message output when no matching product variant is found for the selected options. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.checkout*` - Order flow

`actions.checkoutAccountTypeSelect` - Select account type

Controls the selection between guest order, existing customer and new customer when starting the order in the checkout.

Example configuration

{
  "errorCodes": {
    "missingAccountType": "<Textbaustein>",
    "invalidAccountType": "<Textbaustein>"
  }
}

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. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidAccountType`	string	Error message output when an invalid or unsupported account type was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.checkoutBillAddressSelect` - Choose invoice address

The checkoutBillAddressSelect action controls the error messages when selecting the invoice address in the checkout.

Example configuration

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

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. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidAddressId`	string	Error message output when the supplied address ID is invalid or the address could not be found. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidBillAddress`	string	Error message output when the address may not be used as an invoice address. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.checkoutConfirm` - Complete order

The checkoutConfirm action controls error messages and emails for the order completion.

Example configuration

{
  "customerEmail": {
    "template": "order_confirmation_customer.htm",
    "subject": "Ihre Bestellung bei Mein Onlineshop",
    "fromAddress": "noreply@meinshop.de",
    "fromName": "Mein Onlineshop",
    "merchantEmail": "bestellungen@meinshop.de",
    "attachments": [
      {
        "name": "AGB.pdf",
        "file": "/files/agb.pdf"
      }
    ]
  },
  "paymentFailedEmail": {
    "template": "order_payment_failed.htm",
    "subject": "Zahlung Ihrer Bestellung fehlgeschlagen",
    "fromAddress": "noreply@meinshop.de",
    "fromName": "Mein Onlineshop",
    "merchantEmail": "zahlung@meinshop.de"
  },
  "errorCodes": {
    "accountNotVerified": "<Textbaustein>",
    "invalid": "<Textbaustein>",
    "productsNotAvailableForOrder": "<Textbaustein>",
    "requiredCheckboxUnchecked": "<Textbaustein>",
    "requiredTextfieldEmpty": "<Textbaustein>",
    "itemsExpired": "<Textbaustein>",
    "expiredReservation": "<Textbaustein>",
    "guestAccountsDisabled": "<Textbaustein>",
    "inExpressCheckout": "<Textbaustein>",
    "paymentBlocked": "<Textbaustein>",
    "captchaFailed": "<Textbaustein>",
    "clearingFailed": "<Textbaustein>",
    "orderCreationFailed": "<Textbaustein>",
    "checkoutCompletedError": "<Textbaustein>",
    "simulateFailedPayment": "<Textbaustein>",
    "noPermission": "<Textbaustein>",
    "personalLimitExceeded": "<Textbaustein>",
    "paymentLimitExceeded": "<Textbaustein>",
    "basketNotVerified": "<Textbaustein>",
    "voucherGenerateError": "<Textbaustein>",
    "invalidVoucherId": "<Textbaustein>",
    "voucherDeactivated": "<Textbaustein>",
    "voucherExpired": "<Textbaustein>",
    "voucherNotYetValid": "<Textbaustein>",
    "voucherValueSpent": "<Textbaustein>",
    "voucherInsuffientAmount": "<Textbaustein>",
    "voucherCurrencyMismatch": "<Textbaustein>",
    "voucherInvalidCustomer": "<Textbaustein>",
    "voucherInvalidSubshop": "<Textbaustein>",
    "voucherIneffective": "<Textbaustein>",
    "voucherRepoUpdateFailed": "<Textbaustein>",
    "voucherInvalidVoucherConfiguration": "<Textbaustein>"
  }
}

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
`customerEmail.merchantEmail`	string	Optional merchant address to which the order confirmation email is additionally sent as a blind copy (BCC).
`customerEmail.attachments`	array (object)	List of file attachments added to the order confirmation email (for example, terms and conditions as a PDF). For each attachment, `name` (displayed file name) and `file` (path to the file in the shop) must be specified. See also Email settings.
`paymentFailedEmail`	object	Configures the email that can be sent when a 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. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalid`	string	Error message output when the order cannot be confirmed. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`productsNotAvailableForOrder`	string	Error message output when at least one item in the basket is no longer orderable. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`requiredCheckboxUnchecked`	string	Error message output when a required checkbox was not selected. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`requiredTextfieldEmpty`	string	Error message output when an input field marked as required is empty. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`itemsExpired`	string	Error message output when the item in the basket is no longer available. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`expiredReservation`	string	Error message output when a previously created basket reservation has expired. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`guestAccountsDisabled`	string	Error message output when guest orders are disabled and a customer wants to order without an account. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`inExpressCheckout`	string	Error message output when the regular order completion is not allowed during an ongoing express checkout. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`paymentBlocked`	string	Error message output when the payment is blocked due to a lock (for example, IP or session lock). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`captchaFailed`	string	Error message output when the captcha check fails at order completion. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`clearingFailed`	string	Error message output when payment clearing by the payment service provider fails. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`orderCreationFailed`	string	Error message output when the order could not be created technically. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`checkoutCompletedError`	string	Error message output when the checkout has already been completed and cannot be executed again. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`simulateFailedPayment`	string	Error message output when a failed payment is simulated in test mode. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`noPermission`	string	Error message output when the (sub-)account does not have permission to place orders. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`personalLimitExceeded`	string	Error message output when the personal payment limit per order would be exceeded. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`paymentLimitExceeded`	string	Error message output when the total payment limit stored for the account would be exceeded by the order. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`basketNotVerified`	string	Error message output when the basket (in a B2B context) has not yet been approved/verified and therefore cannot be ordered. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`voucherGenerateError`	string	Error message output when an error occurs while generating a voucher. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidVoucherId`	string	Error message output when the entered voucher code does not exist or is not recognized. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`voucherDeactivated`	string	Error message output when the voucher is deactivated and can no longer be redeemed. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`voucherExpired`	string	Error message output when the voucher has expired. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`voucherNotYetValid`	string	Error message output when the voucher is not valid until a later date. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`voucherValueSpent`	string	Error message output when the voucher has already been fully spent. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`voucherInsuffientAmount`	string	Error message output when the voucher amount is not sufficient for this order. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`voucherCurrencyMismatch`	string	Error message output when the voucher was issued for a different currency than the one used in the current basket. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`voucherInvalidCustomer`	string	Error message output when the voucher is bound to a different customer. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`voucherInvalidSubshop`	string	Error message output when the voucher is not valid in the current sub-shop. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`voucherIneffective`	string	Error message output when a stored voucher has no effect on this order and therefore blocks the order. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`voucherRepoUpdateFailed`	string	Error message output when the voucher status could not be updated technically during redemption. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`voucherInvalidVoucherConfiguration`	string	Error message output when the voucher configuration is invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.checkoutPaymentUpdate` - Change payment method

The checkoutPaymentUpdate action controls the error messages when changing the payment method in the checkout.

Example configuration

{
  "errorCodes": {
    "missingPaymentId": "<Textbaustein>",
    "inactivePayment": "<Textbaustein>",
    "invalidPaymentId": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>"
  }
}

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. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`inactivePayment`	string	Error message output when the selected payment method is disabled in the shop. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidPaymentId`	string	Error message output when the supplied payment ID is invalid or the payment method was not found. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`expressCheckoutNotAllowed`	string	Error message output when changing the payment method is not allowed during an express checkout. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.checkoutPseudoCCSelect` - Choose credit card

The checkoutPseudoCCSelect action controls the error messages when selecting a stored credit card in the checkout.

Example configuration

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

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 attempts to use a stored credit card. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`missingPseudoId`	string	Error message output when no card reference (pseudo ID) was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`notAllowed`	string	Error message output when the selected credit card may not be used in the current context. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.checkoutSetFreeFields` - Free-text fields in the checkout

The checkoutSetFreeFields action controls the error messages for validating free-text fields in the checkout.

Example configuration `actions.checkoutSetFreeFields`

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

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`textfieldCheckFailed`	string	Error message output when validation of one or more free-text fields fails (for example, a required field is empty). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.checkoutSetGuestEmail` - Guest order

The checkoutSetGuestEmail action controls the error messages when entering the email address for a guest order.

Example configuration

{
  "errorCodes": {
    "missingGuestEmail": "<Textbaustein>",
    "invalidGuestEmail": "<Textbaustein>",
    "guestEmailAlreadyUsed": "<Textbaustein>"
  }
}

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. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidGuestEmail`	string	Error message output when the supplied email address does not meet the expected format. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`guestEmailAlreadyUsed`	string	Error message output when the email address is already assigned to a registered customer account. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.checkoutShippingAddressSelect` - Choose shipping address

The checkoutShippingAddressSelect action controls the error messages when selecting the shipping address in the checkout.

Example configuration

{
  "errorCodes": {
    "missingAddressId": "<Textbaustein>",
    "invalidAddressId": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>",
    "invalidShippingAddress": "<Textbaustein>"
  }
}

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. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidAddressId`	string	Error message output when the supplied address ID is invalid or the address cannot be found. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`expressCheckoutNotAllowed`	string	Error message output when selecting/changing the shipping address is not allowed during an express checkout. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidShippingAddress`	string	Error message output when the selected address may not be used as a shipping address. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.checkoutShippingMethodUpdate` - Choose / change shipping method

The checkoutShippingMethodUpdate action controls the error messages when changing the shipping method in the checkout.

Example configuration

{
  "errorCodes": {
    "missingShippingMethodId": "<Textbaustein>",
    "inactiveShippingMethodId": "<Textbaustein>",
    "invalidShippingMethodId": "<Textbaustein>",
    "reservationFailed": "<Textbaustein>"
  }
}

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. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`inactiveShippingMethodId`	string	Error message output when the selected shipping method is disabled or temporarily unavailable in the shop. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidShippingMethodId`	string	Error message output when the supplied shipping method ID is invalid or the shipping method cannot be found. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`reservationFailed`	string	Error message output when a required reservation for the shipping method fails. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

The guestRegister action controls the error messages and emails when creating a full customer account from a guest order.

Example configuration

{
  "verifyEmail": {
    "template": "guest_register_verify.htm",
    "subject": "Bitte bestätigen Sie Ihre Registrierung",
    "fromAddress": "noreply@meinshop.de",
    "fromName": "Mein Onlineshop"
  },
  "errorCodes": {
    "nonGuestAccount": "<Textbaustein>",
    "duplicateEmail": "<Textbaustein>",
    "missingEmail": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "passwordMismatch": "<Textbaustein>",
    "passwordCheckFailed": "<Textbaustein>",
    "createError": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`verifyEmail`	object	Configures the email with 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. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`duplicateEmail`	string	Error message output when a customer account already exists for the supplied email address. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`missingEmail`	string	Error message output when no email address is supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`missingPassword`	string	Error message output when no password was supplied for the new customer account. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`passwordMismatch`	string	Error message output when the password and password confirmation do not match. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`passwordCheckFailed`	string	Error message output when the chosen password does not meet the password rules. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`createError`	string	Error message output when the customer account could not be created technically. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.directOrder` - Direct order

The directOrder action controls the error messages for direct orders by item number. With this action, not all errors are reported on the same field. The following mapping applies for output in the template:

Error code	Reported on field
`itemNumberCheckFailed`	on the respective item number field (`name` from `itemNumberFields`)
`missingId`	on the respective item number field if a required field remains empty, otherwise on the `id` field
`invalidId`, `productHasNoVariants`, `variantDoesNotExist`, `baseProductCanNotBeChosen`	`id`
`missingQuantity`, `invalidQuantity`	`quantity`

At most one error is reported per submission. A failed first step aborts the action. The checks run in the following order: first the item number fields in the configured order, then the quantity, and finally the product with the variant.

If a check of the item number fails that is stored in checkout.directOrder per input field under itemNumberFields as itemNumberChecks, the error code is itemNumberCheckFailed. This node has no separate error text for it. Instead, the shop outputs the text of the failed check, for example “The input is too short”. These texts are stored in general.dataCheckerValidationErrors.The following also applies to itemNumberCheckFailed:

The error is reported on the respective input field (name from itemNumberFields, for example firstField), not on the id field.
subCode names the failed service with a prefix, for example dataChecker.minLength.
For the length checks, details additionally contains the configured length (len).

Example configuration

{
  "errorCodes": {
    "invalidId": "<Textbaustein>",
    "missingId": "<Textbaustein>",
    "invalidQuantity": "<Textbaustein>",
    "missingQuantity": "<Textbaustein>",
    "productHasNoVariants": "<Textbaustein>",
    "variantDoesNotExist": "<Textbaustein>",
    "baseProductCanNotBeChosen": "<Textbaustein>"
  }
}

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 is found. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`missingId`	string	Error message output when no item/order number was entered. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidQuantity`	string	Error message output when the supplied quantity is invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`missingQuantity`	string	Error message output when no order quantity was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`productHasNoVariants`	string	Error message output when no variants are available for the chosen item, but a variant was expected. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`variantDoesNotExist`	string	Error message output when the supplied variant does not exist. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`baseProductCanNotBeChosen`	string	Error message output when the base product cannot be chosen directly and a variant must be selected instead. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.voucher*` - Voucher

`actions.voucherAdd` - Redeem / add voucher

The voucherAdd action controls the error messages when adding a voucher to the basket.

Example configuration

{
  "errorCodes": {
    "missingId": "<Textbaustein>",
    "duplicateId": "<Textbaustein>",
    "invalidVoucherId": "<Textbaustein>",
    "deactivated": "<Textbaustein>",
    "expired": "<Textbaustein>",
    "notYetValid": "<Textbaustein>",
    "maxCountExceeded": "<Textbaustein>",
    "valueSpent": "<Textbaustein>",
    "insuffientAmount": "<Textbaustein>",
    "currencyMismatch": "<Textbaustein>",
    "invalidCustomer": "<Textbaustein>",
    "invalidSubshop": "<Textbaustein>",
    "repoUpdateFailed": "<Textbaustein>",
    "invalidVoucherConfiguration": "<Textbaustein>",
    "insufficientMinOrderValue": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>"
  }
}

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 was entered. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`duplicateId`	string	Error message output when the same voucher code is already stored in the basket. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidVoucherId`	string	Error message output when the voucher code is invalid or no voucher can be found. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`deactivated`	string	Error message output when the voucher has been deactivated in the system. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`expired`	string	Error message output when the voucher’s validity period has expired. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`notYetValid`	string	Error message output when the voucher is not valid until a later date. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`maxCountExceeded`	string	Error message output when the maximum number of allowed redemptions has been exceeded. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`valueSpent`	string	Error message output when the voucher has already been fully redeemed and no remaining value is available. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`insuffientAmount`	string	Error message output when the voucher value is not sufficient for the current order. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`currencyMismatch`	string	Error message output when the voucher was issued for a different currency than the one used in the current basket. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidCustomer`	string	Error message output when the voucher is bound to a different customer than the one currently signed in. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidSubshop`	string	Error message output when the voucher may not be redeemed in the current sub-shop. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`repoUpdateFailed`	string	Error message output when the voucher status could not be updated technically during redemption. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidVoucherConfiguration`	string	Error message output when the voucher configuration is invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`insufficientMinOrderValue`	string	Error message output when the minimum order value for redeeming the voucher is not reached. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`expressCheckoutNotAllowed`	string	Error message output when redeeming a voucher is not allowed during an express checkout. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.voucherDelete` - Delete voucher

The voucherDelete action controls the error messages when removing a voucher from the basket.

Example configuration

{
  "errorCodes": {
    "invalidVoucherId": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`invalidVoucherId`	string	Error message output when the specified voucher cannot be found in the basket or cannot be assigned. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`expressCheckoutNotAllowed`	string	Error message output when removing a voucher is not allowed during an express checkout. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

`actions.inventoryReserve` - Reservation in the basket

The inventoryReserve action controls the error messages when reserving stock for basket lines.

Example configuration

{
  "errorCodes": {
    "missingBasketItemId": "<Textbaustein>",
    "invalidBasketItemId": "<Textbaustein>",
    "noReservationFound": "<Textbaustein>",
    "insufficientAmount": "<Textbaustein>",
    "inventoryInactive": "<Textbaustein>",
    "setChildReserveActionInvalid": "<Textbaustein>"
  }
}

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 line ID was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidBasketItemId`	string	Error message output when the supplied basket line is invalid or cannot be found. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`noReservationFound`	string	Error message output when no matching reservation can be found or created. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`insufficientAmount`	string	Error message output when not enough stock is available for the requested quantity. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`inventoryInactive`	string	Error message output when the inventory management or reservation feature is disabled in the system. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`setChildReserveActionInvalid`	string	Error message output when no reservation in the requested form is allowed for a set/child line. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

​Overview of actions

​Excerpt of the basic actions structure

​Action overview

​actions.basketItem* - Basket line

​actions.basketItemAdd - Add basket line

​Example configuration

​Parameter overview

​actions.basketItemDelete - Delete basket line

​Example configuration

​Parameter overview

​actions.basketItemUpdate - Change basket line

​Example configuration

​Parameter overview

​actions.checkout* - Order flow

​actions.checkoutAccountTypeSelect - Select account type

​Example configuration

​Parameter overview

​actions.checkoutBillAddressSelect - Choose invoice address

​Example configuration

​Parameter overview

​actions.checkoutConfirm - Complete order

​Example configuration

​Parameter overview

​actions.checkoutPaymentUpdate - Change payment method

​Example configuration

​Parameter overview

​actions.checkoutPseudoCCSelect - Choose credit card

​Example configuration

​Parameter overview

​actions.checkoutSetFreeFields - Free-text fields in the checkout

​Example configuration actions.checkoutSetFreeFields

​Parameter overview

​actions.checkoutSetGuestEmail - Guest order

​Example configuration

​Parameter overview

​actions.checkoutShippingAddressSelect - Choose shipping address

​Example configuration

​Parameter overview

​actions.checkoutShippingMethodUpdate - Choose / change shipping method

​Example configuration

​Parameter overview

​actions.guestRegister - Sign-up after guest order

​Example configuration

​Parameter overview

​actions.directOrder - Direct order

​Example configuration

​Parameter overview

​actions.voucher* - Voucher

​actions.voucherAdd - Redeem / add voucher

​Example configuration

​Parameter overview

​actions.voucherDelete - Delete voucher

​Example configuration

​Parameter overview

​actions.inventoryReserve - Reservation in the basket

​Example configuration

​Parameter overview

Overview of actions

Excerpt of the basic `actions` structure

Action overview

`actions.basketItem*` - Basket line

`actions.basketItemAdd` - Add basket line

Example configuration

Parameter overview

`actions.basketItemDelete` - Delete basket line

Example configuration

Parameter overview

`actions.basketItemUpdate` - Change basket line

Example configuration

Parameter overview

`actions.checkout*` - Order flow

`actions.checkoutAccountTypeSelect` - Select account type

Example configuration

Parameter overview

`actions.checkoutBillAddressSelect` - Choose invoice address

Example configuration

Parameter overview

`actions.checkoutConfirm` - Complete order

Example configuration

Parameter overview

`actions.checkoutPaymentUpdate` - Change payment method

Example configuration

Parameter overview

`actions.checkoutPseudoCCSelect` - Choose credit card

Example configuration

Parameter overview

`actions.checkoutSetFreeFields` - Free-text fields in the checkout

Example configuration `actions.checkoutSetFreeFields`

Parameter overview

`actions.checkoutSetGuestEmail` - Guest order

Example configuration

Parameter overview

`actions.checkoutShippingAddressSelect` - Choose shipping address

Example configuration

Parameter overview

`actions.checkoutShippingMethodUpdate` - Choose / change shipping method

Example configuration

Parameter overview

`actions.guestRegister` - Sign-up after guest order

Example configuration

Parameter overview

`actions.directOrder` - Direct order

Example configuration

Parameter overview

`actions.voucher*` - Voucher

`actions.voucherAdd` - Redeem / add voucher

Example configuration

Parameter overview

`actions.voucherDelete` - Delete voucher

Example configuration

Parameter overview

`actions.inventoryReserve` - Reservation in the basket

Example configuration

Parameter overview