com.iterable.iterableapi

Class CommerceItem

java.lang.Object

com.iterable.iterableapi.CommerceItem

public class CommerceItem
extends java.lang.Object

Represents a product. These are used by the commerce API; see IterableApi.trackPurchase(double, List, JSONObject)

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String[]	categories categories of this product, in breadcrumb list form
java.lang.String	description description of this product
java.lang.String	id id of this product
java.lang.String	imageUrl URL of this product's image
java.lang.String	name name of this product
double	price price of this product
int	quantity quantity of this product
java.lang.String	sku SKU of this product
java.lang.String	url URL of this product

Constructor Summary

Constructors

Constructor and Description
CommerceItem(java.lang.String id, java.lang.String name, double price, int quantity) Creates a CommerceItem with the specified properties
CommerceItem(java.lang.String id, java.lang.String name, double price, int quantity, java.lang.String sku, java.lang.String description, java.lang.String url, java.lang.String imageUrl, java.lang.String[] categories) Creates a CommerceItem with the specified properties

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	toJSONObject() A JSONObject representation of this item

Methods inherited from class java.lang.Object

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

Field Detail

id

public final java.lang.String id

id of this product

name

public final java.lang.String name

name of this product

price

public final double price

price of this product

quantity

public final int quantity

quantity of this product

sku

@Nullable
public final java.lang.String sku

SKU of this product

description

@Nullable
public final java.lang.String description

description of this product

url

@Nullable
public final java.lang.String url

URL of this product

imageUrl

@Nullable
public final java.lang.String imageUrl

URL of this product's image

categories

@Nullable
public final java.lang.String[] categories

categories of this product, in breadcrumb list form

Constructor Detail

CommerceItem

public CommerceItem(@NonNull
                    java.lang.String id,
                    @NonNull
                    java.lang.String name,
                    double price,
                    int quantity)

Creates a CommerceItem with the specified properties

Parameters:

id - id of the product

name - name of the product

price - price of the product

quantity - quantity of the product

CommerceItem

public CommerceItem(@NonNull
                    java.lang.String id,
                    @NonNull
                    java.lang.String name,
                    double price,
                    int quantity,
                    @Nullable
                    java.lang.String sku,
                    @Nullable
                    java.lang.String description,
                    @Nullable
                    java.lang.String url,
                    @Nullable
                    java.lang.String imageUrl,
                    @Nullable
                    java.lang.String[] categories)

Creates a CommerceItem with the specified properties

Parameters:

id - id of the product

name - name of the product

price - price of the product

quantity - quantity of the product

sku - SKU of the product

description - description of the product

url - URL of the product

imageUrl - URL of the product's image

categories - categories this product belongs to

Method Detail

toJSONObject

@NonNull
public org.json.JSONObject toJSONObject()
                                          throws org.json.JSONException

A JSONObject representation of this item

Returns:

A JSONObject representing this item

Throws:

org.json.JSONException