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 complete

This event is generated to track order completion events, indicating when a user order has been successfully completed. It provides detailed information about the completed order, including item details, shipment information, and user data.

Events

click/order_complete/conversion/v1

# This event is triggered when a user completes an order on the storefront. It includes detailed information about the order, its contents, and the context in which the order was completed.

Order Complete/order_complete/conversion/v1

This event is triggered when a user completes an order on the storefront. It includes detailed information about the order, its contents, and the context in which the order was completed.

Payload

Properties

Event emitted when a user completes 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_complete".

event_timestamp

string

| date-time

Required

ISO 8601 timestamp indicating when the event occurred.

version

string

Required

Version of the event schema.

event_type

string

Required

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

Enum

order_id

string

Required

Unique identifier for the order.

status

string

Required

Status of the order (e.g., "completed").

breakup_values_raw

object

Required

Detailed breakdown of the order's financials.

Properties

mrp_total

number

Required

Total Maximum Retail Price of all products.

discount

number

Required

Total discount applied to the order.

sub_total

number

Required

Subtotal amount before additional charges.

promotion

number

Required

Total promotion discounts applied.

coupon

number

Required

Total coupon discounts applied.

reward_points

number

Required

Reward points used in the order.

cashback_applied

number

Required

Cashback applied to the order.

cod_charges

number

Required

Cash on Delivery charges, if applicable.

gift_price

number

Required

Total price of gifts included in the order.

delivery_charges

number

Required

Delivery charges for the order.

total

number

Required

Total amount of the order after all adjustments.

shipments

array of object

Required

List of shipments associated with the order.

Array of Properties

shipment_id

string

Required

Unique identifier for the shipment.

status

string

Required

Status of the shipment.

payment_mode

string

Required

Payment mode used for the shipment (e.g., "credit_card", "paypal").

items

array of object

Required

List of items included in the order.

Array of Properties

name

string

Required

Name of the product.

brand

object

Required

Brand details of the product.

Properties

name

string

Required

Name of the brand.

logo

string

Required

URL to the brand's logo.

image

array of string

Required

List of image URLs for the product.

slug_key

string

Required

Slug key for the product URL.

size

string|null

Required

Size of the product. Use `null` if not applicable.

code

string

Required

Unique code for the product.

integer

Required

Unique identifier for the product.

category

array of string

Required

List of categories the product belongs to.

l3_category_name

string

Required

Tertiary category name of the product.

l1_categories

array of string

Required

Primary categories of the product.

l2_categories

array of string

Required

Secondary categories of the product.

seller_identifier

string

Required

Identifier for the seller of the product.

attributes

object

Required

Additional attributes of the product.

Properties

brand_name

string

Name of the brand.

media

array|null

List of media URLs related to the product. Use `null` if not applicable.

price

number

Required

Price per unit of the product.

quantity

integer

Required

Quantity of the product ordered.

event_action

string

Required

Specific action related to the event (e.g., "complete_order").

screen

string

Required

Name of the screen where the event occurred.

utm_params

object

Required

UTM parameters associated with the order.

Properties

utm_content

string

Required

Content identifier for the campaign.

utm_medium

string

Required

Marketing medium (e.g., "email", "cpc").

utm_campaign

string

Required

Name of the marketing campaign.

utm_source

string

Required

Source of the marketing traffic (e.g., "newsletter", "google").

screen_view

string

Required

Identifier for the screen view.

user

object

Required

User details.

Properties

_id

string

Required

Unique identifier for the user.

username

string

Required

Username of the user.

emails

array|string

Required

List of user's email addresses.

gender

string

Required

Gender of the user.

active

boolean

Required

Indicates if the user's account is active.

first_name

string

Required

First name of the user.

last_name

string

Required

Last name of the user.

phone_numbers

array|string

Required

List of user's phone numbers.

account_type

string

Required

Type of the user's account.

profile_pic_url

string

Required

URL to the user's profile picture.

user_id

string

Required

Unique identifier for the user in the system.

application_id

string

Required

Identifier for the storefront which user is on.

created_at

string

Required

Timestamp indicating when the user account was created.

updated_at

string

Required

Timestamp indicating when the user account was last updated.

company_id

integer

Required

Unique identifier for the company associated with the event.

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.

user_id

string|null

Identifier of the user performing the order complete 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    "order_id",
11    "status",
12    "breakup_values_raw",
13    "shipments",
14    "items",
15    "event_action",
16    "screen",
17    "utm_params",
18    "screen_view",
19    "user",
20    "company_id",
21    "company_mode",
22    "company_created_on",
23    "version"
24  ],
25  "description": "Event emitted when a user completes an order on the storefront.",
26  "properties": {
27    "context": {
28      "type": "object",
29      "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.",
30      "properties": {
31        "library": {
32          "type": "object",
33          "description": "Library information which is sending the event.",
34          "properties": {
35            "name": {
36              "type": "string",
37              "description": "Name of the library sending the event.",
38              "example": "flick"
39            },
40            "version": {
41              "type": "string",
42              "description": "Version of the library.",
43              "example": "1.1.1"
44            }
45          },
46          "required": [
47            "name",
48            "version"
49          ]
50        },
51        "os": {
52          "type": "object",
53          "description": "Operating system details for the user device.",
54          "properties": {
55            "name": {
56              "type": "string",
57              "description": "OS name.",
58              "example": "Mac OS"
59            },
60            "version": {
61              "type": "string",
62              "description": "OS version.",
63              "example": "10.15.7"
64            }
65          },
66          "required": [
67            "name",
68            "version"
69          ]
70        },
71        "timezone": {
72          "type": "string",
73          "description": "User's timezone.",
74          "example": "Asia/Calcutta"
75        },
76        "screen": {
77          "type": "object",
78          "description": "Screen resolution details.",
79          "properties": {
80            "width": {
81              "type": "integer",
82              "description": "Screen width in pixels.",
83              "example": 1512
84            },
85            "height": {
86              "type": "integer",
87              "description": "Screen height in pixels.",
88              "example": 859
89            }
90          },
91          "required": [
92            "width",
93            "height"
94          ]
95        },
96        "user_agent": {
97          "type": "string",
98          "description": "User agent information.",
99          "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"
100        },
101        "locale": {
102          "type": "string",
103          "description": "User's locale information.",
104          "example": "en-GB"
105        },
106        "device": {
107          "type": "object",
108          "description": "User's device details.",
109          "properties": {
110            "is_mobile": {
111              "type": "boolean",
112              "description": "Indicates if the device is mobile or not.",
113              "example": false
114            }
115          },
116          "required": [
117            "is_mobile"
118          ]
119        }
120      },
121      "required": [
122        "library",
123        "os",
124        "timezone",
125        "screen",
126        "user_agent",
127        "locale",
128        "device"
129      ]
130    },
131    "event_id": {
132      "type": "string",
133      "description": "Unique identifier for the event."
134    },
135    "event_name": {
136      "type": "string",
137      "description": "Name of the event, typically \"order_complete\"."
138    },
139    "event_timestamp": {
140      "type": "string",
141      "format": "date-time",
142      "description": "ISO 8601 timestamp indicating when the event occurred."
143    },
144    "version": {
145      "type": "string",
146      "description": "Version of the event schema."
147    },
148    "event_type": {
149      "type": "string",
150      "description": "Type of the event (e.g., \"engagement\").",
151      "enum": [
152        "engagement",
153        "click",
154        "conversion",
155        "impression",
156        "search",
157        "identity"
158      ]
159    },
160    "order_id": {
161      "type": "string",
162      "description": "Unique identifier for the order."
163    },
164    "status": {
165      "type": "string",
166      "description": "Status of the order (e.g., \"completed\")."
167    },
168    "breakup_values_raw": {
169      "type": "object",
170      "description": "Detailed breakdown of the order's financials.",
171      "properties": {
172        "mrp_total": {
173          "type": "number",
174          "description": "Total Maximum Retail Price of all products."
175        },
176        "discount": {
177          "type": "number",
178          "description": "Total discount applied to the order."
179        },
180        "sub_total": {
181          "type": "number",
182          "description": "Subtotal amount before additional charges."
183        },
184        "promotion": {
185          "type": "number",
186          "description": "Total promotion discounts applied."
187        },
188        "coupon": {
189          "type": "number",
190          "description": "Total coupon discounts applied."
191        },
192        "reward_points": {
193          "type": "number",
194          "description": "Reward points used in the order."
195        },
196        "cashback_applied": {
197          "type": "number",
198          "description": "Cashback applied to the order."
199        },
200        "cod_charges": {
201          "type": "number",
202          "description": "Cash on Delivery charges, if applicable."
203        },
204        "gift_price": {
205          "type": "number",
206          "description": "Total price of gifts included in the order."
207        },
208        "delivery_charges": {
209          "type": "number",
210          "description": "Delivery charges for the order."
211        },
212        "total": {
213          "type": "number",
214          "description": "Total amount of the order after all adjustments."
215        }
216      },
217      "required": [
218        "mrp_total",
219        "discount",
220        "sub_total",
221        "promotion",
222        "coupon",
223        "reward_points",
224        "cashback_applied",
225        "cod_charges",
226        "gift_price",
227        "delivery_charges",
228        "total"
229      ]
230    },
231    "shipments": {
232      "type": "array",
233      "description": "List of shipments associated with the order.",
234      "items": {
235        "type": "object",
236        "description": "Details of each shipment.",
237        "properties": {
238          "shipment_id": {
239            "type": "string",
240            "description": "Unique identifier for the shipment."
241          },
242          "status": {
243            "type": "string",
244            "description": "Status of the shipment."
245          },
246          "payment_mode": {
247            "type": "string",
248            "description": "Payment mode used for the shipment (e.g., \"credit_card\", \"paypal\")."
249          }
250        },
251        "required": [
252          "shipment_id",
253          "status",
254          "payment_mode"
255        ]
256      }
257    },
258    "items": {
259      "type": "array",
260      "description": "List of items included in the order.",
261      "items": {
262        "type": "object",
263        "description": "Details of each item in the order.",
264        "properties": {
265          "name": {
266            "type": "string",
267            "description": "Name of the product."
268          },
269          "brand": {
270            "type": "object",
271            "description": "Brand details of the product.",
272            "properties": {
273              "name": {
274                "type": "string",
275                "description": "Name of the brand."
276              },
277              "logo": {
278                "type": "string",
279                "description": "URL to the brand's logo."
280              }
281            },
282            "required": [
283              "name",
284              "logo"
285            ]
286          },
287          "image": {
288            "type": "array",
289            "description": "List of image URLs for the product.",
290            "items": {
291              "type": "string"
292            }
293          },
294          "slug_key": {
295            "type": "string",
296            "description": "Slug key for the product URL."
297          },
298          "size": {
299            "type": [
300              "string",
301              "null"
302            ],
303            "description": "Size of the product. Use `null` if not applicable."
304          },
305          "code": {
306            "type": "string",
307            "description": "Unique code for the product."
308          },
309          "id": {
310            "type": "integer",
311            "description": "Unique identifier for the product."
312          },
313          "category": {
314            "type": "array",
315            "description": "List of categories the product belongs to.",
316            "items": {
317              "type": "string"
318            }
319          },
320          "l3_category_name": {
321            "type": "string",
322            "description": "Tertiary category name of the product."
323          },
324          "l1_categories": {
325            "type": "array",
326            "x-not-enum": true,
327            "description": "Primary categories of the product.",
328            "items": {
329              "type": "string"
330            }
331          },
332          "l2_categories": {
333            "type": "array",
334            "description": "Secondary categories of the product.",
335            "items": {
336              "type": "string"
337            }
338          },
339          "seller_identifier": {
340            "type": "string",
341            "description": "Identifier for the seller of the product."
342          },
343          "attributes": {
344            "type": "object",
345            "description": "Additional attributes of the product.",
346            "properties": {
347              "brand_name": {
348                "type": "string",
349                "description": "Name of the brand."
350              },
351              "media": {
352                "type": [
353                  "array",
354                  "null"
355                ],
356                "description": "List of media URLs related to the product. Use `null` if not applicable.",
357                "items": {
358                  "type": "string"
359                }
360              }
361            }
362          },
363          "price": {
364            "type": "number",
365            "description": "Price per unit of the product."
366          },
367          "quantity": {
368            "type": "integer",
369            "description": "Quantity of the product ordered."
370          }
371        },
372        "required": [
373          "name",
374          "brand",
375          "image",
376          "slug_key",
377          "size",
378          "code",
379          "id",
380          "category",
381          "l3_category_name",
382          "l1_categories",
383          "l2_categories",
384          "seller_identifier",
385          "attributes",
386          "price",
387          "quantity"
388        ]
389      }
390    },
391    "event_action": {
392      "type": "string",
393      "description": "Specific action related to the event (e.g., \"complete_order\")."
394    },
395    "screen": {
396      "type": "string",
397      "description": "Name of the screen where the event occurred."
398    },
399    "utm_params": {
400      "type": "object",
401      "description": "UTM parameters associated with the order.",
402      "properties": {
403        "utm_content": {
404          "type": "string",
405          "description": "Content identifier for the campaign."
406        },
407        "utm_medium": {
408          "type": "string",
409          "description": "Marketing medium (e.g., \"email\", \"cpc\")."
410        },
411        "utm_campaign": {
412          "type": "string",
413          "description": "Name of the marketing campaign."
414        },
415        "utm_source": {
416          "type": "string",
417          "description": "Source of the marketing traffic (e.g., \"newsletter\", \"google\")."
418        }
419      },
420      "required": [
421        "utm_content",
422        "utm_medium",
423        "utm_campaign",
424        "utm_source"
425      ]
426    },
427    "screen_view": {
428      "type": "string",
429      "description": "Identifier for the screen view."
430    },
431    "user": {
432      "type": "object",
433      "description": "User details.",
434      "properties": {
435        "_id": {
436          "type": "string",
437          "description": "Unique identifier for the user."
438        },
439        "username": {
440          "type": "string",
441          "description": "Username of the user."
442        },
443        "emails": {
444          "type": [
445            "array",
446            "string"
447          ],
448          "description": "List of user's email addresses.",
449          "items": {
450            "type": "object",
451            "description": "Details of each email address.",
452            "properties": {
453              "email": {
454                "type": "string",
455                "description": "Email address."
456              },
457              "active": {
458                "type": "boolean",
459                "description": "Indicates if the email is active."
460              },
461              "primary": {
462                "type": "boolean",
463                "description": "Indicates if the email is primary."
464              },
465              "verified": {
466                "type": "boolean",
467                "description": "Indicates if the email is verified."
468              }
469            },
470            "required": [
471              "email",
472              "active",
473              "primary",
474              "verified"
475            ]
476          }
477        },
478        "gender": {
479          "type": "string",
480          "description": "Gender of the user."
481        },
482        "active": {
483          "type": "boolean",
484          "description": "Indicates if the user's account is active."
485        },
486        "first_name": {
487          "type": "string",
488          "description": "First name of the user."
489        },
490        "last_name": {
491          "type": "string",
492          "description": "Last name of the user."
493        },
494        "phone_numbers": {
495          "type": [
496            "array",
497            "string"
498          ],
499          "description": "List of user's phone numbers.",
500          "items": {
501            "type": "object",
502            "description": "Details of each phone number.",
503            "properties": {
504              "phone": {
505                "type": "string",
506                "description": "Phone number."
507              },
508              "active": {
509                "type": "boolean",
510                "description": "Indicates if the phone number is active."
511              },
512              "primary": {
513                "type": "boolean",
514                "description": "Indicates if the phone number is primary."
515              },
516              "verified": {
517                "type": "boolean",
518                "description": "Indicates if the phone number is verified."
519              },
520              "country_code": {
521                "type": "integer",
522                "description": "Country code of the phone number."
523              }
524            },
525            "required": [
526              "phone",
527              "active",
528              "primary",
529              "verified",
530              "country_code"
531            ]
532          }
533        },
534        "account_type": {
535          "type": "string",
536          "description": "Type of the user's account."
537        },
538        "profile_pic_url": {
539          "type": "string",
540          "description": "URL to the user's profile picture."
541        },
542        "user_id": {
543          "type": "string",
544          "description": "Unique identifier for the user in the system."
545        },
546        "application_id": {
547          "type": "string",
548          "description": "Identifier for the storefront which user is on."
549        },
550        "created_at": {
551          "type": "string",
552          "description": "Timestamp indicating when the user account was created."
553        },
554        "updated_at": {
555          "type": "string",
556          "description": "Timestamp indicating when the user account was last updated."
557        }
558      },
559      "required": [
560        "_id",
561        "username",
562        "emails",
563        "gender",
564        "active",
565        "first_name",
566        "last_name",
567        "phone_numbers",
568        "account_type",
569        "profile_pic_url",
570        "user_id",
571        "application_id",
572        "created_at",
573        "updated_at"
574      ]
575    },
576    "company_id": {
577      "type": "integer",
578      "description": "Unique identifier for the company associated with the event."
579    },
580    "company_mode": {
581      "type": "string",
582      "description": "Mode of the company (e.g., \"live\", \"development\").",
583      "enum": [
584        "live",
585        "development"
586      ]
587    },
588    "company_created_on": {
589      "type": "string",
590      "format": "date-time",
591      "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"
592    },
593    "user_id": {
594      "type": [
595        "string",
596        "null"
597      ],
598      "description": "Identifier of the user performing the order complete action. Use `null` if the user is anonymous."
599    },
600    "anonymous_id": {
601      "type": "string",
602      "description": "Anonymous identifier assigned to the user if they are not logged in."
603    }
604  }
605}

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_complete",
24  "version": "1",
25  "event_timestamp": "2025-01-31T12:34:56Z",
26  "user_id": "user_12345",
27  "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",
28  "event_type": "engagement",
29  "order_id": "order_9876543210",
30  "status": "completed",
31  "breakup_values_raw": {
32    "mrp_total": 500,
33    "discount": 50,
34    "sub_total": 450,
35    "promotion": 20,
36    "coupon": 10,
37    "reward_points": 5,
38    "cashback_applied": 15,
39    "cod_charges": 0,
40    "gift_price": 0,
41    "delivery_charges": 30,
42    "total": 500
43  },
44  "shipments": [
45    {
46      "shipment_id": "ship_12345",
47      "status": "shipped",
48      "payment_mode": "credit_card"
49    }
50  ],
51  "items": [
52    {
53      "name": "High-quality sweatshirt",
54      "brand": {
55        "name": "Armani Exchange",
56        "logo": "https://www.example.com/logo.png"
57      },
58      "image": [
59        "https://www.example.com/product/7818334/image1.png",
60        "https://www.example.com/product/7818334/image2.png"
61      ],
62      "slug_key": "high-quality-sweatshirt",
63      "size": "M",
64      "code": "HW12345",
65      "id": 7818334,
66      "category": [
67        "Clothing",
68        "Sweatshirts"
69      ],
70      "l3_category_name": "Sweatshirts",
71      "l1_categories": [
72        "Clothing"
73      ],
74      "l2_categories": [
75        "Men's Wear"
76      ],
77      "seller_identifier": "seller_67890",
78      "attributes": {
79        "brand_name": "Armani Exchange",
80        "media": [
81          "https://www.example.com/media/video1.mp4",
82          "https://www.example.com/media/video2.mp4"
83        ]
84      },
85      "price": 150.75,
86      "quantity": 1
87    }
88  ],
89  "event_action": "complete_order",
90  "screen": "Order Confirmation Page",
91  "utm_params": {
92    "utm_content": "summer_promo",
93    "utm_medium": "email",
94    "utm_campaign": "summer_sale",
95    "utm_source": "newsletter"
96  },
97  "screen_view": "order_confirmation_screen",
98  "user": {
99    "_id": "user_12345",
100    "username": "test_example_com_12345",
101    "emails": [
102      {
103        "email": "test@example.com",
104        "active": true,
105        "primary": true,
106        "verified": true
107      }
108    ],
109    "gender": "male",
110    "active": true,
111    "first_name": "John",
112    "last_name": "Doe",
113    "phone_numbers": [
114      {
115        "phone": "8888888888",
116        "active": true,
117        "primary": true,
118        "verified": true,
119        "country_code": 1
120      }
121    ],
122    "account_type": "standard",
123    "profile_pic_url": "https://www.example.com/users/john_doe/profile.jpg",
124    "user_id": "user_12345",
125    "application_id": "app_98765",
126    "created_at": "2020-05-20T08:30:00Z",
127    "updated_at": "2025-01-31T12:34:56Z"
128  },
129  "company_id": 123456,
130  "company_mode": "live",
131  "company_created_on": "2020-05-20T08:30:00Z"
132}

« order_checkout/conversion/v1

product_listing/conversion/v1 »