website logo
HomeGo to Dashboard
User Guide
How-To Videos
Developers
Navigate through spaces
User Guide
How-To Videos
Developers
⌘K
Getting Started
Introduction
Compatibility
Terminology
SDK Installation
Shopify
Any Website
Dukaan
Angular 2+
WooCommerce
WordPress
Android Native
iOS Native
Flutter
Cordova
Ionic
React Native
Data Integration
Data Models
Mandatory Events
Mandatory Properties
Call to Action
System Events
Device Properties
Docs powered by archbee 
27min

Retail/Ecommerce Apps

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
|

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
|

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
|

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
|

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
|

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
|

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
|

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
|

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
|
Updated 10 Aug 2022
Did this page help you?
Yes
No
UP NEXT
Social Apps
Docs powered by archbee 
TABLE OF CONTENTS
View Item
Properties
Code Example
Add To Cart
Properties
Code Example
Remove From Cart
Properties
Code Example
Add To Wishlist
Properties
Code Example
Remove From Wishlist
Properties
Code Example
Begin Checkout
Properties
Code Example
View Cart
Properties
Code Example
Purchase
Properties
Code Example
View Category
Properties
Code Example