The following are the complete set of events that are used to track the funnel on your website.
You can include the following predefined object properties with any events that support them. Format your parameter object data using JSON.
Last updated
| Function Name | Event Description | Mandatory Object Properties |
|---|---|---|
| Property Key | Parameter Description |
|---|---|
_osViewProduct
When a menu item appears in the view port
skuId, sellerId
_osViewRestaurant
A visit to a restaurant's page page (for example, landing page). A person lands on a product details page.
sellerId
_osAdd2Cart
When a product is added to the shopping cart. A person clicks on an add to cart button.
skuId, sellerId, quantity
_osSaleComplete
When a purchase is made or checkout flow is completed. A person has finished the purchase or checkout flow and lands on thank you or confirmation page.
skuId, sellerId, quantity, totalAmount, currency , orderId
category
Category of the product. This should be the same as what is given in the product catalog. While this is optional, this parameter is highly recommended.
productPrice
Price of the product without the currency symbol.
currency
Currency of the product price. Eg: "INR". This should be a 3 letter ISO standard
discount
Discounted price of the product.
skuId
The id of the product.
sellerId
The id of the restaurant who is selling this product. This is mandatory in case of aggregators.
quantity
Number of product quantity added to the cart. This is optional and defaults to 1
totalAmount
Total cart amount. Sum of all the product prices. This may include taxes / discounts in case of saleComplete event.
orderId
The order id which is generated and shown to the users on the website.
paymentMethod
The payment method used to complete the transaction
productName
Name of the menu item
imageUrl
Image URL of the menu item. This can be the same which is displayed on the product page