Purchase complete signals
import requests
url = "https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase"
payload = [
{
"timestamp": 1744305461169,
"visitorId": "abcc8e25-d30f-2212-9f60-9b45a71453cf",
"sessionId": "41a50e2-8e32-4674-5429-e1450dfdbb14",
"productDetails": [
{
"product": {
"productId": "1234567",
"currencyCode": "USD",
"price": 2592,
"title": "Silver french door bottom freezer 27.4 cu ft refrigerator",
"imageuri": "https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg"
},
"quantity": 1
}
],
"cartId": "7f626d8c-4176-4f55-b17d-e89531e92ef7",
"queryId": "2a97fc33-3335-3369-c2dc-456b775eb90f",
"ipAddress": "111.222.333",
"sourceId": "<string>",
"uri": "https://example.com/order-confirmation",
"orderId": "6a678f11-2265-4d01-a4ed-6e9875bfbda2",
"revenue": 2592
}
]
headers = {
"Accept": "<accept>",
"Authorization": "<authorization>",
"Content-Type": "<content-type>"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase")
.header("Accept", "<accept>")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.body("[\n {\n \"timestamp\": 1744305461169,\n \"visitorId\": \"abcc8e25-d30f-2212-9f60-9b45a71453cf\",\n \"sessionId\": \"41a50e2-8e32-4674-5429-e1450dfdbb14\",\n \"productDetails\": [\n {\n \"product\": {\n \"productId\": \"1234567\",\n \"currencyCode\": \"USD\",\n \"price\": 2592,\n \"title\": \"Silver french door bottom freezer 27.4 cu ft refrigerator\",\n \"imageuri\": \"https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg\"\n },\n \"quantity\": 1\n }\n ],\n \"cartId\": \"7f626d8c-4176-4f55-b17d-e89531e92ef7\",\n \"queryId\": \"2a97fc33-3335-3369-c2dc-456b775eb90f\",\n \"ipAddress\": \"111.222.333\",\n \"sourceId\": \"<string>\",\n \"uri\": \"https://example.com/order-confirmation\",\n \"orderId\": \"6a678f11-2265-4d01-a4ed-6e9875bfbda2\",\n \"revenue\": 2592\n }\n]")
.asString();const options = {
method: 'POST',
headers: {
Accept: '<accept>',
Authorization: '<authorization>',
'Content-Type': '<content-type>'
},
body: JSON.stringify([
{
timestamp: 1744305461169,
visitorId: 'abcc8e25-d30f-2212-9f60-9b45a71453cf',
sessionId: '41a50e2-8e32-4674-5429-e1450dfdbb14',
productDetails: [
{
product: {
productId: '1234567',
currencyCode: 'USD',
price: 2592,
title: 'Silver french door bottom freezer 27.4 cu ft refrigerator',
imageuri: 'https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg'
},
quantity: 1
}
],
cartId: '7f626d8c-4176-4f55-b17d-e89531e92ef7',
queryId: '2a97fc33-3335-3369-c2dc-456b775eb90f',
ipAddress: '111.222.333',
sourceId: '<string>',
uri: 'https://example.com/order-confirmation',
orderId: '6a678f11-2265-4d01-a4ed-6e9875bfbda2',
revenue: 2592
}
])
};
fetch('https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "[\n {\n \"timestamp\": 1744305461169,\n \"visitorId\": \"abcc8e25-d30f-2212-9f60-9b45a71453cf\",\n \"sessionId\": \"41a50e2-8e32-4674-5429-e1450dfdbb14\",\n \"productDetails\": [\n {\n \"product\": {\n \"productId\": \"1234567\",\n \"currencyCode\": \"USD\",\n \"price\": 2592,\n \"title\": \"Silver french door bottom freezer 27.4 cu ft refrigerator\",\n \"imageuri\": \"https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg\"\n },\n \"quantity\": 1\n }\n ],\n \"cartId\": \"7f626d8c-4176-4f55-b17d-e89531e92ef7\",\n \"queryId\": \"2a97fc33-3335-3369-c2dc-456b775eb90f\",\n \"ipAddress\": \"111.222.333\",\n \"sourceId\": \"<string>\",\n \"uri\": \"https://example.com/order-confirmation\",\n \"orderId\": \"6a678f11-2265-4d01-a4ed-6e9875bfbda2\",\n \"revenue\": 2592\n }\n]"
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase"
payload := strings.NewReader("[\n {\n \"timestamp\": 1744305461169,\n \"visitorId\": \"abcc8e25-d30f-2212-9f60-9b45a71453cf\",\n \"sessionId\": \"41a50e2-8e32-4674-5429-e1450dfdbb14\",\n \"productDetails\": [\n {\n \"product\": {\n \"productId\": \"1234567\",\n \"currencyCode\": \"USD\",\n \"price\": 2592,\n \"title\": \"Silver french door bottom freezer 27.4 cu ft refrigerator\",\n \"imageuri\": \"https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg\"\n },\n \"quantity\": 1\n }\n ],\n \"cartId\": \"7f626d8c-4176-4f55-b17d-e89531e92ef7\",\n \"queryId\": \"2a97fc33-3335-3369-c2dc-456b775eb90f\",\n \"ipAddress\": \"111.222.333\",\n \"sourceId\": \"<string>\",\n \"uri\": \"https://example.com/order-confirmation\",\n \"orderId\": \"6a678f11-2265-4d01-a4ed-6e9875bfbda2\",\n \"revenue\": 2592\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Accept", "<accept>")
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "<content-type>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'timestamp' => 1744305461169,
'visitorId' => 'abcc8e25-d30f-2212-9f60-9b45a71453cf',
'sessionId' => '41a50e2-8e32-4674-5429-e1450dfdbb14',
'productDetails' => [
[
'product' => [
'productId' => '1234567',
'currencyCode' => 'USD',
'price' => 2592,
'title' => 'Silver french door bottom freezer 27.4 cu ft refrigerator',
'imageuri' => 'https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg'
],
'quantity' => 1
]
],
'cartId' => '7f626d8c-4176-4f55-b17d-e89531e92ef7',
'queryId' => '2a97fc33-3335-3369-c2dc-456b775eb90f',
'ipAddress' => '111.222.333',
'sourceId' => '<string>',
'uri' => 'https://example.com/order-confirmation',
'orderId' => '6a678f11-2265-4d01-a4ed-6e9875bfbda2',
'revenue' => 2592
]
]),
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"Authorization: <authorization>",
"Content-Type: <content-type>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}curl --request POST \
--url https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase \
--header 'Accept: <accept>' \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>' \
--data '
[
{
"timestamp": 1744305461169,
"visitorId": "abcc8e25-d30f-2212-9f60-9b45a71453cf",
"sessionId": "41a50e2-8e32-4674-5429-e1450dfdbb14",
"productDetails": [
{
"product": {
"productId": "1234567",
"currencyCode": "USD",
"price": 2592,
"title": "Silver french door bottom freezer 27.4 cu ft refrigerator",
"imageuri": "https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg"
},
"quantity": 1
}
],
"cartId": "7f626d8c-4176-4f55-b17d-e89531e92ef7",
"queryId": "2a97fc33-3335-3369-c2dc-456b775eb90f",
"ipAddress": "111.222.333",
"sourceId": "<string>",
"uri": "https://example.com/order-confirmation",
"orderId": "6a678f11-2265-4d01-a4ed-6e9875bfbda2",
"revenue": 2592
}
]
'This response has no body data.This response has no body data.Purchase complete signals
When a user completes a purchase and is taken to the order confirmation page, a signal is recorded.
POST
/
retail
/
signals
/
purchase
Purchase complete signals
import requests
url = "https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase"
payload = [
{
"timestamp": 1744305461169,
"visitorId": "abcc8e25-d30f-2212-9f60-9b45a71453cf",
"sessionId": "41a50e2-8e32-4674-5429-e1450dfdbb14",
"productDetails": [
{
"product": {
"productId": "1234567",
"currencyCode": "USD",
"price": 2592,
"title": "Silver french door bottom freezer 27.4 cu ft refrigerator",
"imageuri": "https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg"
},
"quantity": 1
}
],
"cartId": "7f626d8c-4176-4f55-b17d-e89531e92ef7",
"queryId": "2a97fc33-3335-3369-c2dc-456b775eb90f",
"ipAddress": "111.222.333",
"sourceId": "<string>",
"uri": "https://example.com/order-confirmation",
"orderId": "6a678f11-2265-4d01-a4ed-6e9875bfbda2",
"revenue": 2592
}
]
headers = {
"Accept": "<accept>",
"Authorization": "<authorization>",
"Content-Type": "<content-type>"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase")
.header("Accept", "<accept>")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.body("[\n {\n \"timestamp\": 1744305461169,\n \"visitorId\": \"abcc8e25-d30f-2212-9f60-9b45a71453cf\",\n \"sessionId\": \"41a50e2-8e32-4674-5429-e1450dfdbb14\",\n \"productDetails\": [\n {\n \"product\": {\n \"productId\": \"1234567\",\n \"currencyCode\": \"USD\",\n \"price\": 2592,\n \"title\": \"Silver french door bottom freezer 27.4 cu ft refrigerator\",\n \"imageuri\": \"https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg\"\n },\n \"quantity\": 1\n }\n ],\n \"cartId\": \"7f626d8c-4176-4f55-b17d-e89531e92ef7\",\n \"queryId\": \"2a97fc33-3335-3369-c2dc-456b775eb90f\",\n \"ipAddress\": \"111.222.333\",\n \"sourceId\": \"<string>\",\n \"uri\": \"https://example.com/order-confirmation\",\n \"orderId\": \"6a678f11-2265-4d01-a4ed-6e9875bfbda2\",\n \"revenue\": 2592\n }\n]")
.asString();const options = {
method: 'POST',
headers: {
Accept: '<accept>',
Authorization: '<authorization>',
'Content-Type': '<content-type>'
},
body: JSON.stringify([
{
timestamp: 1744305461169,
visitorId: 'abcc8e25-d30f-2212-9f60-9b45a71453cf',
sessionId: '41a50e2-8e32-4674-5429-e1450dfdbb14',
productDetails: [
{
product: {
productId: '1234567',
currencyCode: 'USD',
price: 2592,
title: 'Silver french door bottom freezer 27.4 cu ft refrigerator',
imageuri: 'https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg'
},
quantity: 1
}
],
cartId: '7f626d8c-4176-4f55-b17d-e89531e92ef7',
queryId: '2a97fc33-3335-3369-c2dc-456b775eb90f',
ipAddress: '111.222.333',
sourceId: '<string>',
uri: 'https://example.com/order-confirmation',
orderId: '6a678f11-2265-4d01-a4ed-6e9875bfbda2',
revenue: 2592
}
])
};
fetch('https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "[\n {\n \"timestamp\": 1744305461169,\n \"visitorId\": \"abcc8e25-d30f-2212-9f60-9b45a71453cf\",\n \"sessionId\": \"41a50e2-8e32-4674-5429-e1450dfdbb14\",\n \"productDetails\": [\n {\n \"product\": {\n \"productId\": \"1234567\",\n \"currencyCode\": \"USD\",\n \"price\": 2592,\n \"title\": \"Silver french door bottom freezer 27.4 cu ft refrigerator\",\n \"imageuri\": \"https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg\"\n },\n \"quantity\": 1\n }\n ],\n \"cartId\": \"7f626d8c-4176-4f55-b17d-e89531e92ef7\",\n \"queryId\": \"2a97fc33-3335-3369-c2dc-456b775eb90f\",\n \"ipAddress\": \"111.222.333\",\n \"sourceId\": \"<string>\",\n \"uri\": \"https://example.com/order-confirmation\",\n \"orderId\": \"6a678f11-2265-4d01-a4ed-6e9875bfbda2\",\n \"revenue\": 2592\n }\n]"
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase"
payload := strings.NewReader("[\n {\n \"timestamp\": 1744305461169,\n \"visitorId\": \"abcc8e25-d30f-2212-9f60-9b45a71453cf\",\n \"sessionId\": \"41a50e2-8e32-4674-5429-e1450dfdbb14\",\n \"productDetails\": [\n {\n \"product\": {\n \"productId\": \"1234567\",\n \"currencyCode\": \"USD\",\n \"price\": 2592,\n \"title\": \"Silver french door bottom freezer 27.4 cu ft refrigerator\",\n \"imageuri\": \"https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg\"\n },\n \"quantity\": 1\n }\n ],\n \"cartId\": \"7f626d8c-4176-4f55-b17d-e89531e92ef7\",\n \"queryId\": \"2a97fc33-3335-3369-c2dc-456b775eb90f\",\n \"ipAddress\": \"111.222.333\",\n \"sourceId\": \"<string>\",\n \"uri\": \"https://example.com/order-confirmation\",\n \"orderId\": \"6a678f11-2265-4d01-a4ed-6e9875bfbda2\",\n \"revenue\": 2592\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Accept", "<accept>")
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "<content-type>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'timestamp' => 1744305461169,
'visitorId' => 'abcc8e25-d30f-2212-9f60-9b45a71453cf',
'sessionId' => '41a50e2-8e32-4674-5429-e1450dfdbb14',
'productDetails' => [
[
'product' => [
'productId' => '1234567',
'currencyCode' => 'USD',
'price' => 2592,
'title' => 'Silver french door bottom freezer 27.4 cu ft refrigerator',
'imageuri' => 'https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg'
],
'quantity' => 1
]
],
'cartId' => '7f626d8c-4176-4f55-b17d-e89531e92ef7',
'queryId' => '2a97fc33-3335-3369-c2dc-456b775eb90f',
'ipAddress' => '111.222.333',
'sourceId' => '<string>',
'uri' => 'https://example.com/order-confirmation',
'orderId' => '6a678f11-2265-4d01-a4ed-6e9875bfbda2',
'revenue' => 2592
]
]),
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"Authorization: <authorization>",
"Content-Type: <content-type>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}curl --request POST \
--url https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/purchase \
--header 'Accept: <accept>' \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>' \
--data '
[
{
"timestamp": 1744305461169,
"visitorId": "abcc8e25-d30f-2212-9f60-9b45a71453cf",
"sessionId": "41a50e2-8e32-4674-5429-e1450dfdbb14",
"productDetails": [
{
"product": {
"productId": "1234567",
"currencyCode": "USD",
"price": 2592,
"title": "Silver french door bottom freezer 27.4 cu ft refrigerator",
"imageuri": "https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg"
},
"quantity": 1
}
],
"cartId": "7f626d8c-4176-4f55-b17d-e89531e92ef7",
"queryId": "2a97fc33-3335-3369-c2dc-456b775eb90f",
"ipAddress": "111.222.333",
"sourceId": "<string>",
"uri": "https://example.com/order-confirmation",
"orderId": "6a678f11-2265-4d01-a4ed-6e9875bfbda2",
"revenue": 2592
}
]
'This response has no body data.This response has no body data.Headers
Header acceptance criteria
Example:
"application/json"
This is the Lucidworks Platform Analytics Studio embed token generated after the signal store is created. To obtain the embed token: 1. Sign in to Lucidworks Platform, click Signals from the megamenu, and then click the signal store. 2. Click Integrations > Signals Using Embed Token. 3. If the token is not generated, click Generate. The embed token displays on the screen and also in all of the cURL examples. 4. Copy that token to paste into your codebase.
Example:
"qasdlkjdoiu1123455WECMMLLJ22eeg"
Content type format
Example:
"application/json"
Body
application/json
The event time displayed in epoch time milliseconds.
Example:
1744305461169
The unique identifier for the visitor (user) associated with the signal. The field is a UTF-8 encoded string with a maximum of 128 characters. Do not use personally identifiable information (PII) or user data in the value.
Maximum string length:
128Example:
"abcc8e25-d30f-2212-9f60-9b45a71453cf"
The unique identifier that tracks a specific session of a user's activity over a period of time.
Maximum string length:
128Example:
"41a50e2-8e32-4674-5429-e1450dfdbb14"
The purchased products. Each productId must match the productId in its cart-add signal.
Show child attributes
Show child attributes
The UUID of the cart. Must match the cartId sent in the cart-add signals for this cart.
Example:
"7f626d8c-4176-4f55-b17d-e89531e92ef7"
Optional. Not used to attribute the purchase to a query. Purchases are attributed by cartId and the productId of each item in productDetails.
Example:
"2a97fc33-3335-3369-c2dc-456b775eb90f"
This optional parameter is the IP address of the browser or device that generated the signal.
The IP address may be passed in the signal. If it is not passed in the signal, it is extracted from the request, and the last octet is dropped to mask the user's location for security purposes.
Example:
"111.222.333"
A freeform text field used to identify where the API call originates.
The value has no effect on search relevancy.
The URL of the page on which this event occurred. The field is a UTF-8 encoded string with a maximum of 5000 characters.
Example:
"https://example.com/order-confirmation"
This optional unique identifier parameter is used on the purchase_complete signal and identifies an actual purchase as opposed to an attempted purchase.
Example:
"6a678f11-2265-4d01-a4ed-6e9875bfbda2"
This floating number is the total price of the sale.
Example:
2592
Response
ACCEPTED
Was this page helpful?