Non-eSales click notification¶

The non-eSales click notification is to be sent when a visitor has clicked a product that is not returned by Elevate (i.e. not having a ticket). Instead of a ticket, a product key (and if applicable, a variant key) is sent.

Method¶

POST

URL format¶

/api/v1/notifications/non-esales-click

Parameters¶

Name	Type	Description	Example

`market`	string	Visitor Market	`Sweden`
`customerKey`	string	Visitor id. SHA256 hash if the visitor is signed in, otherwise a UUID / GUID.	`5G7HJ...R77T1`
`sessionKey`	string	A unique id. UUID / GUID.	`2F75A...EAFA6`
`id`	string	Randomized unique identifier, such as UUID or GUID.	`0.nd2bj6h4pi9`
`token`	string	Unique token generated by the CustomerKeyAuthentication class. Should only be set for signed in visitors.	`EAFA6...2F75A`
`productKey`	string	The unique key of the product.	`shirt_79709`
`variantKey`	string	The unique key of the variant.	`79709_grey_medium`

Request body¶

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

Request content-type¶

application/json

Response content-type¶

N/A

Responses¶

Response	Description
204	Notifications was received successfully.
400	Product key is missing.
403	A SHA256 customer key was used, but it could not be validated.
5xx	Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Example¶

Request¶

request-body.json¶

{
    "market": "UK",
    "customerKey": "d9528030-509c-4e0f-b585-7168f1e9feca",
    "sessionKey": "b106299c-eac0-4f6f-96d2-93e57c255784",
    "id": "0.nd2bj6h4pi7",
    "productKey": "P_555452-0446_UK",
    "variantKey": null
}

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/non-esales-click"

Response¶

HTTP/1.1 204 No Content