Click

Events categorized under the click level are utilized to monitor and analyze user interactions within the storefront. For instance, tracking when a user adds a product to the cart or initiates a login process.

Remove from cart

This event is triggered when a user removes a product from their shopping cart within the storefront. It captures details such as cart ID, product details, price, and user information, providing insights into user behavior and cart management.

Events

click/remove_from_cart/engagement/v1

# This event is triggered when a user removes a product from their shopping cart within the storefront.

Remove From Cart/remove_from_cart/engagement/v1

This event is triggered when a user removes a product from their shopping cart within the storefront.

Payload

Properties

Event emitted when a user removes an item from the cart.

context

object

Required

Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.

Properties

library

object

Required

Library information which is sending the event.

Properties

name

string

Required

Name of the library sending the event.

version

string

Required

Version of the library.

object

Required

Operating system details for the user device.

Properties

name

string

Required

OS name.

version

string

Required

OS version.

timezone

string

Required

User's timezone.

screen

object

Required

Screen resolution details.

Properties

width

integer

Required

Screen width in pixels.

height

integer

Required

Screen height in pixels.

user_agent

string

Required

User agent information.

locale

string

Required

User's locale information.

device

object

Required

User's device details.

Properties

is_mobile

boolean

Required

Indicates if the device is mobile or not.

event_id

string

Required

Unique identifier for the event.

event_name

string

Required

Name of the event.

brand

string

Required

Brand name of the product.

cart_id

string

Required

Unique identifier for the shopping cart.

company_created_on

string

| date-time

Required

Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details.

company_id

integer

Required

Unique identifier for the company.

company_mode

string

Required

Mode of the company (e.g., "live", "development").

Enum

currency

string

Required

Currency used for the product price.

event_type

string

Required

Type of the event (e.g., "engagement").

Enum

l1_category

string

Required

Category level 1 of the product.

l3_category

string

Required

Category level 3 of the product.

price

number

Required

Price of the product in the specified currency.

product_id

integer

Required

Unique identifier for the product being removed from the cart.

quantity

integer

Required

Quantity of the product removed from the cart.

source_url

string

Required

URL source of the product.

version

string

Required

Version of the event.

user_id

string|null

Identifier of the user performing the remove from cart action. Use `null` if the user is anonymous.

anonymous_id

string

Required

Anonymous identifier assigned to the user if they are not logged in.

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "context",
5    "event_id",
6    "event_name",
7    "event_timestamp",
8    "anonymous_id",
9    "brand",
10    "cart_id",
11    "company_created_on",
12    "company_id",
13    "company_mode",
14    "currency",
15    "event_type",
16    "l1_category",
17    "l3_category",
18    "price",
19    "product_id",
20    "quantity",
21    "source_url",
22    "version"
23  ],
24  "description": "Event emitted when a user removes an item from the cart.",
25  "properties": {
26    "context": {
27      "type": "object",
28      "description": "Context information related to the environment where the event occurred. This includes details about the library generating the event, the operating system, user timezone, screen resolution, user agent, locale, and device specifications.",
29      "properties": {
30        "library": {
31          "type": "object",
32          "description": "Library information which is sending the event.",
33          "properties": {
34            "name": {
35              "type": "string",
36              "description": "Name of the library sending the event.",
37              "example": "flick"
38            },
39            "version": {
40              "type": "string",
41              "description": "Version of the library.",
42              "example": "1.1.1"
43            }
44          },
45          "required": [
46            "name",
47            "version"
48          ]
49        },
50        "os": {
51          "type": "object",
52          "description": "Operating system details for the user device.",
53          "properties": {
54            "name": {
55              "type": "string",
56              "description": "OS name.",
57              "example": "Mac OS"
58            },
59            "version": {
60              "type": "string",
61              "description": "OS version.",
62              "example": "10.15.7"
63            }
64          },
65          "required": [
66            "name",
67            "version"
68          ]
69        },
70        "timezone": {
71          "type": "string",
72          "description": "User's timezone.",
73          "example": "Asia/Calcutta"
74        },
75        "screen": {
76          "type": "object",
77          "description": "Screen resolution details.",
78          "properties": {
79            "width": {
80              "type": "integer",
81              "description": "Screen width in pixels.",
82              "example": 1512
83            },
84            "height": {
85              "type": "integer",
86              "description": "Screen height in pixels.",
87              "example": 859
88            }
89          },
90          "required": [
91            "width",
92            "height"
93          ]
94        },
95        "user_agent": {
96          "type": "string",
97          "description": "User agent information.",
98          "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36"
99        },
100        "locale": {
101          "type": "string",
102          "description": "User's locale information.",
103          "example": "en-GB"
104        },
105        "device": {
106          "type": "object",
107          "description": "User's device details.",
108          "properties": {
109            "is_mobile": {
110              "type": "boolean",
111              "description": "Indicates if the device is mobile or not.",
112              "example": false
113            }
114          },
115          "required": [
116            "is_mobile"
117          ]
118        }
119      },
120      "required": [
121        "library",
122        "os",
123        "timezone",
124        "screen",
125        "user_agent",
126        "locale",
127        "device"
128      ]
129    },
130    "event_id": {
131      "type": "string",
132      "description": "Unique identifier for the event."
133    },
134    "event_name": {
135      "type": "string",
136      "description": "Name of the event."
137    },
138    "brand": {
139      "type": "string",
140      "description": "Brand name of the product."
141    },
142    "cart_id": {
143      "type": "string",
144      "description": "Unique identifier for the shopping cart."
145    },
146    "company_created_on": {
147      "type": "string",
148      "format": "date-time",
149      "description": "Timestamp or detailed information indicating when the company was created.\nCan be an ISO 8601 string or a complex object with additional details.\n"
150    },
151    "company_id": {
152      "type": "integer",
153      "description": "Unique identifier for the company."
154    },
155    "company_mode": {
156      "type": "string",
157      "description": "Mode of the company (e.g., \"live\", \"development\").",
158      "enum": [
159        "live",
160        "development"
161      ]
162    },
163    "currency": {
164      "type": "string",
165      "description": "Currency used for the product price."
166    },
167    "event_type": {
168      "type": "string",
169      "description": "Type of the event (e.g., \"engagement\").",
170      "enum": [
171        "engagement",
172        "click",
173        "conversion",
174        "impression",
175        "search",
176        "identity"
177      ]
178    },
179    "l1_category": {
180      "type": "string",
181      "x-not-enum": true,
182      "description": "Category level 1 of the product."
183    },
184    "l3_category": {
185      "type": "string",
186      "x-not-enum": true,
187      "description": "Category level 3 of the product."
188    },
189    "price": {
190      "type": "number",
191      "description": "Price of the product in the specified currency."
192    },
193    "product_id": {
194      "type": "integer",
195      "description": "Unique identifier for the product being removed from the cart."
196    },
197    "quantity": {
198      "type": "integer",
199      "description": "Quantity of the product removed from the cart."
200    },
201    "source_url": {
202      "type": "string",
203      "description": "URL source of the product."
204    },
205    "version": {
206      "type": "string",
207      "description": "Version of the event."
208    },
209    "user_id": {
210      "type": [
211        "string",
212        "null"
213      ],
214      "description": "Identifier of the user performing the remove from cart action. Use `null` if the user is anonymous."
215    },
216    "anonymous_id": {
217      "type": "string",
218      "description": "Anonymous identifier assigned to the user if they are not logged in."
219    }
220  }
221}

Payload Example

1{
2  "context": {
3    "library": {
4      "name": "flick",
5      "version": "1.0.4"
6    },
7    "os": {
8      "name": "Mac OS",
9      "version": "10.15.7"
10    },
11    "timezone": "Asia/Calcutta",
12    "screen": {
13      "width": 1512,
14      "height": 859
15    },
16    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36",
17    "locale": "en-GB",
18    "device": {
19      "is_mobile": false
20    }
21  },
22  "event_id": "evt_9876543210",
23  "event_name": "remove_from_cart",
24  "event_timestamp": "2025-01-31T12:34:56Z",
25  "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",
26  "brand": "Armani Exchange",
27  "cart_id": "664c6d8f9279128152fb551b",
28  "company_created_on": "2020-05-20T08:30:00Z",
29  "company_id": 123456,
30  "company_mode": "online",
31  "currency": "INR",
32  "event_type": "engagement",
33  "l1_category": "Clothing",
34  "l3_category": "Sweatshirts",
35  "price": 100.5,
36  "product_id": 7818334,
37  "quantity": 1,
38  "source_url": "https://www.example.com/product/7818334",
39  "version": "1",
40  "user_id": null
41}

« product_wishlist_remove/engagement/v1

user_login/identity/v1 »