snowplow-android-tracker/com.snowplowanalytics.snowplow.event/EcommerceTransaction

EcommerceTransaction

class EcommerceTransaction(orderId: String, totalValue: Double, items: List<EcommerceTransactionItem>) : AbstractPrimitive

Deprecated

Use the ecommerce package instead

An ecommerce event.

Parameters

orderId

Identifier of the order.

totalValue

Total amount of the order.

items

Items purchased.

Constructors

Link copied to clipboard
constructor(orderId: String, totalValue: Double, items: List<EcommerceTransactionItem>)

Functions

Link copied to clipboard
fun affiliation(affiliation: String?): EcommerceTransaction

Identifies an affiliation.

Link copied to clipboard
fun city(city: String?): EcommerceTransaction

City for shipping.

Link copied to clipboard
fun contexts(contexts: List<SelfDescribingJson>): AbstractEvent

Adds a list of context entities to the existing ones.

Link copied to clipboard
fun country(country: String?): EcommerceTransaction

Country for shipping.

Link copied to clipboard
fun currency(currency: String?): EcommerceTransaction

Currency used for totalValue and taxValue.

Link copied to clipboard
fun entities(entities: List<SelfDescribingJson>): AbstractEvent

Adds a list of context entities to the existing ones.

Link copied to clipboard
fun shipping(shipping: Double?): EcommerceTransaction

Total amount for shipping.

Link copied to clipboard
fun state(state: String?): EcommerceTransaction

State for shipping.

Link copied to clipboard
fun taxValue(taxValue: Double?): EcommerceTransaction

Taxes applied to the purchase.

Link copied to clipboard
fun trueTimestamp(trueTimestamp: Long?): AbstractEvent

Set the custom timestamp of the event.

Properties

Link copied to clipboard
var affiliation: String?

Identifies an affiliation.

Link copied to clipboard
var city: String?

City for shipping.

Link copied to clipboard
open override var contexts: List<SelfDescribingJson>
Link copied to clipboard
var country: String?

Country for shipping.

Link copied to clipboard
var currency: String?

Currency used for totalValue and taxValue.

Link copied to clipboard
open override val dataPayload: Map<String, Any?>

The payload for the event.

Link copied to clipboard
Link copied to clipboard
open val entitiesForProcessing: List<SelfDescribingJson>?

Used for events whose properties are added as entities, e.g. Ecommerce events

Link copied to clipboard
val items: List<EcommerceTransactionItem>

The list of Transaction Items passed with the event.

Link copied to clipboard
open override val name: String
Link copied to clipboard
val orderId: String

Identifier of the order.

Link copied to clipboard
var shipping: Double?

Total amount for shipping.

Link copied to clipboard
var state: String?

State for shipping.

Link copied to clipboard
var taxValue: Double?

Taxes applied to the purchase.

Link copied to clipboard
val totalValue: Double

Total amount of the order.

Link copied to clipboard
open override var trueTimestamp: Long?