Skip to content

End

https://{cluster-id}.elevate-api.cloud/api/storefront/v3/notifications/end

POST

To actively end a visitor session before it automatically times out, an end notification can be sent.

Request

Header parameters

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

Query parameters

Name Description Example
customerKey
Required 		A key that uniquely identifies the current visitor.
Using UUIDs as keys are recommended
This field is required unless userContext is set to 'ANONYMOUS' or 'UNPERSONALIZED' in which case it is not allowed.
If userContext is set to 'SYNTHETIC' this is optional.
 e3921377-18a2-47c9-a449-06b894898623
market
Required 		Must match the corresponding market identifier in the data feed. UK
sessionKey
Required 		A unique key, identifying the session.
Using UUIDs as keys are recommended.
This field is required unless userContext is set to 'ANONYMOUS' in which case it is not allowed.
If userContext is set to 'SYNTHETIC' this is optional.
 0b05119e-eeb8-418a-bbfb-defa0dde417e
userContext Specifies the level of consent for data tracking. If omitted, the request will be treated as if PERSONALIZED is used.

See user context for more details.
Supported values: PERSONALIZED, UNPERSONALIZED, ANONYMOUS, SYNTHETIC.		 PERSONALIZED 
curl -i \
-X POST \
-H 'Accept-Encoding: null' \
"https://{cluster-id}.elevate-api.cloud/api/storefront/v3/notifications/end?customerKey=customerKey&market=market&sessionKey=sessionKey&userContext=userContext"

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