Skip to content

Add Favourite Notification

The add favourite notification is to be sent with a productKey or a variantKey when a visitor marks a product as a favourite.

Method

POST

URL format

/api/v1/notifications/favorite/add

Parameters

Name Type Description Example
id string Randomized unique identifier, such as UUID or GUID. 0.nd2bj6h4pi9
sessionKey string A unique id. UUID / GUID 2F75A...EAFA6
customerKey string Visitor id. SHA256 hash if the visitor is signed in, otherwise a UUID / GUID. 5G7HJ...R77T1
market string Visitor Market. Sweden
productKey string The unique key of the product. shirt_79709
variantKey string The unique key of the variant. 79709_grey_medium

Request body

{
    "id": "string",
    "sessionKey": "string",
    "customerKey": "string",
    "market": "string",
    "productKey": "string",
    "variantKey": "string",
}

Request content-type

application/json

Response content-type

HTTP response code

Responses

Response Description
204 Notifications was received successfully.
400 Invalid or missing required arguments.
5xx Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Examples

Try out the API at the Apptus API Playground with your eSales Playground and API credentials.

Request

request-body.json

{
    "id": "0.nd2bj6h4pi8",
    "sessionKey": "b106299c-eac0-4f6f-96d2-93e57c255784",
    "customerKey": "d9528030-509c-4e0f-b585-7168f1e9feca",
    "market": "UK",
    "productKey": "shirt_79709",
    "variantKey": "79709_grey_medium",
}

cURL

#!/bin/bash
curl -i \
-X POST \
-T request-body.json \
-H "Content-Type: application/json" \
"https://{cluster-id}.api.esales.apptus.cloud/api/v1/notifications/favorite/add"

Response

HTTP/1.1 204 No Content
×
Copyright

This online publication is intellectual property of Apptus Technologies. 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 Apptus Technologies 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. Apptus Technologies 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