Skip to content

Remove Recent Searches

https://{cluster-id}.api.esales.apptus.cloud/api/storefront/v3/notifications/remove-recent-searches

POST

The remove recent searches notification is to be sent when a visitor wants to clear recent search phrases.

Request

Header parameters

Name Description Example
Accept-Encoding Allows responses to be compressed using Gzip. gzip

Supported Content-Type

  • application/json;charset=utf-8
  • text/plain;charset=utf-8

Request body

Example
application/json;charset=utf-8
{
  "phrases" : [ "string" ],
  "removeAll" : true
}
Schema

RemoveRecentSearchesNotification

The remove recent searches notification should be sent when a visitor (specified by "customerKey") wishes to remove recently searched phrases.

Name Type Description Example
phrases string[] Array with recent search phrases to remove. Optional if property "removeAll" is true.
removeAll boolean Whether all recent search phrases should be removed. Optional and defaults to false if property "phrases" is provided.
curl -i \
-X POST \
-H 'Accept-Encoding: gzip' \
-H 'Content-Type: application/json;charset=utf-8' \
"https://{cluster-id}.api.esales.apptus.cloud/api/storefront/v3/notifications/remove-recent-searches" \
-T request-body.file

Response

Response codes

Status Description
204 Notification was received successfully.
400 Invalid or missing required arguments.
500 Server error such as cluster unavailable or busy. The response body may contain more information about the error.
×
Copyright

This online publication is intellectual property of Voyado Lund AB. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Voyado Lund AB nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Voyado Lund AB essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.

CLOSE