com.snowplowanalytics.snowplow.event

Class EcommerceTransactionItem

java.lang.Object

com.snowplowanalytics.snowplow.event.AbstractEvent

com.snowplowanalytics.snowplow.event.AbstractPrimitive

com.snowplowanalytics.snowplow.event.EcommerceTransactionItem

All Implemented Interfaces:

Event

public class EcommerceTransactionItem
extends AbstractPrimitive

An ecommerce item event.

Field Summary

Fields

Modifier and Type	Field and Description
String	category Category of the item.
String	currency Currency used for the price of the item.
String	name Name of the item.
String	orderId OrderID of the order that contains this item.
Double	price Price of the item.
Integer	quantity Quantity of the item.
String	sku Stock Keeping Unit of the item.

Fields inherited from class com.snowplowanalytics.snowplow.event.AbstractEvent

customContexts, trueTimestamp

Constructor Summary

Constructors

Constructor and Description
EcommerceTransactionItem(String sku, double price, int quantity) Creates an ecommerce item event.

Method Summary

Modifier and Type	Method and Description
EcommerceTransactionItem	category(String category) Category of the item.
EcommerceTransactionItem	currency(String currency) Currency used for the price of the item.
Map<String,Object>	getDataPayload()
String	getName()
EcommerceTransactionItem	name(String name) Name of the item.
EcommerceTransactionItem	orderId(String orderId) OrderID of the order that contains this item.

Methods inherited from class com.snowplowanalytics.snowplow.event.AbstractEvent

beginProcessing, contexts, endProcessing, getContexts, getTrueTimestamp, trueTimestamp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sku

@NonNull
public final String sku

Stock Keeping Unit of the item.

price

@NonNull
public final Double price

Price of the item.

quantity

@NonNull
public final Integer quantity

Quantity of the item.

name

@Nullable
public String name

Name of the item.

category

@Nullable
public String category

Category of the item.

currency

@Nullable
public String currency

Currency used for the price of the item.

orderId

@Nullable
public String orderId

OrderID of the order that contains this item.

Constructor Detail

EcommerceTransactionItem

public EcommerceTransactionItem(@NonNull
                                String sku,
                                double price,
                                int quantity)

Creates an ecommerce item event.

Parameters:

sku - Stock Keeping Unit of the item.

price - Price of the item.

quantity - Quantity of the item.

Method Detail

name

@NonNull
public EcommerceTransactionItem name(@Nullable
                                              String name)

Name of the item.

category

@NonNull
public EcommerceTransactionItem category(@Nullable
                                                  String category)

Category of the item.

currency

@NonNull
public EcommerceTransactionItem currency(@Nullable
                                                  String currency)

Currency used for the price of the item.

orderId

@NonNull
public EcommerceTransactionItem orderId(@Nullable
                                                 String orderId)

OrderID of the order that contains this item.

getDataPayload

@NonNull
public Map<String,Object> getDataPayload()

Returns:

the event data payload

getName

@NonNull
public String getName()

Specified by:

getName in class AbstractPrimitive

Returns:

The name of the event.