Add To Cart¶
https://{cluster-id}.api.esales.apptus.cloud/api/storefront/v3/notifications/add-to-cart
POST¶
The add-to-cart notification is to be sent with a ticket when a visitor adds an Elevate product to their cart. The ticket is a unique string for an object generated by Elevate.
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 | 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. Required | 0b05119e-eeb8-418a-bbfb-defa0dde417e |
Supported Content-Type¶
application/json;charset=utf-8
text/plain;charset=utf-8
Request body¶
Example
{
"ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7"
}
Schema
TicketNotification¶
The ticket is a unique string for an object generated by Elevate. It is used with notifications as a method to collect behavioural data.
Name | Type | Description | Example |
---|---|---|---|
ticket Required | string | Unique ticket for the Elevate object. | "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7" |
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/add-to-cart?customerKey=e3921377-18a2-47c9-a449-06b894898623&market=UK&sessionKey=0b05119e-eeb8-418a-bbfb-defa0dde417e" \
-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. |