Retail/Ecommerce Apps

25min

The following events are useful for apps selling products or goods.
As our terminology says, for a Retail/e-Commerce app, The Item is your Product.
View Item
When a user views an item/product.
Properties
Name
Type
Required
Description
item
﻿Item﻿﻿
Yes
The item details that the user view.
Code Example
JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        }
    }
};

cooeeSDK.sendEvent("View Item", props);
const props = {
    "item":{
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        }
    }
};

cooeeSDK.sendEvent("View Item", props);
﻿
Add To Cart
When a user adds an item to the cart
Properties
Name
Type
Required
Description
items
Array of Cart Item﻿﻿
Yes
The item details that the user added to the cart with quantity.
Code Example
JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
const props = {
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "quantity": 2
        }
    ]
};

cooeeSDK.sendEvent("Add To Cart", props);
const props = {
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "quantity": 2
        }
    ]
};

cooeeSDK.sendEvent("Add To Cart", props);
﻿
Remove From Cart
When a user removes an item from the cart
Properties
Name
Type
Required
Description
items
Array of Cart Item﻿﻿
Yes
The item details that the user removes from the cart with quantity.
Code Example
JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
const props = {
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "quantity": 2
        }
    ]
};

cooeeSDK.sendEvent("Remove From Cart", props);
const props = {
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "quantity": 2
        }
    ]
};

cooeeSDK.sendEvent("Remove From Cart", props);
﻿
Add To Wishlist
When a user adds an item to the Wishlist.
Properties
Name
Type
Required
Description
item
﻿Item﻿﻿
Yes
The item details that the user added to the wishlist.
Code Example
JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
const props = {
    "item": {
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        }
    }
};

cooeeSDK.sendEvent("Add To Wishlist", props);
const props = {
    "item": {
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        }
    }
};

cooeeSDK.sendEvent("Add To Wishlist", props);
﻿
Remove From Wishlist
When a user removes an item from the Wishlist.
Properties
Name
Type
Required
Description
item
﻿Item﻿﻿
Yes
The item details that the user removed from the wishlist.
Code Example
JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
const props = {
    "item": {
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        }
    }
};

cooeeSDK.sendEvent("Remove From Wishlist", props);
const props = {
    "item": {
        "id": "1234",
        "name": "ITEM_NAME",
        "category": {
            "id": "1234",
            "name": "CATEGORY_NAME"
        }
    }
};

cooeeSDK.sendEvent("Remove From Wishlist", props);
﻿
Begin Checkout
When a user begins checkout like starts payment
Properties
Name
Type
Required
Description
items
Array of Cart Item﻿﻿
Yes
The List of cart items for which the user started the checkout.
amount
﻿Amount﻿ 
Yes
Amount detail with a final total value and currency
coupon
﻿Coupon﻿ 
No
Any Coupon is applied to the final amount.
Code Example
The following example includes optional properties too.
JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
const props = {
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "quantity": 2
        }
    ],
    "amount": {
        "value": 1134.50,
        "currency": "USD"
    },
    "coupon": {
        "id": "FOO-12345",
        "code": "FREE20",
        "amount": 20.0,
        "discountType": "percent"
    }   
};

cooeeSDK.sendEvent("Begin Checkout", props);
const props = {
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "quantity": 2
        }
    ],
    "amount": {
        "value": 1134.50,
        "currency": "USD"
    },
    "coupon": {
        "id": "FOO-12345",
        "code": "FREE20",
        "amount": 20.0,
        "discountType": "percent"
    }   
};

cooeeSDK.sendEvent("Begin Checkout", props);
﻿
View Cart
When a user views their cart.
Properties
Name
Type
Required
Description
items
Array of Cart Item﻿﻿
Yes
The List of cart items which are present in the cart.
amount
﻿Amount﻿ 
Yes
Amount detail with a final total value and currency
coupon
﻿Coupon﻿ 
No
Any Coupon is applied to the final amount.
Code Example
The following example includes optional properties too.
JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
const props = {
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "quantity": 2
        }
    ],
    "amount": {
        "value": 1134.50,
        "currency": "USD"
    },
    "coupon": {
        "id": "FOO-12345",
        "code": "FREE20",
        "amount": 20.0,
        "discountType": "percent"
    }   
};

cooeeSDK.sendEvent("View Cart", props);
const props = {
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "quantity": 2
        }
    ],
    "amount": {
        "value": 1134.50,
        "currency": "USD"
    },
    "coupon": {
        "id": "FOO-12345",
        "code": "FREE20",
        "amount": 20.0,
        "discountType": "percent"
    }   
};

cooeeSDK.sendEvent("View Cart", props);
﻿
Purchase
When a user completes a purchase or places an order.
Properties
Name
Type
Required
Description
items
Array of Cart Item﻿﻿
Yes
The List of cart items which are present in the cart.
amount
﻿Amount﻿ 
Yes
Amount detail with a final total value and currency
coupon
﻿Coupon﻿ 
No
Any Coupon is applied to the final amount.
transactionID
String
Yes
TransactionId of the user purchase.
bAddress
﻿Address﻿ 
Yes
Billing Address for the order.
sAddress
﻿Address﻿ 
Yes
Shipping Address for the order.
deliveryType
String
No
Type of the delivery like Standard, Express, On-day etc.
Code Example
The following example includes optional properties too.
JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
const props = {
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "quantity": 2
        }
    ],
    "amount": {
        "value": 1134.50,
        "currency": "USD"
    },
    "coupon": {
        "id": "FOO-12345",
        "code": "FREE20",
        "amount": 20.0,
        "discountType": "percent"
    },
    "transactionID": "T1234",
    "bAddress": {
        "l1": "Kenner Group Inc",
        "l2": "85 Bradford Lane",
        "city": "Vincentown",
        "country": "United States of America",
        "countryCode": "US",
        "state": "New Jersey",
        "stateCode": "NJ",
        "zip": "08120"
    },
    "sAddress": {
        "l1": "Kenner Group Inc",
        "l2": "85 Bradford Lane",
        "city": "Vincentown",
        "country": "United States of America",
        "countryCode": "US",
        "state": "New Jersey",
        "stateCode": "NJ",
        "zip": "08120"
    },
    "deliveryType": "Standard"
};

cooeeSDK.sendEvent("Purchase", props);
const props = {
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "quantity": 2
        }
    ],
    "amount": {
        "value": 1134.50,
        "currency": "USD"
    },
    "coupon": {
        "id": "FOO-12345",
        "code": "FREE20",
        "amount": 20.0,
        "discountType": "percent"
    },
    "transactionID": "T1234",
    "bAddress": {
        "l1": "Kenner Group Inc",
        "l2": "85 Bradford Lane",
        "city": "Vincentown",
        "country": "United States of America",
        "countryCode": "US",
        "state": "New Jersey",
        "stateCode": "NJ",
        "zip": "08120"
    },
    "sAddress": {
        "l1": "Kenner Group Inc",
        "l2": "85 Bradford Lane",
        "city": "Vincentown",
        "country": "United States of America",
        "countryCode": "US",
        "state": "New Jersey",
        "stateCode": "NJ",
        "zip": "08120"
    },
    "deliveryType": "Standard"
};

cooeeSDK.sendEvent("Purchase", props);
﻿
View Category
When a user selects any kind of category within your app.
Properties
Name
Type
Required
Description
category
﻿Category﻿ 
Yes
The category that the user selected.
Code Example
JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
const props = {
    "category": {
        "id": "1234",
        "name": "CATEGORY_NAME"
    }
};

cooeeSDK.sendEvent("View Category", props);
const props = {
    "category": {
        "id": "1234",
        "name": "CATEGORY_NAME"
    }
};

cooeeSDK.sendEvent("View Category", props);
﻿
﻿

Name	Type	Required	Description
item	Item	Yes	The item details that the user view.

Name	Type	Required	Description
items	Array of Cart Item	Yes	The item details that the user added to the cart with quantity.

Name	Type	Required	Description
items	Array of Cart Item	Yes	The item details that the user removes from the cart with quantity.

Name	Type	Required	Description
item	Item	Yes	The item details that the user added to the wishlist.

Name	Type	Required	Description
item	Item	Yes	The item details that the user removed from the wishlist.

Name	Type	Required	Description
items	Array of Cart Item	Yes	The List of cart items for which the user started the checkout.
amount	Amount	Yes	Amount detail with a final total value and currency
coupon	Coupon	No	Any Coupon is applied to the final amount.

Name	Type	Required	Description
items	Array of Cart Item	Yes	The List of cart items which are present in the cart.
amount	Amount	Yes	Amount detail with a final total value and currency
coupon	Coupon	No	Any Coupon is applied to the final amount.

Name	Type	Required	Description
items	Array of Cart Item	Yes	The List of cart items which are present in the cart.
amount	Amount	Yes	Amount detail with a final total value and currency
coupon	Coupon	No	Any Coupon is applied to the final amount.
transactionID	String	Yes	TransactionId of the user purchase.
bAddress	Address	Yes	Billing Address for the order.
sAddress	Address	Yes	Shipping Address for the order.
deliveryType	String	No	Type of the delivery like Standard, Express, On-day etc.

Name	Type	Required	Description
category	Category	Yes	The category that the user selected.

Updated 25 Mar 2024

Did this page help you?

Educational Apps

Social Apps