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 checkout

This event is generated to track order checkout events, indicating when a user is checking out an order. It provides essential information about the order and its contents. This event is generated when a user visits the checkout page on the storefront.

Events

click/order_checkout/conversion/v1

# This event is emitted when a user proceeds to checkout an order

Order Checkout/order_checkout/conversion/v1

This event is emitted when a user proceeds to checkout an order

Payload

Properties

Event emitted when a user is checking out an order by visiting the checkout page 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 order checkout event.

event_name

string

Required

Name of the event, typically "order_checkout".

event_type

string

Required

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

Enum

cart_id

string

Required

Unique identifier for the shopping cart associated with the order.

cart_total

number

Total amount of the cart before taxes and shipping.

shipping

number

Shipping cost associated with the order.

order_id

string

Unique identifier for the order.

tax

number

Tax amount applied to the order.

order_total

number

Total amount of the order including taxes and shipping.

products

array of object

List of products included in the order.

Array of Properties

product_id

integer

Required

Unique identifier for the product being ordered.

l3_category

string

Required

Tertiary category of the product.

l1_category

string

Required

Primary category of the product.

quantity

integer

Required

Number of units of the product in the order.

price

number

Required

Price per unit of the product.

value

number

Required

Total value for the product (price multiplied by quantity).

currency

string

Required

Currency code (e.g., "USD", "INR") used for the product price.

article_id

string

Required

Unique identifier for the article associated with 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

string

Required

Unique identifier for the company associated with the event.

version

string

Required

Version of the event schema.

event_timestamp

string

| date-time

Required

ISO 8601 timestamp indicating when the event occurred.

user_id

string|null

Identifier of the user performing the order checkout action. Use `"null"` if the user is anonymous.

anonymous_id

string

Required

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

utm_medium

string

Marketing medium through which the user arrived at the product (e.g., "email", "cpc").

utm_source

string

Marketing source driving the traffic to the product (e.g., "newsletter", "google").

utm_campaign

string

Specific marketing campaign associated with the product checkout.

source_url

string

Required

URL from which the product was added to the cart.

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "context",
5    "event_id",
6    "event_name",
7    "event_timestamp",
8    "anonymous_id",
9    "article_id",
10    "brand",
11    "cart_id",
12    "company_created_on",
13    "company_id",
14    "company_mode",
15    "currency",
16    "event_type",
17    "l1_category",
18    "l3_category",
19    "price",
20    "product_id",
21    "quantity",
22    "source_url",
23    "value",
24    "version"
25  ],
26  "description": "Event emitted when a user is checking out an order by visiting the checkout page on the storefront.",
27  "properties": {
28    "context": {
29      "type": "object",
30      "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.",
31      "properties": {
32        "library": {
33          "type": "object",
34          "description": "Library information which is sending the event.",
35          "properties": {
36            "name": {
37              "type": "string",
38              "description": "Name of the library sending the event.",
39              "example": "flick"
40            },
41            "version": {
42              "type": "string",
43              "description": "Version of the library.",
44              "example": "1.1.1"
45            }
46          },
47          "required": [
48            "name",
49            "version"
50          ]
51        },
52        "os": {
53          "type": "object",
54          "description": "Operating system details for the user device.",
55          "properties": {
56            "name": {
57              "type": "string",
58              "description": "OS name.",
59              "example": "Mac OS"
60            },
61            "version": {
62              "type": "string",
63              "description": "OS version.",
64              "example": "10.15.7"
65            }
66          },
67          "required": [
68            "name",
69            "version"
70          ]
71        },
72        "timezone": {
73          "type": "string",
74          "description": "User's timezone.",
75          "example": "Asia/Calcutta"
76        },
77        "screen": {
78          "type": "object",
79          "description": "Screen resolution details.",
80          "properties": {
81            "width": {
82              "type": "integer",
83              "description": "Screen width in pixels.",
84              "example": 1512
85            },
86            "height": {
87              "type": "integer",
88              "description": "Screen height in pixels.",
89              "example": 859
90            }
91          },
92          "required": [
93            "width",
94            "height"
95          ]
96        },
97        "user_agent": {
98          "type": "string",
99          "description": "User agent information.",
100          "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"
101        },
102        "locale": {
103          "type": "string",
104          "description": "User's locale information.",
105          "example": "en-GB"
106        },
107        "device": {
108          "type": "object",
109          "description": "User's device details.",
110          "properties": {
111            "is_mobile": {
112              "type": "boolean",
113              "description": "Indicates if the device is mobile or not.",
114              "example": false
115            }
116          },
117          "required": [
118            "is_mobile"
119          ]
120        }
121      },
122      "required": [
123        "library",
124        "os",
125        "timezone",
126        "screen",
127        "user_agent",
128        "locale",
129        "device"
130      ]
131    },
132    "event_id": {
133      "type": "string",
134      "description": "Unique identifier for the order checkout event."
135    },
136    "event_name": {
137      "type": "string",
138      "description": "Name of the event, typically \"order_checkout\"."
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 associated with the order."
155    },
156    "cart_total": {
157      "type": "number",
158      "description": "Total amount of the cart before taxes and shipping."
159    },
160    "shipping": {
161      "type": "number",
162      "description": "Shipping cost associated with the order."
163    },
164    "order_id": {
165      "type": "string",
166      "description": "Unique identifier for the order."
167    },
168    "tax": {
169      "type": "number",
170      "description": "Tax amount applied to the order."
171    },
172    "order_total": {
173      "type": "number",
174      "description": "Total amount of the order including taxes and shipping."
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": "Unique identifier for the product being ordered."
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": "Number of units of the product in the order."
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 product (price multiplied by quantity)."
208          },
209          "currency": {
210            "type": "string",
211            "description": "Currency code (e.g., \"USD\", \"INR\") used for the product price."
212          },
213          "article_id": {
214            "type": "string",
215            "description": "Unique identifier for the article associated with 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": "string",
245      "description": "Unique identifier for the company associated with the event."
246    },
247    "version": {
248      "type": "string",
249      "description": "Version of the event schema."
250    },
251    "event_timestamp": {
252      "type": "string",
253      "format": "date-time",
254      "description": "ISO 8601 timestamp indicating when the event occurred."
255    },
256    "user_id": {
257      "type": [
258        "string",
259        "null"
260      ],
261      "description": "Identifier of the user performing the order checkout action. Use `\"null\"` if the user is anonymous."
262    },
263    "anonymous_id": {
264      "type": "string",
265      "description": "Anonymous identifier assigned to the user if they are not logged in."
266    },
267    "utm_medium": {
268      "type": "string",
269      "description": "Marketing medium through which the user arrived at the product (e.g., \"email\", \"cpc\")."
270    },
271    "utm_source": {
272      "type": "string",
273      "description": "Marketing source driving the traffic to the product (e.g., \"newsletter\", \"google\")."
274    },
275    "utm_campaign": {
276      "type": "string",
277      "description": "Specific marketing campaign associated with the product checkout."
278    },
279    "source_url": {
280      "type": "string",
281      "description": "URL from which the product was added to the cart."
282    }
283  }
284}

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_checkout",
24  "event_type": "engagement",
25  "cart_id": "cart_67890",
26  "cart_total": 500.75,
27  "shipping": 50,
28  "order_id": "order_9876543210",
29  "tax": 30.5,
30  "order_total": 581.25,
31  "products": [
32    {
33      "product_id": 7818334,
34      "l3_category": "Sweatshirts",
35      "l1_category": "Clothing",
36      "quantity": 1,
37      "price": 150.75,
38      "currency": "INR",
39      "article_id": "art_9876543210"
40    }
41  ],
42  "company_mode": "live",
43  "company_created_on": "2020-05-20T08:30:00Z",
44  "company_id": "comp_123456",
45  "version": "1",
46  "event_timestamp": "2025-01-31T12:34:56Z",
47  "user_id": "user_12345",
48  "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",
49  "utm_medium": "product_recommendation",
50  "utm_source": "product_page",
51  "utm_campaign": "similar_products",
52  "source_url": "https://www.example.com/product/7818334"
53}

« order_checkedout/conversion/v1

order_complete/conversion/v1 »