Zum Hauptinhalt springen
Diese Seite enthält alle Aktionen, die im Zusammenhang mit Produkten stehen.
Hierzu gehören Aktionen für Bewertungen, Merklisten und Verfügbarkeitsalarme sowie die zugehörigen Meldungen und Benachrichtigungen.

​
Übersicht der Aktionen

Die hier aufgeführten Aktionen wurden thematisch gruppiert, um die zugehörigen Fehlermeldungen und E-Mail-Vorlagen übersichtlich darzustellen. Aktionen, die inhaltlich zu einem anderen Themenbereich gehören, finden sich in den entsprechenden Abschnitten dieser Dokumentation oder in der alphabetischen Übersicht der Aktionen.

​
Auszug der Grundstruktur actions

{
    "actions": {
      ...
      "backInStockActivate": {...},
      "backInStockDeactivate": {...},
      "productRatingAdd": {...},
      "productRatingDelete": {...},
      "productRatingUpdate": {...},
      "watchListAdd": {...},
      "watchListDelete": {...},
      "watchListItemAdd": {...},
      "watchListItemDelete": {...},
      ...
    }
}

​
Aktionsübersicht

AktionBeschreibung
backInStockActivateDefiniert die Fehlermeldungen, die bei Anfragen zur Aktivierung einer Verfügbarkeitsbenachrichtigung ausgegeben werden.
backInStockDeactivateDefiniert die Fehlermeldung, die bei Deaktivierung einer Verfügbarkeitsbenachrichtigung ausgegeben werden.
productRatingAddDefiniert die Fehlermeldungen, die beim Abgeben einer Produktbewertung ausgegeben werden.
productRatingUpdateDefiniert die Fehlermeldungen, die beim Ändern einer Produktbewertung ausgegeben werden.
productRatingDeleteDefiniert die Fehlermeldungen, die beim Löschen einer Produktbewertung ausgegeben werden.
watchListAddDefiniert die Fehlermeldungen, die beim Anlegen und verwenden von Merklisten ausgegeben werden.
watchListDeleteDefiniert die Fehlermeldungen, die beim Löschen einer Merkliste ausgegeben werden.
watchListItemAddDefiniert die Fehlermeldungen, die beim Hinzufügen von Produkten zur Merkliste ausgegeben werden.
watchListItemDeleteDefiniert die Fehlermeldungen, die beim Entfernen eines Artikels aus der Merkliste ausgegeben werden.

​
actions.backInStock* - Verfügbarkeitsalarm

​
actions.backInStockActivate - Verfügbarkeitsalarm aktivieren

Mithilfe der Aktion backInStockActivate werden Fehlermeldungen bei Anfragen zur Aktivierung einer Verfügbarkeitsbenachrichtigung gesteuert.

​
Beispielkonfiguration

{
  "errorCodes": {
    "notLoggedIn": "<Textbaustein>",
    "missingEmail": "<Textbaustein>",
    "missingProductId": "<Textbaustein>",
    "invalidStoreId": "<Textbaustein>",
    "internError": "<Textbaustein>",
    "notAllowed": "<Textbaustein>",
    "missingInventoryState": "<Textbaustein>",
    "entryExists": "<Textbaustein>"
  }
}

​
Parameterübersicht

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
notLoggedInstringFehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.

missingEmailstringFehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wurde.

missingProductIdstringFehlermeldung, die ausgegeben wird, wenn keine Produkt-ID angegeben wurde, für die die Benachrichtigung eingerichtet werden soll.

invalidStoreIdstringFehlermeldung, die ausgegeben wird, wenn eine ungültige oder unbekannte Store-/Filial-ID übermittelt wurde.

internErrorstringFehlermeldung, die ausgegeben wird, wenn ein unerwarteter Systemfehler während der Aktivierung der Benachrichtigung auftritt.

notAllowedstringFehlermeldung, die ausgegeben wird, wenn die Aktion nicht erlaubt ist.

missingInventoryStatestringFehlermeldung, die ausgegeben wird, wenn für das Produkt kein Lagerstatus vorliegt.

entryExistsstringFehlermeldung, die ausgegeben wird, wenn bereits ein Eintrag für eine Verfügbarkeitsbenachrichtigung zu diesem Artikel und für diesen Kunden existiert.

​
actions.backInStockDeactivate - Verfügbarkeitsalarm deaktivieren

Mithilfe der Aktion backInStockDeactivate werden Fehlermeldungen für Anfragen zur Deaktivierung einer Verfügbarkeitsbenachrichtigung gesteuert.

​
Beispielkonfiguration

{
  "errorCodes": {
    "notLoggedIn": "<Textbaustein>",
    "missingEmail": "<Textbaustein>",
    "missingProductId": "<Textbaustein>",
    "internError": "<Textbaustein>",
    "notAllowed": "<Textbaustein>"
  }
}

​
Parameterübersicht

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
notLoggedInstringFehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.

missingEmailstringFehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wurde.

missingProductIdstringFehlermeldung, die ausgegeben wird, wenn keine Produkt-ID angegeben wurde, für die die Benachrichtigung deaktiviert werden soll.

internErrorstringFehlermeldung, die ausgegeben wird, wenn ein unerwarteter Systemfehler während der Deaktivierung der Benachrichtigung auftritt.

notAllowedstringFehlermeldung, die ausgegeben wird, wenn die Aktion nicht erlaubt ist.

​
actions.productRating* - Produktbewertung

​
actions.productRatingAdd - Produkt bewerten

Mithilfe der Aktion productRatingAdd werden Fehlermeldungen beim Abgeben einer Produktbewertung gesteuert. Zusätzlich kann über merchantEmail eine E-Mail an den Händler konfiguriert werden, die über neue Bewertungen informiert.

​
Beispielkonfiguration

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

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
missingProductIdstringFehlermeldung, die ausgegeben wird, wenn keine Produkt-ID angegeben wurde, für die eine Bewertung abgegeben werden soll.

missingOrderIdstringFehlermeldung, die ausgegeben wird, wenn keine Bestellnummer/Order-ID angegeben wurde.

wrongProductIdstringFehlermeldung, die ausgegeben wird, wenn das bewertete Produkt nicht zur angegebenen Bestellung gehört.

wrongOrderIdstringFehlermeldung, die ausgegeben wird, wenn die angegebene Bestellung nicht zum erwarteten Kontext passt (z.B. nicht dem Kunden zugeordnet).

userMustLoggedInstringFehlermeldung, die ausgegeben wird, wenn ein nicht angemeldeter Benutzer eine Bewertung abgeben möchte.

invalidPointsstringFehlermeldung, die ausgegeben wird, wenn eine ungültige Punkteanzahl übermittelt wird.

missingPointsstringFehlermeldung, die ausgegeben wird, wenn keine Punktebewertung angegeben wurde.

missingSubjectstringFehlermeldung, die ausgegeben wird, wenn kein Titel für die Bewertung angegeben wurde.

missingDescriptionstringFehlermeldung, die ausgegeben wird, wenn kein Bewertungstext übermittelt wurde.

duplicateRatingstringFehlermeldung, die ausgegeben wird, wenn für dieses Produkt bereits eine Bewertung desselben Kunden existiert.

multiRatingstringFehlermeldung, die ausgegeben wird, wenn mehrere Bewertungen in einem unerlaubten Kontext abgegeben wurden (z.B. doppelte Einträge).

maxLengthSubjectstringFehlermeldung, die ausgegeben wird, wenn beim Titel der Bewertung die maximale Zeichenlänge überschritten wurde.

maxLengthDescriptionstringFehlermeldung, die ausgegeben wird, wenn der Bewertungstext die maximal zulässige Länge überschreitet.

productNotExistsstringFehlermeldung, die ausgegeben wird, wenn die übermittelte Produkt-ID im System nicht gefunden wird.

orderNotExistsstringFehlermeldung, die ausgegeben wird, wenn die übermittelte Order-ID im System nicht gefunden wird.

merchantEmailobjectKonfiguriert die E-Mail, über die der Händler über eine abgegebene Bewertung zu seinem Produkt informiert wird.
Betreff, Absender und Template werden über die allgemeinen E-Mail-Parameter gesteuert, siehe hier: E-Mail Einstellungen

​
actions.productRatingDelete - Produktbewertung löschen

Mithilfe der Aktion productRatingDelete werden Fehlermeldungen beim Löschen einer Produktbewertung gesteuert.

​
Beispielkonfiguration

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

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
missingProductIdstringFehlermeldung, die ausgegeben wird, wenn keine Produkt-ID angegeben wurde, für die eine Bewertung gelöscht werden soll.

missingOrderIdstringFehlermeldung, die ausgegeben wird, wenn keine Bestellnummer/Order-ID angegeben wurde.

wrongProductIdstringFehlermeldung, die ausgegeben wird, wenn das bewertete Produkt nicht zur angegebenen Bestellung gehört.

wrongOrderIdstringFehlermeldung, die ausgegeben wird, wenn die angegebene Bestellung nicht zum erwarteten Kontext passt (z.B. nicht dem Kunden zugeordnet).

userMustLoggedInstringFehlermeldung, die ausgegeben wird, wenn ein nicht angemeldeter Benutzer eine Bewertung löschen möchte.

invalidPointsstringFehlermeldung, die ausgegeben wird, wenn eine ungültige Punktezahl übermittelt wird.

missingPointsstringFehlermeldung, die ausgegeben wird, wenn keine Punktebewertung angegeben wurde.

missingSubjectstringFehlermeldung, die ausgegeben wird, wenn kein Titel für die Bewertung angegeben wurde.

missingDescriptionstringFehlermeldung, die ausgegeben wird, wenn kein Bewertungstext übermittelt wurde.

duplicateRatingstringFehlermeldung, die ausgegeben wird, wenn für dieses Produkt bereits eine Bewertung desselben Kunden existiert.

multiRatingstringFehlermeldung, die ausgegeben wird, wenn mehrere Bewertungen in einem unerlaubten Kontext gelöscht wurden (z.B. doppelte Einträge).

maxLengthSubjectstringFehlermeldung, die ausgegeben wird, wenn beim Titel der Bewertung die maximale Zeichenlänge überschritten wurde.

maxLengthDescriptionstringFehlermeldung, die ausgegeben wird, wenn der Bewertungstext die maximal zulässige Länge überschreitet.

productNotExistsstringFehlermeldung, die ausgegeben wird, wenn die übermittelte Produkt-ID im System nicht gefunden wird.

​
actions.productRatingUpdate - Produktbewertung ändern

Mithilfe der Aktion productRatingUpdate werden die Fehlermeldungen für Anfragen zur Bearbeitung einer bestehenden Produktbewertung gesteuert.

​
Beispielkonfiguration 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übersicht

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
missingProductIdstringFehlermeldung, die ausgegeben wird, wenn keine Produkt-ID angegeben wurde, für die eine Bewertung geändert werden soll.

missingOrderIdstringFehlermeldung, die ausgegeben wird, wenn keine Bestellnummer/Order-ID angegeben wurde.

userMustLoggedInstringFehlermeldung, die ausgegeben wird, wenn ein nicht angemeldeter Benutzer eine Bewertung ändern möchte.

invalidPointsstringFehlermeldung, die ausgegeben wird, wenn eine ungültige Punkteanzahl übermittelt wird.

missingPointsstringFehlermeldung, die ausgegeben wird, wenn keine Punktebewertung angegeben wurde.

missingSubjectstringFehlermeldung, die ausgegeben wird, wenn kein Titel für die Bewertung angegeben wurde.

missingDescriptionstringFehlermeldung, die ausgegeben wird, wenn kein Bewertungstext übermittelt wurde.

duplicateRatingstringFehlermeldung, die ausgegeben wird, wenn für dieses Produkt bereits eine Bewertung desselben Kunden existiert.

multiRatingstringFehlermeldung, die ausgegeben wird, wenn mehrere Bewertungen in einem unerlaubten Kontext geändert wurden (z.B. doppelte Einträge).

maxLengthSubjectstringFehlermeldung, die ausgegeben wird, wenn beim Titel der Bewertung die maximale Zeichenlänge überschritten wurde.

maxLengthDescriptionstringFehlermeldung, die ausgegeben wird, wenn der Bewertungstext die maximal zulässige Länge überschreitet.

productNotExistsstringFehlermeldung, die ausgegeben wird, wenn die übermittelte Produkt-ID im System nicht gefunden wird.

​
actions.watchList* - Merkliste

​
actions.watchListAdd - Merkliste anlegen / hinzufügen

Mithilfe der Aktion watchListAdd werden die Fehlermeldungen beim Anlegen und Verwenden von Merklisten gesteuert.

​
Beispielkonfiguration

{
  "defaultWatchlist": "Meine Merkliste",
  "basketWatchlist": "Aus dem Warenkorb gemerkt",
  "errorCodes": {
    "missingWatchListName": "<Textbaustein>",
    "invalidWatchListName": "<Textbaustein>",
    "missingWatchListId": "<Textbaustein>",
    "watchListNotFound": "<Textbaustein>",
    "notLoggedIn": "<Textbaustein>"
  }
}

​
Parameterübersicht

ParameterTypBeschreibung
defaultWatchliststringAnzeigename der Standard-Merkliste, zu der Produkte ohne spezielle Auswahl hinzugefügt werden.
Default: “Default Watchlist”
basketWatchliststringAnzeigename der Merkliste, die für aus dem Warenkorb übernommene Produkte verwendet werden kann.
Default: “Basket Watchlist”
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
missingWatchListNamestringFehlermeldung, die ausgegeben wird, wenn kein Name für eine neue oder umzubenennende Merkliste übermittelt wurde.

invalidWatchListNamestringFehlermeldung, die ausgegeben wird, wenn der angegebene Merklistenname ungültig ist.

missingWatchListIdstringFehlermeldung, die ausgegeben wird, wenn keine Merklisten-ID übermittelt wurde, obwohl eine bestehende Merkliste erwartet wurde.

watchListNotFoundstringFehlermeldung, die ausgegeben wird, wenn die angegebene Merkliste im System nicht gefunden werden kann.

notLoggedInstringFehlermeldung, die ausgegeben wird, wenn ein nicht angemeldeter Benutzer versucht, Produkte zur Merkliste hinzuzufügen.

​
actions.watchListDelete - Merkliste löschen / entfernen

Mithilfe der Aktion watchListDelete werden die Fehlermeldungen beim Löschen einer Merkliste gesteuert.

​
Beispielkonfiguration

{
  "errorCodes": {
    "missingWatchListName": "<Textbaustein>",
    "invalidWatchListName": "<Textbaustein>",
    "missingWatchListId": "<Textbaustein>",
    "watchListNotFound": "<Textbaustein>",
    "notLoggedIn": "<Textbaustein>",
    "notChangeable": "<Textbaustein>"
  }
}

​
Parameterübersicht

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
missingWatchListNamestringFehlermeldung, die ausgegeben wird, wenn der angegebene Merklistenname ungültig ist.

invalidWatchListNamestringFehlermeldung, die ausgegeben wird, wenn der angegebene Merklistenname ungültig ist.

missingWatchListIdstringFehlermeldung, die ausgegeben wird, wenn keine Merklisten-ID übermittelt wurde, obwohl eine bestehende Merkliste erwartet wurde.

watchListNotFoundstringFehlermeldung, die ausgegeben wird, wenn die angegebene Merkliste im System nicht gefunden werden kann.

notLoggedInstringFehlermeldung, die ausgegeben wird, wenn ein nicht angemeldeter Benutzer versucht, eine Merkliste zu löschen.

notChangeablestringFehlermeldung, die ausgegeben wird, wenn die ausgewählte Merkliste nicht löschbar ist (z.B. die Standardliste).

​
actions.watchListItemAdd - Produkt einer Merkliste hinzufügen

Mithilfe der Aktion watchListItemAdd werden die Fehlermeldungen beim Hinzufügen von Produkten zur Merkliste gesteuert.

​
Beispielkonfiguration

{
  "errorCodes": {
    "missingProductId": "<Textbaustein>",
    "invalidProductId": "<Textbaustein>",
    "invalidVariantId": "<Textbaustein>",
    "invalidService": "<Textbaustein>",
    "watchListNotFound": "<Textbaustein>"
  }
}

​
Parameterübersicht

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
missingProductIdstringFehlermeldung, die ausgegeben wird, wenn keine Produkt-ID übermittelt wurde.

invalidProductIdstringFehlermeldung, die ausgegeben wird, wenn die angegebene Produkt-ID ungültig ist oder der Artikel nicht gefunden werden konnte.

invalidVariantIdstringFehlermeldung, die ausgegeben wird, wenn die angegebene Variante ungültig oder nicht verfügbar ist.

invalidServicestringFehlermeldung, die ausgegeben wird, wenn ein ungültiger oder für den Artikel nicht gültiger Zusatzservice übermittelt wurde.

watchListNotFoundstringFehlermeldung, die ausgegeben wird, wenn die angegebene Merkliste im System nicht gefunden werden kann.

​
actions.watchListItemDelete - Produkt von einer Merkliste löschen

Mithilfe der Aktion watchListItemDelete werden die Fehlermeldungen beim Entfernen eines Artikels aus einer Merkliste gesteuert.

​
Beispielkonfiguration actions.watchListItemDelete

{
  "errorCodes": {
    "missingItemId": "<Textbaustein>",
    "invalidItemId": "<Textbaustein>",
    "missingWatchListId": "<Textbaustein>",
    "invalidService": "<Textbaustein>",
    "watchListNotFound": "<Textbaustein>"
  }
}

​
Parameterübersicht

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
missingItemIdstringFehlermeldung, die ausgegeben wird, wenn keine Item-/Positions-ID übermittelt wurde (kein konkreter Merklisten-Eintrag ausgewählt).

invalidItemIdstringFehlermeldung, die ausgegeben wird, wenn die angegebene Item-ID ungültig ist oder der Eintrag nicht gefunden werden kann.

missingWatchListIdstringFehlermeldung, die ausgegeben wird, wenn keine Merklisten-ID angegeben wurde.

invalidServicestringFehlermeldung, die ausgegeben wird, wenn ein ungültiger oder nicht passender Service-Kontext für den Merklisten-Eintrag verwendet wird.

watchListNotFoundstringFehlermeldung, die ausgegeben wird, wenn die referenzierte Merkliste im System nicht existiert.