v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB

Purchase Events

Send sales transaction data to Kevel for attribution processing.

get/c/{network_id}/purchase

Path parameters

network_idstring required

Query parameters

userKeystring required

multiple userKey values are accepted, representing the userKey(s) this customer was seen on in previous ad requests. If you don't have a solution for gathering and sending the different relevant userKey(s) you can leverage Kevel Audience for this purpose. To send multiple user keys, repeat this param in your request: .../purchase?userKey=annonymous1&userKey=loggedin1&userKey=guest1

productIdstring required

Product identifier, used to lookup product meta data in the Kevel Catalog

timestampstring date required

ISO 8601 (eg. 2017-01-19T16:27:20.974Z) or unix epoch time

quantityinteger required

The quantity of items in this transaction (line item of an order)

pricenumber float required

The product price of the line item. The total amount for the line item will be quantity * price

transactionIdstring

The transaction identifier

merchantIdstring

Optional merchant identifier, used in Marketplaces to identify the seller

ltvQuantityinteger

the expected additional quantity of items sold to this customer. As a Retailer, you can decide to send the quantity of the particular item in the line item, or it can be representative of the prorated future number of total items expected to be purchased by the customer

ltvValuenumber float

the expected additional sales value sold to this customer. As a Retailer can decide to send the sales value for the specific product in the line item or it can be representative of the prorated future value expected to be spent by the customer. This will not be multiplied by ltvQuantity, it is the total value

Response

200

object required