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.

Order checkedout

This event is generated to track orders checked out by the user, this is emitted after user has checked out the order. It provides essential information about the order and the cart being checked out. In contrast to order checkout which is emitted at checkout page, this event is triggered when user leaves the checkout screen after successfully checking out the order.

Events

click/order_checkedout/conversion/v1

# This event is emitted after the user has checked out the order.

Order Checkedout/order_checkedout/conversion/v1

This event is emitted after the user has checked out the order.

Payload

Properties

Event emitted when a user completes the checkout process for an order on the storefront.

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, typically "order_checkedout".

version

string

Required

Version of the event schema.

event_type

string

Required

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

Enum

cart_id

string

Required

Unique identifier for the shopping cart.

cart_total

number

Required

Total amount in the shopping cart before shipping and taxes.

shipping

number

Required

Shipping charges applied to the order.

order_id

string

Required

Unique identifier for the order.

tax

number

Required

Total tax applied to the order.

order_total

number

Required

Total amount of the order after shipping and taxes.

products

array of object

Required

List of products included in the order.

Array of Properties

product_id

integer

Required

Product ID.

l3_category

string

Required

Tertiary category of the product.

l1_category

string

Required

Primary category of the product.

quantity

integer

Required

Quantity of the product purchased.

price

number

Required

Price per unit of the product.

value

number

Required

Total value for the products.

currency

string

Required

Currency code (e.g., "INR").

article_id

string

Required

Article identifier for the product.

company_mode

string

Required

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

Enum

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

Company identifier.

event_timestamp

string

| date-time

Required

Timestamp of the event.

user_id

string|null

Identifier of the user performing the order checkedout 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    "event_type",
10    "cart_id",
11    "cart_total",
12    "shipping",
13    "order_id",
14    "tax",
15    "order_total",
16    "products",
17    "company_mode",
18    "company_created_on",
19    "company_id",
20    "version"
21  ],
22  "description": "Event emitted when a user completes the checkout process for an order on the storefront.",
23  "properties": {
24    "context": {
25      "type": "object",
26      "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.",
27      "properties": {
28        "library": {
29          "type": "object",
30          "description": "Library information which is sending the event.",
31          "properties": {
32            "name": {
33              "type": "string",
34              "description": "Name of the library sending the event.",
35              "example": "flick"
36            },
37            "version": {
38              "type": "string",
39              "description": "Version of the library.",
40              "example": "1.1.1"
41            }
42          },
43          "required": [
44            "name",
45            "version"
46          ]
47        },
48        "os": {
49          "type": "object",
50          "description": "Operating system details for the user device.",
51          "properties": {
52            "name": {
53              "type": "string",
54              "description": "OS name.",
55              "example": "Mac OS"
56            },
57            "version": {
58              "type": "string",
59              "description": "OS version.",
60              "example": "10.15.7"
61            }
62          },
63          "required": [
64            "name",
65            "version"
66          ]
67        },
68        "timezone": {
69          "type": "string",
70          "description": "User's timezone.",
71          "example": "Asia/Calcutta"
72        },
73        "screen": {
74          "type": "object",
75          "description": "Screen resolution details.",
76          "properties": {
77            "width": {
78              "type": "integer",
79              "description": "Screen width in pixels.",
80              "example": 1512
81            },
82            "height": {
83              "type": "integer",
84              "description": "Screen height in pixels.",
85              "example": 859
86            }
87          },
88          "required": [
89            "width",
90            "height"
91          ]
92        },
93        "user_agent": {
94          "type": "string",
95          "description": "User agent information.",
96          "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"
97        },
98        "locale": {
99          "type": "string",
100          "description": "User's locale information.",
101          "example": "en-GB"
102        },
103        "device": {
104          "type": "object",
105          "description": "User's device details.",
106          "properties": {
107            "is_mobile": {
108              "type": "boolean",
109              "description": "Indicates if the device is mobile or not.",
110              "example": false
111            }
112          },
113          "required": [
114            "is_mobile"
115          ]
116        }
117      },
118      "required": [
119        "library",
120        "os",
121        "timezone",
122        "screen",
123        "user_agent",
124        "locale",
125        "device"
126      ]
127    },
128    "event_id": {
129      "type": "string",
130      "description": "Unique identifier for the event."
131    },
132    "event_name": {
133      "type": "string",
134      "description": "Name of the event, typically \"order_checkedout\"."
135    },
136    "version": {
137      "type": "string",
138      "description": "Version of the event schema."
139    },
140    "event_type": {
141      "type": "string",
142      "description": "Type of the event (e.g., \"engagement\").",
143      "enum": [
144        "engagement",
145        "click",
146        "conversion",
147        "impression",
148        "search",
149        "identity"
150      ]
151    },
152    "cart_id": {
153      "type": "string",
154      "description": "Unique identifier for the shopping cart."
155    },
156    "cart_total": {
157      "type": "number",
158      "description": "Total amount in the shopping cart before shipping and taxes."
159    },
160    "shipping": {
161      "type": "number",
162      "description": "Shipping charges applied to the order."
163    },
164    "order_id": {
165      "type": "string",
166      "description": "Unique identifier for the order."
167    },
168    "tax": {
169      "type": "number",
170      "description": "Total tax applied to the order."
171    },
172    "order_total": {
173      "type": "number",
174      "description": "Total amount of the order after shipping and taxes."
175    },
176    "products": {
177      "type": "array",
178      "description": "List of products included in the order.",
179      "items": {
180        "type": "object",
181        "description": "Details of each product in the order.",
182        "properties": {
183          "product_id": {
184            "type": "integer",
185            "description": "Product ID."
186          },
187          "l3_category": {
188            "type": "string",
189            "x-not-enum": true,
190            "description": "Tertiary category of the product."
191          },
192          "l1_category": {
193            "type": "string",
194            "x-not-enum": true,
195            "description": "Primary category of the product."
196          },
197          "quantity": {
198            "type": "integer",
199            "description": "Quantity of the product purchased."
200          },
201          "price": {
202            "type": "number",
203            "description": "Price per unit of the product."
204          },
205          "value": {
206            "type": "number",
207            "description": "Total value for the products."
208          },
209          "currency": {
210            "type": "string",
211            "description": "Currency code (e.g., \"INR\")."
212          },
213          "article_id": {
214            "type": "string",
215            "description": "Article identifier for the product."
216          }
217        },
218        "required": [
219          "product_id",
220          "l3_category",
221          "l1_category",
222          "quantity",
223          "price",
224          "value",
225          "currency",
226          "article_id"
227        ]
228      }
229    },
230    "company_mode": {
231      "type": "string",
232      "description": "Mode of the company (e.g., \"live\", \"development\").",
233      "enum": [
234        "live",
235        "development"
236      ]
237    },
238    "company_created_on": {
239      "type": "string",
240      "format": "date-time",
241      "description": "Timestamp or detailed information indicating when the company was created. Can be an ISO 8601 string or a complex object with additional details."
242    },
243    "company_id": {
244      "type": "integer",
245      "description": "Company identifier."
246    },
247    "event_timestamp": {
248      "type": "string",
249      "format": "date-time",
250      "description": "Timestamp of the event."
251    },
252    "user_id": {
253      "type": [
254        "string",
255        "null"
256      ],
257      "description": "Identifier of the user performing the order checkedout action. Use `null` if the user is anonymous."
258    },
259    "anonymous_id": {
260      "type": "string",
261      "description": "Anonymous identifier assigned to the user if they are not logged in."
262    }
263  }
264}

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_1234567890",
23  "event_name": "order_checkedout",
24  "version": "1",
25  "event_timestamp": "2025-01-31T12:34:56Z",
26  "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",
27  "event_type": "engagement",
28  "cart_id": "cart_9876543210",
29  "cart_total": 250.75,
30  "shipping": 15,
31  "order_id": "order_1234567890",
32  "tax": 20,
33  "order_total": 285.75,
34  "products": [
35    {
36      "product_id": 4001,
37      "l3_category": "Electronics",
38      "l1_category": "Home Appliances",
39      "quantity": 1,
40      "price": 200,
41      "value": 200,
42      "currency": "USD",
43      "article_id": "A123"
44    },
45    {
46      "product_id": 4002,
47      "l3_category": "Accessories",
48      "l1_category": "Mobile Accessories",
49      "quantity": 2,
50      "price": 25,
51      "value": 50,
52      "currency": "USD",
53      "article_id": "A124"
54    }
55  ],
56  "company_mode": "live",
57  "company_created_on": "2020-05-20T08:30:00Z",
58  "company_id": 1234,
59  "user_id": "user_12345"
60}

« location_details/click/v1

order_checkout/conversion/v1 »