Product object

The method signatures provided in this guide can also be applied to Kotlin.

Product object is required for revenue tracking, recommendation engine, and campaigns such as cart reminder. This article explains how you can set the product object and product attributes.

The Java method signatures and examples in this guide apply to Kotlin as well.

Set product object

Once you create a product object, you can set its attributes. You can set predefined (e.g., color, size, voucher name, sub-category, etc.) and custom attributes.

The following parameters are required for the product object:

Method Signature

public InsiderProduct createNewProduct(String id, String name, String[] taxonomy, String imageURL, double price, String currency)

fun createNewProduct(
     id: String,
     name: String,
     taxonomy: Array<String>,
     imageURL: String,
     price: Double,
     currency: String
 ): InsiderProduct

Method Example

String[] taxonomy = {"taxonomy1", "taxonomy2", "taxonomy3"};
                InsiderProduct insiderExampleProduct = Insider.Instance.createNewProduct("productID", "productName", taxonomy, "imageURL", 1000.5, "currency");

The following table lists the properties you can set with the product object.

Set productURL attribute

This method allows you to set the productURL attribute of your Insider product object.

Method Signature

public InsiderProduct setProductURL(String productURL)

fun setProductURL(productURL: String): InsiderProduct

Method Example

insiderExampleProduct.setProductURL("productURL");

Set color attribute

This method allows you to set the color attribute of your Insider product object. 

Method Signature

public InsiderProduct setColor(String color)

fun setColor(color: String): InsiderProduct

Method Example

insiderExampleProduct.setColor("color");

Set voucher name attribute

This method allows you to set the voucher name attribute of your Insider product object. 

Method Signature

public InsiderProduct setVoucherName(String voucherName)

fun setVoucherName(voucherName: String): InsiderProduct

Method Example

insiderExampleProduct.setVoucherName("voucherName");

Set voucher discount attribute

This method allows you to set the voucher discount attribute of your Insider product object. 

Method Signature

public InsiderProduct setVoucherDiscount(double voucherDiscount)

fun setVoucherDiscount(voucherDiscount: Double): InsiderProduct

Method Example

insiderExampleProduct.setVoucherDiscount(10.5);

Set promotion name attribute

This method allows you to set the promotion name attribute of your Insider product object. 

Method Signature

public InsiderProduct setPromotionName(String promotionName)

fun setPromotionName(promotionName: String): InsiderProduct

Method Example

insiderExampleProduct.setPromotionName("promotionName");

Set promotion discount attribute

This method allows you to set the promotion discount attribute of your Insider product object. 

Method Signature

public InsiderProduct setPromotionDiscount(double promotionDiscount)

fun setPromotionDiscount(promotionDiscount: Double): InsiderProduct

Method Example

insiderExampleProduct.setPromotionDiscount(10.5);

Set GroupCode attribute

This method allows you to set the groupcode of your Insider product object. 

Method Signature

public InsiderProduct setGroupCode(String groupCode)

fun setGroupCode(groupCode: String): InsiderProduct

Method Example

insiderExampleProduct.setGroupCode("XXYYZZ");

Set size attribute

This method allows you to set the size attribute of your Insider product object.

Method Signature

public InsiderProduct setSize(String size)

fun setSize(size: String): InsiderProduct

Method Example

insiderExampleProduct.setSize("size");

Set sale price attribute

This method allows you to set the sale price attribute of your Insider product object. 

If the salePrice attribute is provided, the calculations will be made based on this attribute. If not, the calculations will continue to use the price attribute, which remains to be a required field in the mobile app SDK.

Method Signature

public InsiderProduct setSalePrice(double salePrice)

fun setSalePrice(salePrice: Double): InsiderProduct

Method Example

insiderExampleProduct.setSalePrice(10.5);

Set shipping cost attribute

This method allows you to set the shipping cost attribute of your Insider product object. 

Method Signature

public InsiderProduct setShippingCost(double shippingCost)

fun setShippingCost(shippingCost: Double): InsiderProduct

Method Example

insiderExampleProduct.setShippingCost(10.5);

Set quantity attribute

This method allows you to set the quantity attribute of your Insider product object. 

Method Signature

public InsiderProduct setQuantity(int quantity)

fun setQuantity(quantity: Int): InsiderProduct

Method Example

insiderExampleProduct.setQuantity(10);

Set stock attribute

This method allows you to set the stock attribute of your Insider product object. 

Method Signature

public InsiderProduct setStock(int stock)

fun setStock(stock: Int): InsiderProduct

Method Example

insiderExampleProduct.setStock(10);

Set InStock attribute

This method allows you to set the InStock attribute of your Insider product object.

Method Signature

public InsiderProduct setInStock(boolean stock)

fun setInStock(isInStock: Boolean): InsiderProduct

Method Example

insiderExampleProduct.setInStock(true);

Set brand attribute

This method allows you to set the brand of your Insider product object.

Method Signature

public InsiderProduct setBrand(String brand)

fun setBrand(brand: String): InsiderProduct

Method Example

insiderExampleProduct.setBrand("brand");

Set stock keeping unit attribute

This method allows you to set the stock keeping unit of your Insider product object.

Method Signature

public InsiderProduct setSku(String sku)

fun setSku(sku: String): InsiderProduct

Method Example

insiderExampleProduct.setSku("sku");

Set gender attribute

This method allows you to set the gender of your Insider product object.

Method Signature

public InsiderProduct setGender(String gender)

fun setGender(gender: String): InsiderProduct

Method Example

insiderExampleProduct.setGender("gender");

Set multipack attribute

This method allows you to set the multipack of your Insider product object.

Method Signature

public InsiderProduct setMultipack(String multipack)

fun setMultipack(multipack: String): InsiderProduct

Method Example

insiderExampleProduct. setMultipack("multipack"");

Set product type attribute

This method allows you to set the product type of your Insider product object.

Method Signature

public InsiderProduct setProductType(String productType)

fun setProductType(productType: String): InsiderProduct

Method Example

insiderExampleProduct.setProductType("productType");

Set global trade item number attribute

This method allows you to set the global trade item number of your Insider product object.

Method Signature

public InsiderProduct setGtin(String gtin)

fun setGtin(gtin: String): InsiderProduct

Method Example

insiderExampleProduct.setGtin("gtin");

Set description attribute

This method allows you to set the description of your Insider product object.

Method Signature

public InsiderProduct setDescription(String description)

fun setDescription(description: String): InsiderProduct

Method Example

insiderExampleProduct.setDescription("description");

Set tags attribute

This method allows you to set the tags of your Insider product object.

Method Signature

public InsiderProduct setTags(String[] tags)

fun setTags(tags: Array<String>): InsiderProduct

Method Example

String[] tags = {"tag1", "tag2", "tag3"};
insiderExampleProduct.setTags(tags);

Set custom string attribute

This method allows you to set the custom string attribute for your Insider product object.

Method Signature

public InsiderProduct setCustomAttributeWithString(String key, String value)

fun setCustomAttributeWithString(key: String, value: String): InsiderProduct

Method Example

insiderExampleProduct.setCustomAttributeWithString("key", "value");

Set custom integer attribute

This method allows you to set the custom integer attribute for your Insider product object.

Method signature

public InsiderProduct setCustomAttributeWithInt(String key, int value)

fun setCustomAttributeWithInt(key: String, value: Int): InsiderProduct

Method Example

insiderExampleProduct.setCustomAttributeWithInt("key", 10);

Set custom boolean attribute

This method allows you to set the custom boolean attribute for your Insider product object.

Method Signature

public InsiderProduct setCustomAttributeWithBoolean(String key, boolean value)

fun setCustomAttributeWithBoolean(key: String, value: Boolean): InsiderProduct

Method Example

insiderExampleProduct.setCustomAttributeWithBoolean("key", true);

Set custom double attribute

This method allows you to set the custom double attribute for your Insider product object.

Method Signature

public InsiderProduct setCustomAttributeWithDouble(String key, double value)

fun setCustomAttributeWithDouble(key: String, value: Double): InsiderProduct

Method Example

insiderExampleProduct.setCustomAttributeWithDouble("key", 10.5);

Set custom date attribute

This method allows you to set the custom date attribute for your Insider product object.

Method Signature

public InsiderProduct setCustomAttributeWithDate(String key, Date value)

fun setCustomAttributeWithDate(key: String, value: Date): InsiderProduct

Method Example

Date date = new Date();
insiderExampleProduct.setCustomAttributeWithDate("key", date);

Set custom array of string attribute

This method allows you to set the custom array of string attribute for your Insider product object.

Method Signature

InsiderProduct setCustomAttributeWithStringArray(String key, String[] values)

fun setCustomAttributeWithStringArray(key: String, values: Array<String>): InsiderProduct

Method Example

String[] stringArray = new String[]{"value1", "value2", "value3"};

insiderExampleProduct.setCustomAttributeWithStringArray("key", stringArray);

Set custom array of number attribute

This method allows you to set the custom array of number attribute for your Insider product object.

Method Signature

InsiderProduct setCustomAttributeWithNumericArray(String key, Number[] values)

fun setCustomAttributeWithNumericArray(key: String, values: Array<Number>): InsiderProduct

Method Example

Number[] numberArray = new Number[]{5, 3.14, 100};

insiderExampleProduct.setCustomAttributeWithNumericArray("key", numberArray);

Refer to I'm having issues with the product object for troubleshooting.