Purchase Data

1 min

Reporting Single Order Data

Use this API endpoint to submit the purchase data per product. The request should be made once for each line item purchased.

GET

https://{{ Analytics_URL }}/analytics/productTracking

Query Parameters

klevu_apiKeystringrequired
Description
This is your Klevu JS API Key.
klevu_typestringrequired
Description
This is constant value. The value must be checkout.
klevu_productIdstringrequired
Description
This is the Klevu ID of the clicked product. eg. 54321-12345.
klevu_productGroupIdstringrequired
Description
This is the parent ID of the clicked product. eg. 54321. For compound products with a parent and multiple child/variant products, this is the common ID which ties the products together. For simple products, please specify the same as klevu_productId.
klevu_productVariantIdstringrequired
Description
This is the child/variant ID of the clicked product. eg. 12345. For compound products with a parent and multiple child/variant products, this is the ID of the specific variant. For simple products, please specify the same as klevu_productId.
klevu_unitIntegerrequired
Description
This is the total quantity purchased. It must be an integer (e.g. 5).
klevu_salePriceNumberrequired
Description
Product's sale price for one unit. You can supply decimal values.
klevu_currencystringrequired
Description
Three digit currency code. e.g GBP, USD, EUR.
klevu_shopperIPstringrequired
Description
IP address of the shopper who bought the product(s). *If calling from javascript, this is an optional parameter.
klevu_shopperIP_v4string
Description
IPv4 address of the shopper who purchased a product.
klevu_shopperIP_v6string
Description
IPv6 address of the shopper who purchased a product.
data_protectionBoolean
Description
If set to false, Klevu's backend do not obtain the shoppers' IP address. The default value is true.
klevu_uuidstring
Description
Universally unique identifier generated by Klevu, it can be also considered as session id. Please obtain UUID using end-point: https://docs.klevu.com/apis/uuid
klevu_countrystring
Description
2-digit country code of the shopper who purchased a product. Valid codes can be found at https://developers.google.com/hotels/hotel-prices/dev-guide/country-codes
klevu_citystring
Description
City name of the shopper who purchased a product.

curl

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://stats.ksearchnet.com/analytics/productTracking?klevu_apiKey=klevu-1234567890&klevu_type=checkout&klevu_productId=54321-12345&klevu_productGroupId=54321&klevu_productVariantId=12345&klevu_unit=2&klevu_salePrice=123.45&klevu_currency=GBP',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

nodejs

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://stats.ksearchnet.com/analytics/productTracking?klevu_apiKey=klevu-1234567890&klevu_type=checkout&klevu_productId=54321-12345&klevu_productGroupId=54321&klevu_productVariantId=12345&klevu_unit=2&klevu_salePrice=123.45&klevu_currency=GBP',
  'headers': {
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

javascript

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://stats.ksearchnet.com/analytics/productTracking?klevu_apiKey=klevu-1234567890&klevu_type=checkout&klevu_productId=54321-12345&klevu_productGroupId=54321&klevu_productVariantId=12345&klevu_unit=2&klevu_salePrice=123.45&klevu_currency=GBP");

xhr.send();

python

import requests

url = "https://stats.ksearchnet.com/analytics/productTracking?klevu_apiKey=klevu-1234567890&klevu_type=checkout&klevu_productId=54321-12345&klevu_productGroupId=54321&klevu_productVariantId=12345&klevu_unit=2&klevu_salePrice=123.45&klevu_currency=GBP"

payload={}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "net/http"

url = URI("https://stats.ksearchnet.com/analytics/productTracking?klevu_apiKey=klevu-1234567890&klevu_type=checkout&klevu_productId=54321-12345&klevu_productGroupId=54321&klevu_productVariantId=12345&klevu_unit=2&klevu_salePrice=123.45&klevu_currency=GBP")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)

response = https.request(request)
puts response.read_body

200

<data>
    <response>SUCCESS</response>
</data>

klevu_apiKey

Reporting Multiple Order Data (JSON)

The end-point is used for reporting multiple orders in batch.

POST

https://{{ Analytics_URL }}/analytics/collect

Body Parameters

event_versionStringrequired
Description
The event version is used by Klevu's backend. The current version is 1.0.0
eventstringrequired
Description
Define the type of event. For order, use a constant value order_purchase.
event_apikeystringrequired
Description
Your Klevu JS Api Key, eg. klevu-12345.
event_timestamp_msNumber
Description
Event timestamp in milliseconds e.g. 1736256722349
user_profileObjectrequired
Description
The json object that holds the user related information such as ip_address, email.
- ip_addressstringrequired
  Description
  IP address of the shopper who purchased the product.
- emailstring
  Description
  Email id of the shopper who purchased the product.
- ip_address_v4string
  Description
  IPv4 address of the shopper who purchased a product.
- ip_address_v6string
  Description
  IPv6 address of the shopper who purchased products.
- data_protectionboolean
  Description
  If set to false, Klevu's backend do not obtain the shoppers' IP address. The default value is true.
- klevu_uuidstring
  Description
  Universally unique identifier generated by Klevu, it can be also considered as session id.
- klevu_countrystring
  Description
  2-digit country code of the shopper who purchased products. Valid codes can be found at https://developers.google.com/hotels/hotel-prices/dev-guide/country-codes
- klevu_citystring
  Description
  City name of the shopper who purchased products.
itemsArrayrequired
Description
Depending on the number of orders, the item array accepts single or more orders.
order_idstring
Description
The unique identifier for your orders.
order_line_idstring
Description
The unique identifier for reference to a line on an order within the database.
item_namestringrequired
Description
The name of the product.
item_idstringrequired
Description
The full ID of the product. eg. 12345-54321. This will match the unique value used in your data sync process with Klevu. For compound products consisting of a child/variant and a parent, this is usually parentId-childId.
item_group_idstringrequired
Description
The Parent ID of the product. eg. 12345. For compound products consisting of a child/variant and a parent, please specify the ID of the parent. For simple products, please re-use the same value as item_id
item_variant_idstringrequired
Description
The Child ID of the product.eg. 54321. Please specify the ID of the child/variant product. For simple products, please re-use the same value as item_id.
unit_priceNumberrequired
Description
The final selling price of the product, for example 123.45
currencystringrequired
Description
The currency of the above price, eg. USD.
unitsInteger
Description
The number of units sold for a product. In case if the parameter is mising, the default value will be 1

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://stats.ksearchnet.com/analytics/collect',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'[
    {
        "event": "order_purchase",
        "event_apikey": "klevu-12345",
        "user_profile" : {
           "ip_address":"111.11.11.1",
           "email":"[email protected]"
        },
        "event_version": "1.0.0",
        "event_data": {
            "items": [
                {
                    "order_id": "1223434",
                    "order_line_id": "ABC-12343",
                    "item_name": "45RU,800x1070,N-Type,D,NoS,CM,WH,EA",
                    "item_id": "75882",
                    "item_group_id": "75882",
                    "item_variant_id": "75882",
                    "unit_price": 6033.42,
                    "currency": "USD",
                    "units": 2
                },
                {
                    "order_id": "1223435",
                    "order_line_id": "ABC-12344",
                    "item_name": "NoS,CM,WH,EA",
                    "item_id": "75883",
                    "item_group_id": "75883",
                    "item_variant_id": "75883",
                    "unit_price": 6033.42,
                    "currency": "US",
                    "units": 1
                }
            ]
        }
    }
]',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

javascript

// WARNING: For POST requests, body is set to null by browsers.
var data = JSON.stringify([
  {
    "event": "order_purchase",
    "event_apikey": "klevu-12345",
    "user_profile" : {
           "ip_address":"111.11.11.1",
           "email":"[email protected]"
    },
    "event_version": "1.0.0",
    "event_data": {
      "items": [
        {
          "order_id": "1223434",
          "order_line_id": "ABC-12343",
          "item_name": "45RU,800x1070,N-Type,D,NoS,CM,WH,EA",
          "item_id": "75882",
          "item_group_id": "75882",
          "item_variant_id": "75882",
          "unit_price": 6033.42,
          "currency": "CAD",
          "units": 2
        }
      ]
    }
  }
]);

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://stats.ksearchnet.com/analytics/collect");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[\n    {\n        \"event\": \"order_purchase\",\n        \"event_apikey\": \"klevu-12345\",\n        \"event_version\": \"1.0.0\",\n        \"event_data\": {\n            \"items\": [\n                {\n                    \"order_id\": \"1223434\",\n                    \"order_line_id\": \"ABC-12343\",\n                    \"item_name\": \"45RU,800x1070,N-Type,D,NoS,CM,WH,EA\",\n                    \"item_id\": \"75882\",\n                    \"item_group_id\": \"75882\",\n                    \"item_variant_id\": \"75882\",\n                    \"unit_price\": 6033.42,\n                    \"currency\": \"CAD\",\n                    \"units\": 2\n                }\n            ]\n        }\n    }\n]");
Request request = new Request.Builder()
  .url("https://stats.ksearchnet.com/analytics/collect")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

nodejs

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://stats.ksearchnet.com/analytics/collect',
  'headers': {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([
    {
      "event": "order_purchase",
      "event_apikey": "klevu-1234",
      "user_profile" : {
           "ip_address":"111.11.11.1",
           "email":"[email protected]"
      },
      "event_version": "1.0.0",
      "event_data": {
        "items": [
          {
            "order_id": "1223434",
            "order_line_id": "ABC-12343",
            "item_name": "45RU,800x1070,N-Type,D,NoS,CM,WH,EA",
            "item_id": "75882",
            "item_group_id": "75882",
            "item_variant_id": "75882",
            "unit_price": 6033.42,
            "currency": "CAD",
            "units": 2
          }
        ]
      }
    }
  ])

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

200