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


Reporting Single Order Data

klevu_apiKey

This is constant value. The value must be checkout.

klevu_type

This is the Klevu ID of the clicked product. eg. 54321-12345.

klevu_productId

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_productGroupId

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_productVariantId

This is the total quantity purchased. It must be an integer (e.g. 5).

klevu_unit

Product's sale price for one unit. You can supply decimal values. 

klevu_salePrice

Three digit currency code. e.g GBP, USD, EUR.

klevu_currency

IP address of the shopper who bought the product(s). 

*If calling from javascript, this is an optional parameter.

klevu_shopperIP

IPv4 address of the shopper who purchased a product. 

klevu_shopperIP_v4

IPv6 address of the shopper who purchased a product. 

klevu_shopperIP_v6

If set to false, Klevu's backend do not obtain the shoppers' IP address. The default value is true.

data_protection

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_uuid

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_country

City name of the shopper who purchased a product.

klevu_city

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

Reporting Multiple Order Data (JSON)

The event version is used by Klevu's backend. The current version is 1.0.0

event_version

Define the type of event. For order, use a constant value order_purchase. 

 event

event_apikey

Event timestamp in milliseconds e.g. 1736256722349

event_timestamp_ms

The optional json object that holds the user related information such as ip_address, email. 

user_profile

Depending on the number of orders, the item array accepts single or more orders.  

items

order_id

The unique identifier for reference to a line on an order within the database. 

order_line_id

item_name

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_id

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_group_id

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.

item_variant_id

The final selling price of the product, for example 123.45

unit_price

The currency of the above price, eg. USD.

currency

The number of units sold for a product. In case if the parameter is mising, the default value will be 1 

Purchase Data