actions - Products - WEBSALE Dokumentation

This page contains all actions related to products.
This includes actions for reviews, watchlists and availability alerts as well as the associated messages and notifications.

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": {
      ...
      "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 watchlists.
`watchListDelete`	Defines the error messages output when deleting a watchlist.
`watchListItemAdd`	Defines the error messages output when adding products to a watchlist.
`watchListItemDelete`	Defines the error messages output when removing an item from a watchlist.

`actions.backInStock*` - Availability alert

`actions.backInStockActivate` - Activate availability alert

The backInStockActivate action controls the 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.
`missingEmail`	string	Error message output when no email address was supplied.
`missingProductId`	string	Error message output when no product ID was supplied for which the notification should be set up.
`invalidStoreId`	string	Error message output when an invalid or unknown store/branch ID was supplied.
`internError`	string	Error message output when an unexpected system error occurs while activating the notification.
`notAllowed`	string	Error message output when the action is not allowed.
`missingInventoryState`	string	Error message output when no stock status exists for the product.
`entryExists`	string	Error message output when an entry for an availability notification already exists for this item and this customer.

`actions.backInStockDeactivate` - Deactivate availability alert

The backInStockDeactivate action controls the 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.
`missingEmail`	string	Error message output when no email address was supplied.
`missingProductId`	string	Error message output when no product ID was supplied for which the notification should be deactivated.
`internError`	string	Error message output when an unexpected system error occurs while deactivating the notification.
`notAllowed`	string	Error message output when the action is not allowed.

`actions.productRating*` - Product review

`actions.productRatingAdd` - Rate product

The productRatingAdd action controls the error messages when submitting a product review. In addition, an email to the merchant can be configured via merchantEmail that informs 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 has been supplied for which a review should be submitted.
`missingOrderId`	string	Error message output when no order number / order ID has been supplied.
`wrongProductId`	string	Error message output when the reviewed product does not belong to the specified order.
`wrongOrderId`	string	Error message output when the specified order does not match the expected context (e.g. not assigned to the customer).
`userMustLoggedIn`	string	Error message output when a non-signed-in user tries to submit a review.
`invalidPoints`	string	Error message output when an invalid score is supplied.
`missingPoints`	string	Error message output when no score has been supplied.
`missingSubject`	string	Error message output when no title for the review has been supplied.
`missingDescription`	string	Error message output when no review text has been supplied.
`duplicateRating`	string	Error message output when a review by the same customer already exists for this product.
`multiRating`	string	Error message output when multiple reviews have been submitted in a forbidden context (e.g. duplicate entries).
`maxLengthSubject`	string	Error message output when the maximum character length has been exceeded for the review title.
`maxLengthDescription`	string	Error message output when the review text exceeds the maximum allowed length.
`productNotExists`	string	Error message output when the supplied product ID cannot be found in the system.
`orderNotExists`	string	Error message output when the supplied order ID cannot be found in the system.
`merchantEmail`	object	Configures the email through which the merchant is informed 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 the 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 has been supplied for which a review should be deleted.
`missingOrderId`	string	Error message output when no order number / order ID has been supplied.
`wrongProductId`	string	Error message output when the reviewed product does not belong to the specified order.
`wrongOrderId`	string	Error message output when the specified order does not match the expected context (e.g. not assigned to the customer).
`userMustLoggedIn`	string	Error message output when a non-signed-in user tries to delete a review.
`invalidPoints`	string	Error message output when an invalid score is supplied.
`missingPoints`	string	Error message output when no score has been supplied.
`missingSubject`	string	Error message output when no title for the review has been supplied.
`missingDescription`	string	Error message output when no review text has been supplied.
`duplicateRating`	string	Error message output when a review by the same customer already exists for this product.
`multiRating`	string	Error message output when multiple reviews have been deleted in a forbidden context (e.g. duplicate entries).
`maxLengthSubject`	string	Error message output when the maximum character length has been exceeded for the review title.
`maxLengthDescription`	string	Error message output when the review text exceeds the maximum allowed length.
`productNotExists`	string	Error message output when the supplied product ID cannot be found in the system.

`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 has been supplied for which a review should be changed.
`missingOrderId`	string	Error message output when no order number / order ID has been supplied.
`userMustLoggedIn`	string	Error message output when a non-signed-in user tries to change a review.
`invalidPoints`	string	Error message output when an invalid score is supplied.
`missingPoints`	string	Error message output when no score has been supplied.
`missingSubject`	string	Error message output when no title for the review has been supplied.
`missingDescription`	string	Error message output when no review text has been supplied.
`duplicateRating`	string	Error message output when a review by the same customer already exists for this product.
`multiRating`	string	Error message output when multiple reviews have been changed in a forbidden context (e.g. duplicate entries).
`maxLengthSubject`	string	Error message output when the maximum character length has been exceeded for the review title.
`maxLengthDescription`	string	Error message output when the review text exceeds the maximum allowed length.
`productNotExists`	string	Error message output when the supplied product ID cannot be found in the system.

`actions.watchList*` - Watchlist

`actions.watchListAdd` - Create / add watchlist

The watchListAdd action controls the error messages when creating and using watchlists.

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 watchlist to which products are added without an explicit selection. Default: “`Default Watchlist`”
`basketWatchlist`	string	Display name of the watchlist 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 for a new or renamed watchlist has been supplied.
`invalidWatchListName`	string	Error message output when the supplied watchlist name is invalid.
`missingWatchListId`	string	Error message output when no watchlist ID has been supplied although an existing watchlist was expected.
`watchListNotFound`	string	Error message output when the supplied watchlist cannot be found in the system.
`notLoggedIn`	string	Error message output when a non-signed-in user tries to add products to the watchlist.

`actions.watchListDelete` - Delete / remove watchlist

The watchListDelete action controls the error messages when deleting a watchlist.

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 watchlist name is invalid.
`invalidWatchListName`	string	Error message output when the supplied watchlist name is invalid.
`missingWatchListId`	string	Error message output when no watchlist ID has been supplied although an existing watchlist was expected.
`watchListNotFound`	string	Error message output when the supplied watchlist cannot be found in the system.
`notLoggedIn`	string	Error message output when a non-signed-in user tries to delete a watchlist.
`notChangeable`	string	Error message output when the selected watchlist cannot be deleted (e.g. the default list).

`actions.watchListItemAdd` - Add product to a watchlist

The watchListItemAdd action controls the error messages when adding products to the watchlist.

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 has been supplied.
`invalidProductId`	string	Error message output when the supplied product ID is invalid or the item could not be found.
`invalidVariantId`	string	Error message output when the supplied variant is invalid or not available.
`invalidService`	string	Error message output when an invalid or not applicable additional service has been supplied for the item.
`watchListNotFound`	string	Error message output when the supplied watchlist cannot be found in the system.

`actions.watchListItemDelete` - Remove product from a watchlist

The watchListItemDelete action controls the error messages when removing an item from a watchlist.

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 / position ID has been supplied (no specific watchlist entry selected).
`invalidItemId`	string	Error message output when the supplied item ID is invalid or the entry cannot be found.
`missingWatchListId`	string	Error message output when no watchlist ID has been supplied.
`invalidService`	string	Error message output when an invalid or mismatching service context is used for the watchlist entry.
`watchListNotFound`	string	Error message output when the referenced watchlist does not exist in the system.

​Overview of actions

​Excerpt of the basic actions structure

​Action overview

​actions.backInStock* - Availability alert

​actions.backInStockActivate - Activate availability alert

​Example configuration

​Parameter overview

​actions.backInStockDeactivate - Deactivate availability alert

​Example configuration

​Parameter overview

​actions.productRating* - Product review

​actions.productRatingAdd - Rate product

​Example configuration

​Parameter overview

​actions.productRatingDelete - Delete product review

​Example configuration

​Parameter overview

​actions.productRatingUpdate - Change product review

​Example configuration actions.productRatingUpdate

​Parameter overview

​actions.watchList* - Watchlist

​actions.watchListAdd - Create / add watchlist

​Example configuration

​Parameter overview

​actions.watchListDelete - Delete / remove watchlist

​Example configuration

​Parameter overview

​actions.watchListItemAdd - Add product to a watchlist

​Example configuration

​Parameter overview

​actions.watchListItemDelete - Remove product from a watchlist

​Example configuration actions.watchListItemDelete

​Parameter overview

Overview of actions

Excerpt of the basic `actions` structure

Action overview

`actions.backInStock*` - Availability alert

`actions.backInStockActivate` - Activate availability alert

Example configuration

Parameter overview

`actions.backInStockDeactivate` - Deactivate availability alert

Example configuration

Parameter overview

`actions.productRating*` - Product review

`actions.productRatingAdd` - Rate product

Example configuration

Parameter overview

`actions.productRatingDelete` - Delete product review

Example configuration

Parameter overview

`actions.productRatingUpdate` - Change product review

Example configuration `actions.productRatingUpdate`

Parameter overview

`actions.watchList*` - Watchlist

`actions.watchListAdd` - Create / add watchlist

Example configuration

Parameter overview

`actions.watchListDelete` - Delete / remove watchlist

Example configuration

Parameter overview

`actions.watchListItemAdd` - Add product to a watchlist

Example configuration

Parameter overview

`actions.watchListItemDelete` - Remove product from a watchlist

Example configuration `actions.watchListItemDelete`

Parameter overview