This includes actions for reviews, watch lists and availability alerts as well as the associated messages and notifications.
**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": {
...
"backInStockActivate": {...},
"backInStockDeactivate": {...},
"productRatingAdd": {...},
"productRatingDelete": {...},
"productRatingUpdate": {...},
"watchListAdd": {...},
"watchListDelete": {...},
"watchListItemAdd": {...},
"watchListItemDelete": {...},
...
}
}
Action overview
| Action | Description |
|---|---|
backInStockActivate | Defines the error messages output for requests to activate an availability notification. |
backInStockDeactivate | Defines the error message output when deactivating an availability notification. |
productRatingAdd | Defines the error messages output when submitting a product review. |
productRatingUpdate | Defines the error messages output when changing a product review. |
productRatingDelete | Defines the error messages output when deleting a product review. |
watchListAdd | Defines the error messages output when creating and using watch lists. |
watchListDelete | Defines the error messages output when deleting a watch list. |
watchListItemAdd | Defines the error messages output when adding products to the watch list. |
watchListItemDelete | Defines the error messages output when removing an item from the watch list. |
actions.backInStock* - Availability alert
actions.backInStockActivate - Activate availability alert
The backInStockActivate action controls error messages for requests to activate an availability notification.
Example configuration
{
"errorCodes": {
"notLoggedIn": "<Textbaustein>",
"missingEmail": "<Textbaustein>",
"missingProductId": "<Textbaustein>",
"invalidStoreId": "<Textbaustein>",
"internError": "<Textbaustein>",
"notAllowed": "<Textbaustein>",
"missingInventoryState": "<Textbaustein>",
"entryExists": "<Textbaustein>"
}
}
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | array | Configures the error codes used for problems during the action. |
notLoggedIn | string | Error message output when the user is not signed in. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingEmail | string | Error message output when no email address was supplied. 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 for which the notification is to be set up. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
invalidStoreId | string | Error message output when an invalid or unknown store/branch ID was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
internError | string | Error message output when an unexpected system error occurs while activating the notification. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
notAllowed | string | Error message output when the action is not allowed. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingInventoryState | string | Error message output when no stock status is available for the product. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
entryExists | string | Error message output when an entry for an availability notification already exists for this item and this customer. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
actions.backInStockDeactivate - Deactivate availability alert
The backInStockDeactivate action controls error messages for requests to deactivate an availability notification.
Example configuration
{
"errorCodes": {
"notLoggedIn": "<Textbaustein>",
"missingEmail": "<Textbaustein>",
"missingProductId": "<Textbaustein>",
"internError": "<Textbaustein>",
"notAllowed": "<Textbaustein>"
}
}
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | array | Configures the error codes used for problems during the action. |
notLoggedIn | string | Error message output when the user is not signed in. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingEmail | string | Error message output when no email address was supplied. 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 for which the notification is to be deactivated. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
internError | string | Error message output when an unexpected system error occurs while deactivating the notification. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
notAllowed | string | Error message output when the action is not allowed. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
actions.productRating* - Product review
actions.productRatingAdd - Rate product
The productRatingAdd action controls error messages when submitting a product review. In addition, merchantEmail can be used to configure an email to the merchant that notifies them about new reviews.
Example configuration
{
"errorCodes": {
"missingProductId": "<Textbaustein>",
"missingOrderId": "<Textbaustein>",
"wrongProductId": "<Textbaustein>",
"wrongOrderId": "<Textbaustein>",
"userMustLoggedIn": "<Textbaustein>",
"invalidPoints": "<Textbaustein>",
"missingPoints": "<Textbaustein>",
"missingSubject": "<Textbaustein>",
"missingDescription": "<Textbaustein>",
"duplicateRating": "<Textbaustein>",
"multiRating": "<Textbaustein>",
"maxLengthSubject": "<Textbaustein>",
"maxLengthDescription": "<Textbaustein>",
"productNotExists": "<Textbaustein>",
"orderNotExists": "<Textbaustein>"
},
"merchantEmail": {
"template": "product_rating_merchant_notify.htm",
"subject": "Neue Produktbewertung im Shop",
"fromAddress": "noreply@meinshop.de",
"fromName": "Mein Onlineshop",
"toAddress": "bewertung@meinshop.de"
}
}
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | array | Configures the error codes used for problems during the action. |
missingProductId | string | Error message output when no product ID was supplied for which a review is to be submitted. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingOrderId | string | Error message output when no order number/order ID was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
wrongProductId | string | Error message output when the rated product does not belong to the specified order. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
wrongOrderId | string | Error message output when the specified order does not match the expected context (e.g. not assigned to the customer). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
userMustLoggedIn | string | Error message output when a non-signed-in user wants to submit a review. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
invalidPoints | string | Error message output when an invalid number of points is supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingPoints | string | Error message output when no point rating was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingSubject | string | Error message output when no title for the review was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingDescription | string | Error message output when no review text was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
duplicateRating | string | Error message output when a review by the same customer already exists for this product. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
multiRating | string | Error message output when multiple reviews were submitted in a disallowed context (e.g. duplicate entries). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
maxLengthSubject | string | Error message output when the maximum character length of the review title was exceeded. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
maxLengthDescription | string | Error message output when the review text exceeds the maximum allowed length. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
productNotExists | string | Error message output when the supplied product ID cannot be found in the system. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
orderNotExists | string | Error message output when the supplied order ID cannot be found in the system. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
merchantEmail | object | Configures the email through which the merchant is notified about a review submitted for their product. Subject, sender and template are controlled via the general email parameters, see here: Email settings |
actions.productRatingDelete - Delete product review
The productRatingDelete action controls error messages when deleting a product review.
Example configuration
{
"errorCodes": {
"missingProductId": "<Textbaustein>",
"missingOrderId": "<Textbaustein>",
"wrongProductId": "<Textbaustein>",
"wrongOrderId": "<Textbaustein>",
"userMustLoggedIn": "<Textbaustein>",
"productNotExists": "<Textbaustein>",
"invalidPoints": "<Textbaustein>",
"missingPoints": "<Textbaustein>",
"missingSubject": "<Textbaustein>",
"missingDescription": "<Textbaustein>",
"duplicateRating": "<Textbaustein>",
"multiRating": "<Textbaustein>",
"maxLengthSubject": "<Textbaustein>",
"maxLengthDescription": "<Textbaustein>"
}
}
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | array | Configures the error codes used for problems during the action. |
missingProductId | string | Error message output when no product ID was supplied for which a review is to be deleted. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingOrderId | string | Error message output when no order number/order ID was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
wrongProductId | string | Error message output when the rated product does not belong to the specified order. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
wrongOrderId | string | Error message output when the specified order does not match the expected context (e.g. not assigned to the customer). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
userMustLoggedIn | string | Error message output when a non-signed-in user wants to delete a review. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
invalidPoints | string | Error message output when an invalid number of points is supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingPoints | string | Error message output when no point rating was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingSubject | string | Error message output when no title for the review was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingDescription | string | Error message output when no review text was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
duplicateRating | string | Error message output when a review by the same customer already exists for this product. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
multiRating | string | Error message output when multiple reviews were deleted in a disallowed context (e.g. duplicate entries). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
maxLengthSubject | string | Error message output when the maximum character length of the review title was exceeded. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
maxLengthDescription | string | Error message output when the review text exceeds the maximum allowed length. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
productNotExists | string | Error message output when the supplied product ID cannot be found in the system. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
actions.productRatingUpdate - Change product review
The productRatingUpdate action controls the error messages for requests to edit an existing product review.
Example configuration actions.productRatingUpdate
{
"errorCodes": {
"missingProductId": "<Textbaustein>",
"missingOrderId": "<Textbaustein>",
"missingSubject": "<Textbaustein>",
"missingDescription": "<Textbaustein>",
"invalidPoints": "<Textbaustein>",
"missingPoints": "<Textbaustein>",
"userMustLoggedIn": "<Textbaustein>",
"productNotExists": "<Textbaustein>",
"duplicateRating": "<Textbaustein>",
"multiRating": "<Textbaustein>",
"maxLengthSubject": "<Textbaustein>",
"maxLengthDescription": "<Textbaustein>"
}
}
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | array | Configures the error codes used for problems during the action. |
missingProductId | string | Error message output when no product ID was supplied for which a review is to be changed. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingOrderId | string | Error message output when no order number/order ID was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
userMustLoggedIn | string | Error message output when a non-signed-in user wants to change a review. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
invalidPoints | string | Error message output when an invalid number of points is supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingPoints | string | Error message output when no point rating was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingSubject | string | Error message output when no title for the review was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingDescription | string | Error message output when no review text was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
duplicateRating | string | Error message output when a review by the same customer already exists for this product. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
multiRating | string | Error message output when multiple reviews were changed in a disallowed context (e.g. duplicate entries). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
maxLengthSubject | string | Error message output when the maximum character length of the review title was exceeded. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
maxLengthDescription | string | Error message output when the review text exceeds the maximum allowed length. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
productNotExists | string | Error message output when the supplied product ID cannot be found in the system. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
actions.watchList* - Watch list
actions.watchListAdd - Create / add watch list
The watchListAdd action controls the error messages when creating and using watch lists.
Example configuration
{
"defaultWatchlist": "Meine Merkliste",
"basketWatchlist": "Aus dem Warenkorb gemerkt",
"errorCodes": {
"missingWatchListName": "<Textbaustein>",
"invalidWatchListName": "<Textbaustein>",
"missingWatchListId": "<Textbaustein>",
"watchListNotFound": "<Textbaustein>",
"notLoggedIn": "<Textbaustein>"
}
}
Parameter overview
| Parameter | Type | Description |
|---|---|---|
defaultWatchlist | string | Display name of the default watch list to which products are added without a specific selection. Default: “ Default Watchlist” |
basketWatchlist | string | Display name of the watch list that can be used for products taken over from the basket. Default: “ Basket Watchlist” |
errorCodes | array | Configures the error codes used for problems during the action. |
missingWatchListName | string | Error message output when no name was supplied for a new or a to-be-renamed watch list. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
invalidWatchListName | string | Error message output when the supplied watch list name is invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingWatchListId | string | Error message output when no watch list ID was supplied although an existing watch list was expected. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
watchListNotFound | string | Error message output when the specified watch list cannot be found in the system. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
notLoggedIn | string | Error message output when a non-signed-in user attempts to add products to the watch list. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
actions.watchListDelete - Delete / remove watch list
The watchListDelete action controls the error messages when deleting a watch list.
Example configuration
{
"errorCodes": {
"missingWatchListName": "<Textbaustein>",
"invalidWatchListName": "<Textbaustein>",
"missingWatchListId": "<Textbaustein>",
"watchListNotFound": "<Textbaustein>",
"notLoggedIn": "<Textbaustein>",
"notChangeable": "<Textbaustein>"
}
}
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | array | Configures the error codes used for problems during the action. |
missingWatchListName | string | Error message output when the supplied watch list name is invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
invalidWatchListName | string | Error message output when the supplied watch list name is invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingWatchListId | string | Error message output when no watch list ID was supplied although an existing watch list was expected. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
watchListNotFound | string | Error message output when the specified watch list cannot be found in the system. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
notLoggedIn | string | Error message output when a non-signed-in user attempts to delete a watch list. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
notChangeable | string | Error message output when the selected watch list cannot be deleted (e.g. the default list). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
actions.watchListItemAdd - Add product to a watch list
The watchListItemAdd action controls the error messages when adding products to the watch list.
Example configuration
{
"errorCodes": {
"missingProductId": "<Textbaustein>",
"invalidProductId": "<Textbaustein>",
"invalidVariantId": "<Textbaustein>",
"invalidService": "<Textbaustein>",
"watchListNotFound": "<Textbaustein>"
}
}
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | array | Configures the error codes used for problems during the action. |
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. |
invalidProductId | string | Error message output when the supplied product ID is invalid or the item could not be found. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
invalidVariantId | string | Error message output when the supplied variant is invalid or not available. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
invalidService | string | Error message output when an invalid or non-applicable additional service was supplied for the item. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
watchListNotFound | string | Error message output when the specified watch list cannot be found in the system. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
actions.watchListItemDelete - Delete product from a watch list
The watchListItemDelete action controls the error messages when removing an item from a watch list.
Example configuration actions.watchListItemDelete
{
"errorCodes": {
"missingItemId": "<Textbaustein>",
"invalidItemId": "<Textbaustein>",
"missingWatchListId": "<Textbaustein>",
"invalidService": "<Textbaustein>",
"watchListNotFound": "<Textbaustein>"
}
}
Parameter overview
| Parameter | Type | Description |
|---|---|---|
errorCodes | array | Configures the error codes used for problems during the action. |
missingItemId | string | Error message output when no item/line ID was supplied (no specific watch list entry selected). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
invalidItemId | string | Error message output when the supplied item ID is invalid or the entry cannot be found. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
missingWatchListId | string | Error message output when no watch list ID was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
invalidService | string | Error message output when an invalid or non-matching service context is used for the watch list entry. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
watchListNotFound | string | Error message output when the referenced watch list does not exist in the system. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier. |
