Skip to main content
This page contains all actions that are performed 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 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

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

Action overview

ActionDescription
basketItemAddDefines error messages when adding an item to the basket.
basketItemDeleteDefines error messages when removing an item from the basket.
basketItemUpdateDefines error messages when changing a basket position.
checkoutAccountTypeSelectDefines error messages for the account type selection in checkout.
checkoutBillAddressSelectDefines error messages when selecting the billing address in checkout.
checkoutConfirmDefines emails and error messages for finalising the order.
checkoutPaymentUpdateDefines error messages when changing the payment method in checkout.
checkoutPseudoCCSelectDefines error messages when selecting a stored (pseudo) credit card in checkout.
checkoutSetFreeFieldsDefines error messages when validating free text fields in checkout.
checkoutSetGuestEmailDefines error messages when entering the email address for a guest order.
checkoutShippingAddressSelectDefines the error messages when selecting the delivery address in checkout.
checkoutShippingMethodUpdateDefines error messages when changing the shipping method in checkout.
guestRegisterDefines emails and error messages for creating a customer account after a guest order.
directOrderDefines error messages for direct orders.
voucherAddDefines error messages when adding a voucher to the basket.
voucherDeleteDefines error messages when removing a voucher from the basket.
inventoryReserveDefines 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

{
  "errorCodes": {
    "accountNotVerified": "<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

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
accountNotVerifiedstringError message output when the customer account has not yet been verified.

missingProductIdstringError message output when no product ID was supplied.

missingQuantitystringError message output when no order quantity was supplied.

invalidQuantitystringError message output when the supplied order quantity is invalid.

invalidProductIdstringError message output when the supplied product ID is invalid.

invalidVariantIdstringError message output when the selected variant is invalid or unavailable.

insufficientAmountstringError message output when there is not enough stock for the requested quantity.

quantityExceededstringError message output when a defined maximum order quantity is exceeded.

childProductOnlystringError message output when an attempt is made to directly order a product that is only configurable as a “child” product.

expressCheckoutNotAllowedstringError message output when the item may not be added to the basket in express checkout.

noVariantFoundstringError message output when no matching product variant can be found for the selected options.

invalidStorestringError 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

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

Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
accountNotVerifiedstringError message output when the customer account has not yet been verified.

missingBasketItemIdstringError message output when no basket position ID was supplied.

invalidBasketItemIdstringError message output when the supplied basket position is invalid or cannot be found.

basketItemIsSetChildstringError message output when an attempt is made to remove a variant that can only be removed via the main product.

itemNotRemovablestringError message output when the position in question generally must not be removed.

internalErrorstringError message output when an unexpected system error occurs.

invalidChildItemstringError message output when an invalid variant is referenced.

expressCheckoutNotAllowedstringError 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

{
  "errorCodes": {
    "accountNotVerified": "<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

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
accountNotVerifiedstringError message output when the customer account has not yet been verified.

missingBasketItemIdstringError message output when no basket position ID was supplied.

missingQuantitystringError message output when no order quantity was supplied.

invalidBasketItemIdstringError message output when the supplied basket position is invalid or cannot be found.

invalidQuantitystringError message output when the supplied order quantity is invalid.

invalidProductIdstringError message output when the supplied product ID is invalid.

invalidVariantIdstringError message output when the selected variant is invalid or unavailable.

insufficientAmountstringError message output when there is not enough stock for the requested quantity.

quantityExceededstringError message output when a defined maximum order quantity is exceeded.

childProductOnlystringError message output when an attempt is made to directly order a product that is only configurable as a “child” product.

itemNotChangeablestringError message output when the basket position in question generally must not be changed.

internalErrorstringError message output when an unexpected system error occurs.

invalidChildItemstringError message output when an invalid variant is referenced.

expressCheckoutNotAllowedstringError message output when the item may not be added to the basket in express checkout.

noVariantFoundstringError 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

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

Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
missingAccountTypestringError message output when no account type was selected.

invalidAccountTypestringError 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

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

Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
missingAddressIdstringError message output when no address ID was supplied.

invalidAddressIdstringError message output when the supplied address ID is invalid or the address could not be found.

invalidBillAddressstringError 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

{
  "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>",
    "requiredCheckboxUnchecked": "<Textbaustein>",
    "requiredTextfieldEmpty": "<Textbaustein>",
    "voucherGenerateError": "<Textbaustein>",
    "clearingFailed": "<Textbaustein>",
    "invalidVoucherId": "<Textbaustein>",
    "voucherDeactivated": "<Textbaustein>",
    "voucherExpired": "<Textbaustein>",
    "voucherNotYetValid": "<Textbaustein>",
    "voucherValueSpent": "<Textbaustein>",
    "voucherInsuffientAmount": "<Textbaustein>",
    "voucherCurrencyMismatch": "<Textbaustein>",
    "voucherInvalidCustomer": "<Textbaustein>",
    "voucherInvalidSubshop": "<Textbaustein>",
    "checkoutCompletedError": "<Textbaustein>",
    "itemsExpired": "<Textbaustein>",
    "expiredReservation": "<Textbaustein>",
    "guestAccountsDisabled": "<Textbaustein>"
  }
}

Parameter overview

ParameterTypeDescription
customerEmailobjectConfigures 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
paymentFailedEmailobjectConfigures the email that can be sent if payment fails.
Subject, sender and template are controlled via the general email parameters, see here: Email settings
errorCodesobjectConfigures the error codes used for problems during the action.
accountNotVerifiedstringError message output when the customer account has not yet been verified.

invalidstringError message output when the order cannot be confirmed.

requiredCheckboxUncheckedstringError message output when a required checkbox has not been checked.

requiredTextfieldEmptystringError message output when a required input field is empty.

voucherGenerateErrorstringError message output when an error occurs while generating a voucher.

clearingFailedstringError message output when the payment clearance by the payment service provider fails.

invalidVoucherIdstringError message output when the entered voucher code does not exist or is not recognised.

voucherDeactivatedstringError message output when the voucher is deactivated and can no longer be redeemed.

voucherExpiredstringError message output when the voucher has expired.

voucherNotYetValidstringError message output when the voucher is not yet valid until a later point in time.

voucherValueSpentstringError message output when the voucher has already been fully redeemed.

voucherInsuffientAmountstringError message output when the voucher amount is not sufficient for this order.

voucherCurrencyMismatchstringError message output when the voucher was issued for a different currency than the one used in the current basket.

voucherInvalidCustomerstringError message output when the voucher is tied to a different customer.

voucherInvalidSubshopstringError message output when the voucher is not valid in the current subshop.

checkoutCompletedErrorstringError message output when the checkout has already been completed and cannot be executed again.

itemsExpiredstringError message output when the item in the basket is no longer available.

expiredReservationstringError message output when a previously created basket reservation has expired.

guestAccountsDisabledstringError 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

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

Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
missingPaymentIdstringError message output when no payment method was selected.

inactivePaymentstringError message output when the selected payment method is disabled in the shop.

invalidPaymentIdstringError message output when the supplied payment ID is invalid or the payment method could not be found.

expressCheckoutNotAllowedstringError 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

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

Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
notLoggedInstringError message output when a non-signed-in user tries to use a stored credit card.

missingPseudoIdstringError message output when no card reference (pseudo ID) was supplied.

notAllowedstringError 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

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

Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
textfieldCheckFailedstringError 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

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

Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
missingGuestEmailstringError message output when no email address was entered.

invalidGuestEmailstringError message output when the supplied email address does not meet the expected format.

guestEmailAlreadyUsedstringError 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

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

Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
missingAddressIdstringError message output when no address ID was supplied.

invalidAddressIdstringError message output when the supplied address ID is invalid or the address cannot be found.

expressCheckoutNotAllowedstringError message output when selecting/changing the delivery address is not allowed in express checkout.

invalidShippingAddressstringError 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

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

Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
missingShippingMethodIdstringError message output when no shipping method was selected or no shipping method ID was supplied.

inactiveShippingMethodIdstringError message output when the selected shipping method is disabled in the shop or temporarily unavailable.

invalidShippingMethodIdstringError message output when the supplied shipping method ID is invalid or the shipping method cannot be found.

reservationFailedstringError 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

{
  "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

ParameterTypeDescription
verifyEmailobjectConfigures 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
errorCodesobjectConfigures the error codes used for problems during the action.
nonGuestAccountstringError message output when an attempt is made to register an account that is not a guest account.

duplicateEmailstringError message output when a customer account already exists for the supplied email address.

missingEmailstringError message output when no email address is supplied.

missingPasswordstringError message output when no password for the new customer account is supplied.

passwordMismatchstringError message output when the password and password confirmation do not match.

passwordCheckFailedstringError message output when the chosen password does not meet the password rules.

createErrorstringError 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

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

Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
invalidIdstringError message output when the entered item/order number is invalid or no matching item can be found.

missingIdstringError message output when no item/order number has been entered.

invalidQuantitystringError message output when the supplied quantity is invalid.

missingQuantitystringError message output when no order quantity has been supplied.

productHasNoVariantsstringError message output when the selected item does not have any variants although a variant was expected.

variantDoesNotExiststringError message output when the supplied variant does not exist.

baseProductCanNotBeChosenstringError 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

{
  "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>"
  }
}

Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
missingIdstringError message output when no voucher code has been entered.

duplicateIdstringError message output when the same voucher code is already stored in the basket.

invalidVoucherIdstringError message output when the voucher code is invalid or no voucher can be found.

deactivatedstringError message output when the voucher has been deactivated in the system.

expiredstringError message output when the validity period of the voucher has expired.

notYetValidstringError message output when the voucher is not yet valid until a later point in time.

maxCountExceededstringError message output when the maximum number of allowed redemptions has been exceeded.

valueSpentstringError message output when the voucher has already been fully redeemed and no remaining value is available.

insuffientAmountstringError message output when the voucher value is not sufficient for the current order.

currencyMismatchstringError message output when the voucher was issued for a different currency than the one used in the current basket.

invalidCustomerstringError message output when the voucher is tied to a customer other than the currently signed-in one.

invalidSubshopstringError 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

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

Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
invalidVoucherIdstringError 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

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

Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
missingBasketItemIdstringError message output when no basket position ID was supplied.

invalidBasketItemIdstringError message output when the supplied basket position is invalid or cannot be found.

noReservationFoundstringError message output when no matching reservation can be found or created.

insufficientAmountstringError message output when not enough stock is available for the requested quantity.

inventoryInactivestringError message output when stock management or the reservation function is disabled in the system.

setChildReserveActionInvalidstringError message output when no reservation is allowed for a set / child position in the requested form.