Event type

BIK supports approximately 20 standard e-commerce events. A selection of these is documented below. For the complete list, contact your GSM.

Send Event For AbandonedCartCreated

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test56@gmail.com",
    "eventName": "abandonedCartCreated",
    "eventProperties": {
        "cartValue": 500,
        "cartId": "CART_ID",
        "totalNumberOfItems": 10,
        "currency": "INR",
        "customerId": "CUSTOMER_ID",
        "url": "cart_url"
    }
}

Event properties for AbandonedCartCreated

Name	Type	Required/Optional	Description
cartValue	number	Required	Total cart value
cartId	string	Required	Cart ID
totalNumberOfItems	number	Required	Total number of items in the cart
currency	string	Optional	Currency code
customerId	string	Required	Customer ID
url	string	Optional	Cart URL
broadcastName	string	Optional	Broadcast name
productNames	string[]	Optional	List of product names

Send Event For Customer Created

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test56@gmail.com",
    "eventName": "customerCreated",
    "eventProperties": {
        "customerSource": "Online store",
    }
}

Event properties for Customer Created

Name	Type	Required/Optional	Description
customerSource	string	Optional	Origin of the customer
customerSourceDetails	string	Optional	Additional details about the customer origin

Send Event For Ordered

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test55@gmail.com",
    "eventName": "ordered",
    "eventProperties": {
        "customerId": "CUST_TEST_123",
        "orderValue": "2000",
        "orderId": "test-order-id",
        "orderName": "test-order-name",
        "currency": "INR",
        "type": "COD",
        "totalNumberOfItems": 50
    }
}

Event properties for Ordered

Name	Type	Required/Optional	Description
orderDate	Date	Required	Order creation date
shippingAddress	string	Required	Shipping address
billingAddress	string	Required	Billing address
tags	string[]	Optional	Order tags
orderValue	number	Required	Total order value
orderId	string	Required	Order ID
orderName	string	Required	Order name
totalNumberOfItems	number	Required	Total number of items
currency	string	Optional	Currency code
customerId	string	Optional	Customer ID
type	string	Optional	Order type
eventSource	string	Optional	Event source
sourceId	string	Optional	Source ID
utmSource	string	Optional	UTM source
utmMedium	string	Optional	UTM medium
utmCampaign	string	Optional	UTM campaign
linkId	string	Optional	Order link ID
broadcastName	string	Optional	Broadcast name
broadcastId	string	Optional	Broadcast ID

Send Event For Order Delivered

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test56@gmail.com",
    "eventName": "orderDelivered",
    "eventProperties": {
        "id": "test-order-id1234",
        "orderName": "Test products"
    }
}

Event properties for Order Delivered

Name	Type	Required/Optional	Description
id	string	Required	Order ID
orderName	string	Required	Order name

Send Event For Line Item Shipping Update

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test56@gmail.com",
    "eventName": "lineItemShippingUpdate",
    "eventProperties": {
        "orderId": "test-order-id1234",
        "orderName": "my-order",
        "productId": "test-product-id1234",
        "productName": "my-product",
        "shippingStatus": "SHIPPED"
    }
}

Event properties for Line Item Shipping Update

Name	Type	Required/Optional	Description
orderId	string	Required	Order ID
orderName	string	Required	Order name
productId	string	Required	Product ID
productName	string	Required	Product name
variantId	string	Optional	Variant ID
variantName	string	Optional	Variant name
shippingStatus	string	Optional	Current shipping status
collectionNames	string[]	Optional	Collection names
collectionIds	string[]	Optional	Collection IDs

Send Event For AddToCart

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test56@gmail.com",
    "eventName": "addToCart",
    "eventProperties": {
        "productId": "PRODUCT_ID",
        "productName": "my-product",
        "variantId": "VARIANT_ID",
        "variantName": "VARIANT_NAME",
        "price": 500
    }
}

Event properties for AddToCart

Name	Type	Required/Optional	Description
productId	string	Required	Product ID
productName	string	Required	Product name
variantId	string	Required	Variant ID
variantName	string	Required	Variant name
price	string	Required	Item price
collectionNames	string[]	Optional	Collection names
collectionIds	string[]	Optional	Collection IDs
utmSource	string	Optional	UTM source
utmMedium	string	Optional	UTM medium
utmCampaign	string	Optional	UTM campaign
linkId	string	Optional	Order link ID
broadcastName	string	Optional	Broadcast name
broadcastId	string	Optional	Broadcast ID

Send Event For CatalogViewed

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test@gmail.com",
    "eventName": "catalogViewed",
    "eventProperties": {
        "catalogId": "CATALOG_ID",
        "catalogName": "CATALOG_NAME"
    }
}

Event properties for CatalogViewed

Name	Type	Required/Optional	Description
catalogId	string	Required	Catalog ID
catalogName	string	Required	Catalog name

Send Event For KeywordSearched

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test@gmail.com",
    "eventName": "keywordSearched",
    "eventProperties": {
        "searchTerm": "search_query"
    }
}

Event properties for KeywordSearched

Name	Type	Required/Optional	Description
searchTerm	string	Required	Search query string

Send Event For PageViewed

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test@gmail.com",
    "eventName": "pageViewed",
    "eventProperties": {
        "title": "TITLE",
        "url": "URL"
    }
}

Event properties for PageViewed

Name	Type	Required/Optional	Description
title	string	Optional	Page title
url	string	Required	Page URL
searchTerm	string	Optional	Search query string
utmSource	string	Optional	UTM source
utmMedium	string	Optional	UTM medium
utmCampaign	string	Optional	UTM campaign
linkId	string	Optional	Link ID

Send Event For ProductViewed

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test@gmail.com",
    "eventName": "productViewed",
    "eventProperties": {
        "productId": "PRODUCT_ID",
        "productName": "my-product",
        "variantId": "VARIANT_ID",
        "variantName": "VARIANT_NAME",
    }
}

Event properties for ProductViewed

Name	Type	Required/Optional	Description
productId	string	Required	Product ID
productName	string	Required	Product name
variantId	string	Required	Variant ID
variantName	string	Required	Variant name
url	string	Optional	Product URL
price	string	Optional	Product price
collectionNames	string[]	Optional	Collection names
collectionIds	string[]	Optional	Collection IDs
utmSource	string	Optional	UTM source
utmMedium	string	Optional	UTM medium
utmCampaign	string	Optional	UTM campaign
linkId	string	Optional	Link ID

Send Event For PaymentLinkUpdate

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test@gmail.com",
    "eventName": "paymentLinkUpdate",
    "eventProperties": {
        "id": "ID",
        "paymentId": "PAYMENT_ID",
        "paymentLink": "PAYMENT_LINK",
        "paymentLinkStatus": "PAYMENT_STATUS",
        "paymentAmount": "500",
        "orderId": "ORDER_ID",
        "orderAmount": "500",
        "purpose": "PURPOSE"
    }
}

Event properties for PaymentLinkUpdate

Name	Type	Required/Optional	Description
id	string	Required	Unique identifier
paymentId	string	Required	Payment ID
paymentLink	string	Required	Payment link URL
paymentLinkStatus	string	Required	Current payment link status
paymentAmount	number	Required	Payment amount
orderAmount	number	Required	Total order amount
orderId	string	Required	Order ID
purpose	string	Required	Purpose of the payment

Send Event For PurchasedAProduct

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test@gmail.com",
    "eventName": "purchasedAProduct",
    "eventProperties": {
        "productId": "PRODUCT_ID",
        "orderId": "test-order-id1234",
        "orderName": "my-order",
        "productName": "my-product",
        "itemPrice": 500,
        "currency": "INR",
        "customerId": "CUST_TEST_123"
        "variantId": "1234"
    }
}

Event properties for PurchasedAProduct

Name	Type	Required/Optional	Description
orderId	string	Required	Order ID
orderName	string	Required	Order name
productId	string	Required	Product ID
productName	string	Required	Product name
itemPrice	number	Required	Product price
currency	string	Required	Currency code
customerId	string	Optional	Customer ID
variantId	string	Required	Variant ID
variantName	string	Optional	Variant name
collectionNames	string[]	Optional	Collection names
collectionIds	string[]	Optional	Collection IDs
utmSource	string	Optional	UTM source
utmMedium	string	Optional	UTM medium
utmCampaign	string	Optional	UTM campaign
linkId	string	Optional	Order link ID
broadcastName	string	Optional	Broadcast name
broadcastId	string	Optional	Broadcast ID

Send Event For ReviewCreated

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test@gmail.com",
    "eventName": "reviewCreated",
    "eventProperties": {
        "id": "1234",
        "rating": 4
    }
}

Event properties for ReviewCreated

Name	Type	Required/Optional	Description
id	string	Optional	Unique identifier
rating	number	Optional	Review rating
title	string	Optional	Review title
body	string	Optional	Review body
partnerCustomerId	string	Optional	Reviewer customer ID
productId	string	Optional	Product ID
productName	string	Optional	Product name
email	string	Optional	Customer email address
name	string	Optional	Customer name

Send Event For UsedAPromoCode

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test@gmail.com",
    "eventName": "usedAPromoCode",
    "eventProperties": {
        "orderId": "test-order-id1234",
        "orderName": "my-order",
        "code": "CODE",
        "amount": 500,
        "type": "TYPE"
    }
}

Event properties for UsedAPromoCode

Name	Type	Required/Optional	Description
orderId	string	Required	Order ID
orderName	string	Required	Order name
code	string	Required	Coupon code
type	string	Required	Coupon type
amount	number	Required	Discount amount
utmSource	string	Optional	UTM source
utmMedium	string	Optional	UTM medium
utmCampaign	string	Optional	UTM campaign
linkId	string	Optional	Order link ID
broadcastName	string	Optional	Broadcast name
broadcastId	string	Optional	Broadcast ID

Send Event For AbandonedAProduct

"event": {
    "name": "NAME",
    "phoneNumber": "+91999909099",
    "email": "test@gmail.com",
    "eventName": "abandonedAProduct",
    "eventProperties": {
        "productId": "PRODUCT_ID",
        "cartId": "CART_ID",
        "productName": "my-product",
        "itemPrice": 500,
        "currency": "INR",
        "customerId": "CUST_TEST_123"
    }
}

Event properties for AbandonedAProduct

Name	Type	Required/Optional	Description
productId	string	Required	Product ID
productName	string	Required	Product name
variantId	string	Required	Variant ID
variantName	string	Required	Variant name
cartId	string	Optional	Cart ID
itemPrice	number	Required	Product price
currency	string	Optional	Currency code
customerId	string	Required	Customer ID
collectionNames	string[]	Optional	Collection names
collectionIds	string[]	Optional	Collection IDs
broadcastName	string	Optional	Broadcast name
broadcastId	string	Optional	Broadcast ID