Click
Events categorized under the click level will be used to track the way user is interacting with the storefront. For example, if a user adds a product to cart or logs in.
This event is generated to track add to cart events, indicating when a user has added anything to the cart. It provides essential information about the user and the product added to the cart.
Events
click/add_to_cart/engagement/v1
# This event is triggered when a user adds any item to the cart. It contains details associated with the user and the product being added to the cart.
Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Payload associated with the event
Properties
query
string
Required
Search query entered by the user
utm_medium
string
This field captures the medium through which the visitor has reached the product
utm_source
string
This field specifies the origin of your navigation, whether trending, or frequently bought together
utm_campaign
string
This field is used to identify a specific product promotion or recommendation being applied.
user_id
string|null
ID of the user if they are logged in
anonymous_id
string
Required
User identifier in case user is not logged in
cart_id
string
Required
Unique identifier for the shopping cart.
event_type
string
Required
Type of the event, such as engagement.
product_id
integer
Required
Unique identifier for the product added to the cart.
article_id
string
Required
Unique identifier for the article associated with the product.
brand
string
Required
Brand name of the product.
l3_category
string
Required
Category level 3 of the product.
l1_category
string
Required
Category level 1 of the product.
currency
string
Required
Currency used for the product price.
price
integer
Required
Price of the product in the specified currency.
quantity
integer
Required
Quantity of the product added to the cart.
source_url
string
Required
URL source of the product.
position
string
Required
Position of the product in the cart.
value
string
Required
Value associated with the product.
context
object
Required
Context information for the emitted events, including details about the device and library used.
Properties
library
object
Required
Details of the library that emitted the event.
Properties
name
string
Required
Name of the library that emitted the event.
version
string
Required
Version of the library that emitted the event.
os
object
Required
Operating system details associated with the device the user is using.
Properties
name
string
Required
Name of the operating system associated with the device the user is using.
version
string
Required
Version of the operating system associated with the device the user is using.
timezone
string
Required
Timezone of the device the user is using. Represents the timezone in the 'Area/Location' string format.
screen
object
Required
Details about the screen the user is on, representing width and height properties.
Properties
width
integer
Required
Width of the screen the user is using in pixels.
height
integer
Required
Height of the screen the user is using in pixels.
userAgent
string
Required
String representing the user agent the browser is using.
locale
string
Required
Locale information of the device the user is using.
device
object
Required
Details of the device the user is using.
Properties
isMobile
boolean
Required
Flag indicating whether the device is a mobile device or not.
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "contains",5 "event",6 "payload",7 "application_id"8 ],9 "description": "Event emitted when a user clicks on the add to cart button.",10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "Application ID(Sales Channel) for which this event is triggered"17 },18 "contains": {19 "type": "array",20 "description": "This array will have all the keys present at root level of 'payload' object",21 "items": {22 "type": "string"23 }24 },25 "event": {26 "type": "object",27 "required": [28 "category",29 "created_timestamp",30 "id",31 "name",32 "trace_id",33 "type",34 "version"35 ],36 "properties": {37 "category": {38 "type": "string",39 "description": "Category of the event. If it is at sales channel level or company level"40 },41 "created_timestamp": {42 "type": "integer",43 "description": "Event generation timestamp in epoch milliseconds"44 },45 "id": {46 "type": "string",47 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"48 },49 "name": {50 "type": "string",51 "description": "Name of the event"52 },53 "trace_id": {54 "type": "array",55 "description": "Internal trace_id for Fynd Platform services",56 "items": {57 "type": "string"58 }59 },60 "type": {61 "type": "string",62 "description": "Type/Action of the event. e.g. create/update/delete"63 },64 "version": {65 "type": "string",66 "description": "Version of the event."67 }68 }69 },70 "payload": {71 "type": "object",72 "description": "Payload associated with the event",73 "required": [74 "anonymous_id",75 "cart_id",76 "product_id",77 "article_id",78 "event_type",79 "brand",80 "l3_category",81 "l1_category",82 "currency",83 "price",84 "quantity",85 "source_url",86 "position",87 "value",88 "context",89 "query"90 ],91 "properties": {92 "query": {93 "type": "string",94 "description": "Search query entered by the user"95 },96 "utm_medium": {97 "type": "string",98 "description": "This field captures the medium through which the visitor has reached the product"99 },100 "utm_source": {101 "type": "string",102 "description": "This field specifies the origin of your navigation, whether trending, or frequently bought together"103 },104 "utm_campaign": {105 "type": "string",106 "description": "This field is used to identify a specific product promotion or recommendation being applied."107 },108 "user_id": {109 "type": [110 "string",111 "null"112 ],113 "description": "ID of the user if they are logged in"114 },115 "anonymous_id": {116 "type": "string",117 "description": "User identifier in case user is not logged in"118 },119 "cart_id": {120 "type": "string",121 "description": "Unique identifier for the shopping cart."122 },123 "event_type": {124 "type": "string",125 "description": "Type of the event, such as engagement."126 },127 "product_id": {128 "type": "integer",129 "description": "Unique identifier for the product added to the cart."130 },131 "article_id": {132 "type": "string",133 "description": "Unique identifier for the article associated with the product."134 },135 "brand": {136 "type": "string",137 "description": "Brand name of the product."138 },139 "l3_category": {140 "type": "string",141 "description": "Category level 3 of the product."142 },143 "l1_category": {144 "type": "string",145 "description": "Category level 1 of the product."146 },147 "currency": {148 "type": "string",149 "description": "Currency used for the product price."150 },151 "price": {152 "type": "integer",153 "description": "Price of the product in the specified currency."154 },155 "quantity": {156 "type": "integer",157 "description": "Quantity of the product added to the cart."158 },159 "source_url": {160 "type": "string",161 "description": "URL source of the product."162 },163 "position": {164 "type": "string",165 "description": "Position of the product in the cart."166 },167 "value": {168 "type": "string",169 "description": "Value associated with the product."170 },171 "context": {172 "type": "object",173 "description": "Context information for the emitted events, including details about the device and library used.",174 "properties": {175 "library": {176 "type": "object",177 "description": "Details of the library that emitted the event.",178 "properties": {179 "name": {180 "type": "string",181 "description": "Name of the library that emitted the event."182 },183 "version": {184 "type": "string",185 "description": "Version of the library that emitted the event."186 }187 },188 "required": [189 "name",190 "version"191 ]192 },193 "os": {194 "type": "object",195 "description": "Operating system details associated with the device the user is using.",196 "properties": {197 "name": {198 "type": "string",199 "description": "Name of the operating system associated with the device the user is using."200 },201 "version": {202 "type": "string",203 "description": "Version of the operating system associated with the device the user is using."204 }205 },206 "required": [207 "name",208 "version"209 ]210 },211 "timezone": {212 "type": "string",213 "description": "Timezone of the device the user is using. Represents the timezone in the 'Area/Location' string format."214 },215 "screen": {216 "type": "object",217 "description": "Details about the screen the user is on, representing width and height properties.",218 "properties": {219 "width": {220 "type": "integer",221 "description": "Width of the screen the user is using in pixels."222 },223 "height": {224 "type": "integer",225 "description": "Height of the screen the user is using in pixels."226 }227 },228 "required": [229 "width",230 "height"231 ]232 },233 "userAgent": {234 "type": "string",235 "description": "String representing the user agent the browser is using."236 },237 "locale": {238 "type": "string",239 "description": "Locale information of the device the user is using."240 },241 "device": {242 "type": "object",243 "description": "Details of the device the user is using.",244 "properties": {245 "isMobile": {246 "type": "boolean",247 "description": "Flag indicating whether the device is a mobile device or not."248 }249 },250 "required": [251 "isMobile"252 ]253 }254 },255 "required": [256 "library",257 "os",258 "timezone",259 "screen",260 "userAgent",261 "locale",262 "device"263 ]264 }265 }266 }267 }268}
Payload Example
1{2 "event": {3 "trace_id": [4 "ZWp4bBJDbRoKZZmI9sz8QD0qslinqYae3a+/0KpJ/Dw="5 ],6 "name": "add_to_cart",7 "type": "engagement",8 "version": "1",9 "created_timestamp": 1716284815000,10 "id": "ZWp4bBJDbRoKZZmI9sz8QD0qslinqYae3a+/0KpJ/Dw=",11 "category": "click"12 },13 "contains": [14 "context",15 "user_id",16 "anonymous_id",17 "cart_id",18 "product_id",19 "article_id",20 "brand",21 "l3_category",22 "l1_category",23 "currency",24 "price",25 "quantity",26 "source_url",27 "position",28 "value",29 "version"30 ],31 "payload": {32 "query": "allen solly",33 "utm_medium": "product_recommendation",34 "utm_source": "product_page",35 "utm_campaign": "similar_products",36 "context": {37 "library": {38 "name": "flick",39 "version": "1.0.4"40 },41 "os": {42 "name": "Mac OS",43 "version": "10.15.7"44 },45 "timezone": "Asia/Calcutta",46 "screen": {47 "width": 1512,48 "height": 85949 },50 "userAgent": "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",51 "locale": "en-GB",52 "device": {53 "isMobile": false54 }55 },56 "user_id": null,57 "event_type": "add_to_cart",58 "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",59 "cart_id": "664c6d8f9279128152fb551b",60 "product_id": 7818334,61 "article_id": "653f83a824beeade47542c3c",62 "brand": "Armani Exchange",63 "l3_category": "Sweatshirts",64 "l1_category": "TODO",65 "currency": "INR",66 "price": 100,67 "quantity": 1,68 "source_url": "TODO",69 "position": "TODO",70 "value": "TODO",71 "version": "1"72 },73 "application_id": [74 "000000000000000000000001"75 ]76}
Was this section helpful?
This event is generated to track order checked out events, indicating when a user has checked out an order. It provides essential information about the order and its contents.
Events
click/order_checkedout/conversion/v1
# This event is emitted when a user proceeds to checkout an order.
Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Payload for the generated event
Properties
order_id
string
Required
Order ID generated for the cart being checked out.
context
object
Required
Context information related to the event.
Properties
library
object
Required
Information about the library used.
Properties
name
string
Required
Name of the library.
version
string
Required
Version of the library.
os
object
Required
Operating system information.
Properties
name
string
Required
Name of the operating system.
version
string
Required
Version of the operating system.
timezone
string
Required
Timezone information.
screen
object
Required
Screen resolution information.
Properties
width
integer
Required
Width of the screen.
height
integer
Required
Height of the screen.
userAgent
string
Required
User agent string indicating the browser or application.
locale
string
Required
Locale information of the device.
device
object
Required
Details of the device.
Properties
isMobile
boolean
Required
Flag indicating whether the device is a mobile device or not.
cart_id
string
Required
Unique identifier for the shopping cart.
cart_total
integer
Required
Total amount in the shopping cart.
shipping
integer
Required
Shipping cost.
tax
number
Required
Tax amount.
order_total
number
Required
Total amount of the order.
currency
string
Required
Currency used for the transaction.
products
array of object
Required
List of products in the cart.
Array of Properties
product_id
integer
Required
Unique identifier for the product.
l3_category
string
Required
Category level 3 of the product.
l1_category
string
Required
Category level 1 of the product.
quantity
integer
Required
Quantity of the product.
price
integer
Required
Price of the product.
value
integer
Required
Value of the product.
currency
string
Required
Currency used for the product price.
article_id
string
Required
Article ID of the product.
user_id
string|null
Required
Unique identifier for the user.
anonymous_id
string
Required
Anonymous identifier for the user.
version
string
Required
Version of the event.
Payload Schema JSON
1{2 "type": "object",3 "properties": {4 "application_id": {5 "type": [6 "array",7 "string"8 ],9 "description": "Application ID(Sales Channel) for which this event is triggered"10 },11 "contains": {12 "type": "array",13 "description": "This array will have all the keys present at root level of 'payload' object",14 "items": {15 "type": "string"16 }17 },18 "event": {19 "type": "object",20 "required": [21 "category",22 "created_timestamp",23 "id",24 "name",25 "trace_id",26 "type",27 "version"28 ],29 "properties": {30 "category": {31 "type": "string",32 "description": "Category of the event. If it is at sales channel level or company level"33 },34 "created_timestamp": {35 "type": "integer",36 "description": "Event generation timestamp in epoch milliseconds"37 },38 "id": {39 "type": "string",40 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"41 },42 "name": {43 "type": "string",44 "description": "Name of the event"45 },46 "trace_id": {47 "type": "array",48 "description": "Internal trace_id for Fynd Platform services",49 "items": {50 "type": "string"51 }52 },53 "type": {54 "type": "string",55 "description": "Type/Action of the event. e.g. create/update/delete"56 },57 "version": {58 "type": "string",59 "description": "Version of the event."60 }61 }62 },63 "payload": {64 "type": "object",65 "description": "Payload for the generated event",66 "required": [67 "context",68 "cart_id",69 "cart_total",70 "shipping",71 "tax",72 "order_total",73 "currency",74 "products",75 "user_id",76 "anonymous_id",77 "version",78 "order_id"79 ],80 "properties": {81 "order_id": {82 "type": "string",83 "description": "Order ID generated for the cart being checked out."84 },85 "context": {86 "type": "object",87 "required": [88 "library",89 "os",90 "timezone",91 "screen",92 "userAgent",93 "locale",94 "device"95 ],96 "description": "Context information related to the event.",97 "properties": {98 "library": {99 "type": "object",100 "description": "Information about the library used.",101 "properties": {102 "name": {103 "type": "string",104 "description": "Name of the library."105 },106 "version": {107 "type": "string",108 "description": "Version of the library."109 }110 },111 "required": [112 "name",113 "version"114 ]115 },116 "os": {117 "type": "object",118 "description": "Operating system information.",119 "properties": {120 "name": {121 "type": "string",122 "description": "Name of the operating system."123 },124 "version": {125 "type": "string",126 "description": "Version of the operating system."127 }128 },129 "required": [130 "name",131 "version"132 ]133 },134 "timezone": {135 "type": "string",136 "description": "Timezone information."137 },138 "screen": {139 "type": "object",140 "description": "Screen resolution information.",141 "properties": {142 "width": {143 "type": "integer",144 "description": "Width of the screen."145 },146 "height": {147 "type": "integer",148 "description": "Height of the screen."149 }150 },151 "required": [152 "width",153 "height"154 ]155 },156 "userAgent": {157 "type": "string",158 "description": "User agent string indicating the browser or application."159 },160 "locale": {161 "type": "string",162 "description": "Locale information of the device."163 },164 "device": {165 "type": "object",166 "description": "Details of the device.",167 "properties": {168 "isMobile": {169 "type": "boolean",170 "description": "Flag indicating whether the device is a mobile device or not."171 }172 },173 "required": [174 "isMobile"175 ]176 }177 }178 },179 "cart_id": {180 "type": "string",181 "description": "Unique identifier for the shopping cart."182 },183 "cart_total": {184 "type": "integer",185 "description": "Total amount in the shopping cart."186 },187 "shipping": {188 "type": "integer",189 "description": "Shipping cost."190 },191 "tax": {192 "type": "number",193 "description": "Tax amount."194 },195 "order_total": {196 "type": "number",197 "description": "Total amount of the order."198 },199 "currency": {200 "type": "string",201 "description": "Currency used for the transaction."202 },203 "products": {204 "type": "array",205 "description": "List of products in the cart.",206 "items": {207 "type": "object",208 "properties": {209 "product_id": {210 "type": "integer",211 "description": "Unique identifier for the product."212 },213 "l3_category": {214 "type": "string",215 "description": "Category level 3 of the product."216 },217 "l1_category": {218 "type": "string",219 "description": "Category level 1 of the product."220 },221 "quantity": {222 "type": "integer",223 "description": "Quantity of the product."224 },225 "price": {226 "type": "integer",227 "description": "Price of the product."228 },229 "value": {230 "type": "integer",231 "description": "Value of the product."232 },233 "currency": {234 "type": "string",235 "description": "Currency used for the product price."236 },237 "article_id": {238 "type": "string",239 "description": "Article ID of the product."240 }241 },242 "required": [243 "product_id",244 "l3_category",245 "l1_category",246 "quantity",247 "price",248 "value",249 "currency",250 "article_id"251 ]252 },253 "required": [254 "event_type",255 "cart_id",256 "cart_total",257 "shipping",258 "tax",259 "order_total",260 "currency",261 "products"262 ]263 },264 "user_id": {265 "type": [266 "string",267 "null"268 ],269 "description": "Unique identifier for the user."270 },271 "anonymous_id": {272 "type": "string",273 "description": "Anonymous identifier for the user."274 },275 "version": {276 "type": "string",277 "description": "Version of the event."278 }279 }280 }281 },282 "required": [283 "application_id",284 "contains",285 "event",286 "payload"287 ]288}
Payload Example
1{2 "event": {3 "trace_id": [4 "A5ls7UG+vRaQ3JNxnyJu/Vdlp50vSJLYUpIJzZsx1H8="5 ],6 "name": "order_checkedout",7 "type": "conversion",8 "version": "1",9 "created_timestamp": 1716285106309,10 "id": "A5ls7UG+vRaQ3JNxnyJu/Vdlp50vSJLYUpIJzZsx1H8=",11 "category": "click"12 },13 "contains": [14 "context",15 "user_id",16 "anonymous_id",17 "cart_id",18 "order_id",19 "cart_total",20 "shipping",21 "tax",22 "order_total",23 "currency",24 "products",25 "version"26 ],27 "payload": {28 "order_id": "FPYO12341231342QW",29 "context": {30 "library": {31 "name": "flick",32 "version": "1.0.4"33 },34 "os": {35 "name": "Mac OS",36 "version": "10.15.7"37 },38 "timezone": "Asia/Calcutta",39 "screen": {40 "width": 1512,41 "height": 85942 },43 "userAgent": "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",44 "locale": "en-GB",45 "device": {46 "isMobile": false47 }48 },49 "user_id": null,50 "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",51 "cart_id": "664c6d8f9279128152fb551b",52 "cart_total": 10,53 "shipping": 0,54 "tax": 0.26,55 "order_total": 0.4,56 "currency": "INR",57 "products": [58 {59 "product_id": 7839296,60 "l3_category": "Lights",61 "l1_category": "TODO",62 "quantity": 1,63 "price": 10,64 "value": 4,65 "currency": "INR",66 "article_id": "66025f1e749a39b426d68d93"67 }68 ],69 "version": "1"70 },71 "application_id": [72 "000000000000000000000001"73 ]74}
Was this section helpful?
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.
Events
click/order_checkout/conversion/v1
# This event is emitted when a user proceeds to checkout an order.
Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Payload for the generated event
Properties
order_id
string
Required
Order ID generated for the cart being checked out.
context
object
Required
Context information related to the event.
Properties
library
object
Required
Information about the library used.
Properties
name
string
Required
Name of the library.
version
string
Required
Version of the library.
os
object
Required
Operating system information.
Properties
name
string
Required
Name of the operating system.
version
string
Required
Version of the operating system.
timezone
string
Required
Timezone information.
screen
object
Required
Screen resolution information.
Properties
width
integer
Required
Width of the screen.
height
integer
Required
Height of the screen.
userAgent
string
Required
User agent string indicating the browser or application.
locale
string
Required
Locale information of the device.
device
object
Required
Details of the device.
Properties
isMobile
boolean
Required
Flag indicating whether the device is a mobile device or not.
cart_id
string
Required
Unique identifier for the shopping cart.
cart_total
integer
Required
Total amount in the shopping cart.
shipping
integer
Required
Shipping cost.
tax
number
Required
Tax amount.
order_total
number
Required
Total amount of the order.
currency
string
Required
Currency used for the transaction.
products
array of object
Required
List of products in the cart.
Array of Properties
product_id
integer
Required
Unique identifier for the product.
l3_category
string
Required
Category level 3 of the product.
l1_category
string
Required
Category level 1 of the product.
quantity
integer
Required
Quantity of the product.
price
integer
Required
Price of the product.
value
integer
Required
Value of the product.
currency
string
Required
Currency used for the product price.
article_id
string
Required
Article ID of the product.
user_id
string|null
Required
Unique identifier for the user.
anonymous_id
string
Required
Anonymous identifier for the user.
version
string
Required
Version of the event.
Payload Schema JSON
1{2 "type": "object",3 "properties": {4 "application_id": {5 "type": [6 "array",7 "string"8 ],9 "description": "Application ID(Sales Channel) for which this event is triggered"10 },11 "contains": {12 "type": "array",13 "description": "This array will have all the keys present at root level of 'payload' object",14 "items": {15 "type": "string"16 }17 },18 "event": {19 "type": "object",20 "required": [21 "category",22 "created_timestamp",23 "id",24 "name",25 "trace_id",26 "type",27 "version"28 ],29 "properties": {30 "category": {31 "type": "string",32 "description": "Category of the event. If it is at sales channel level or company level"33 },34 "created_timestamp": {35 "type": "integer",36 "description": "Event generation timestamp in epoch milliseconds"37 },38 "id": {39 "type": "string",40 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"41 },42 "name": {43 "type": "string",44 "description": "Name of the event"45 },46 "trace_id": {47 "type": "array",48 "description": "Internal trace_id for Fynd Platform services",49 "items": {50 "type": "string"51 }52 },53 "type": {54 "type": "string",55 "description": "Type/Action of the event. e.g. create/update/delete"56 },57 "version": {58 "type": "string",59 "description": "Version of the event."60 }61 }62 },63 "payload": {64 "type": "object",65 "description": "Payload for the generated event",66 "required": [67 "context",68 "cart_id",69 "cart_total",70 "shipping",71 "tax",72 "order_total",73 "currency",74 "products",75 "user_id",76 "anonymous_id",77 "version",78 "order_id"79 ],80 "properties": {81 "order_id": {82 "type": "string",83 "description": "Order ID generated for the cart being checked out."84 },85 "context": {86 "type": "object",87 "required": [88 "library",89 "os",90 "timezone",91 "screen",92 "userAgent",93 "locale",94 "device"95 ],96 "description": "Context information related to the event.",97 "properties": {98 "library": {99 "type": "object",100 "description": "Information about the library used.",101 "properties": {102 "name": {103 "type": "string",104 "description": "Name of the library."105 },106 "version": {107 "type": "string",108 "description": "Version of the library."109 }110 },111 "required": [112 "name",113 "version"114 ]115 },116 "os": {117 "type": "object",118 "description": "Operating system information.",119 "properties": {120 "name": {121 "type": "string",122 "description": "Name of the operating system."123 },124 "version": {125 "type": "string",126 "description": "Version of the operating system."127 }128 },129 "required": [130 "name",131 "version"132 ]133 },134 "timezone": {135 "type": "string",136 "description": "Timezone information."137 },138 "screen": {139 "type": "object",140 "description": "Screen resolution information.",141 "properties": {142 "width": {143 "type": "integer",144 "description": "Width of the screen."145 },146 "height": {147 "type": "integer",148 "description": "Height of the screen."149 }150 },151 "required": [152 "width",153 "height"154 ]155 },156 "userAgent": {157 "type": "string",158 "description": "User agent string indicating the browser or application."159 },160 "locale": {161 "type": "string",162 "description": "Locale information of the device."163 },164 "device": {165 "type": "object",166 "description": "Details of the device.",167 "properties": {168 "isMobile": {169 "type": "boolean",170 "description": "Flag indicating whether the device is a mobile device or not."171 }172 },173 "required": [174 "isMobile"175 ]176 }177 }178 },179 "cart_id": {180 "type": "string",181 "description": "Unique identifier for the shopping cart."182 },183 "cart_total": {184 "type": "integer",185 "description": "Total amount in the shopping cart."186 },187 "shipping": {188 "type": "integer",189 "description": "Shipping cost."190 },191 "tax": {192 "type": "number",193 "description": "Tax amount."194 },195 "order_total": {196 "type": "number",197 "description": "Total amount of the order."198 },199 "currency": {200 "type": "string",201 "description": "Currency used for the transaction."202 },203 "products": {204 "type": "array",205 "description": "List of products in the cart.",206 "items": {207 "type": "object",208 "properties": {209 "product_id": {210 "type": "integer",211 "description": "Unique identifier for the product."212 },213 "l3_category": {214 "type": "string",215 "description": "Category level 3 of the product."216 },217 "l1_category": {218 "type": "string",219 "description": "Category level 1 of the product."220 },221 "quantity": {222 "type": "integer",223 "description": "Quantity of the product."224 },225 "price": {226 "type": "integer",227 "description": "Price of the product."228 },229 "value": {230 "type": "integer",231 "description": "Value of the product."232 },233 "currency": {234 "type": "string",235 "description": "Currency used for the product price."236 },237 "article_id": {238 "type": "string",239 "description": "Article ID of the product."240 }241 },242 "required": [243 "product_id",244 "l3_category",245 "l1_category",246 "quantity",247 "price",248 "value",249 "currency",250 "article_id"251 ]252 },253 "required": [254 "event_type",255 "cart_id",256 "cart_total",257 "shipping",258 "tax",259 "order_total",260 "currency",261 "products"262 ]263 },264 "user_id": {265 "type": [266 "string",267 "null"268 ],269 "description": "Unique identifier for the user."270 },271 "anonymous_id": {272 "type": "string",273 "description": "Anonymous identifier for the user."274 },275 "version": {276 "type": "string",277 "description": "Version of the event."278 }279 }280 }281 },282 "required": [283 "application_id",284 "contains",285 "event",286 "payload"287 ]288}
Payload Example
1{2 "event": {3 "trace_id": [4 "A5ls7UG+vRaQ3JNxnyJu/Vdlp50vSJLYUpIJzZsx1H8="5 ],6 "name": "order_checkout",7 "type": "conversion",8 "version": "1",9 "created_timestamp": 1716285106309,10 "id": "A5ls7UG+vRaQ3JNxnyJu/Vdlp50vSJLYUpIJzZsx1H8=",11 "category": "click"12 },13 "contains": [14 "context",15 "user_id",16 "anonymous_id",17 "cart_id",18 "cart_total",19 "shipping",20 "tax",21 "order_total",22 "currency",23 "products",24 "version"25 ],26 "payload": {27 "order_id": "FPYO12341231342QW",28 "context": {29 "library": {30 "name": "flick",31 "version": "1.0.4"32 },33 "os": {34 "name": "Mac OS",35 "version": "10.15.7"36 },37 "timezone": "Asia/Calcutta",38 "screen": {39 "width": 1512,40 "height": 85941 },42 "userAgent": "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",43 "locale": "en-GB",44 "device": {45 "isMobile": false46 }47 },48 "user_id": null,49 "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",50 "cart_id": "664c6d8f9279128152fb551b",51 "cart_total": 10,52 "shipping": 0,53 "tax": 0.26,54 "order_total": 0.4,55 "currency": "INR",56 "products": [57 {58 "product_id": 7839296,59 "l3_category": "Lights",60 "l1_category": "TODO",61 "quantity": 1,62 "price": 10,63 "value": 4,64 "currency": "INR",65 "article_id": "66025f1e749a39b426d68d93"66 }67 ],68 "version": "1"69 },70 "application_id": [71 "000000000000000000000001"72 ]73}
Was this section helpful?
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 an order is completed by the user.
Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Payload for the emitted event
Properties
context
object
Required
Contextual information of the event.
Properties
library
object
Required
Information about the library.
Properties
name
string
Required
Name of the library.
version
string
Required
Version of the library.
os
object
Required
Operating system information.
Properties
name
string
Required
Name of the operating system.
version
string
Required
Version of the operating system.
timezone
string
Required
Timezone information.
screen
object
Required
Screen resolution information.
Properties
width
integer
Required
Width of the screen.
height
integer
Required
Height of the screen.
userAgent
string
Required
User agent string indicating the browser or application.
locale
string
Required
Locale information of the device.
device
object
Required
Details of the device.
Properties
isMobile
boolean
Required
Flag indicating whether the device is a mobile device or not.
event_action
string
Required
Name of the action.
order_id
string
Required
Unique identifier for the order.
status
string
Required
Status of the order.
breakup_values_raw
object
Required
Breakup values of the order.
Properties
mrp_total
integer
Required
Total MRP of the items in the order.
sub_total
integer
Required
Subtotal amount of the order.
coupon
integer
Required
Coupon discount applied.
discount
integer
Required
Discount amount applied.
promotion
integer
Required
Promotion discount applied.
applied_emi_discount
integer
EMI discount applied.
applied_instant_discount
integer
Instant discount applied.
reward_points
integer
Required
Reward points used in the order.
cashback_applied
integer
Required
Cashback amount applied.
delivery_charges
integer
Required
Delivery charges for the order.
tcs_charge
integer
Tax Collected at Source (TCS) charge.
cod_charges
integer
Required
Cash on Delivery (COD) charges.
gift_price
integer
Required
Price of any gift items included in the order.
amount_to_be_collected
integer
Total amount to be collected from the customer.
total
integer
Required
Total amount of the order.
shipments
array of object
Required
Details of the 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 for the shipment.
items
array of object
Required
List of items in the order.
Array of Properties
name
string
Required
Name of the item.
brand
object
Required
Properties
name
string
Required
Brand name of the item.
logo
string
Required
URL of the brand's logo.
image
array of string
Required
Array of image URLs representing the item.
slug_key
string
Required
Slug key of the item.
size
string
Required
Size of the item.
code
string
Required
Product code or identifier.
id
integer
Required
Unique identifier for the item.
category
array of Undefined Type
Required
Categories to which the item belongs.
l3_category_name
string
Required
Name of the third-level category.
l1_categories
array of string
Required
First-level category names.
l2_categories
array of string
Required
Second-level category names.
seller_identifier
string
Required
Identifier of the seller.
attributes
object
Required
Attributes of the item.
Properties
name
string
Required
Name of the item attribute.
brand_name
string
Required
Brand name of the item.
media
array of Undefined Type
Required
Media associated with the item.
price
integer
Required
Price of the item.
quantity
integer
Required
Quantity of the item in the order.
screen
string
Required
Name of the screen where the event occurred.
screen_view
string
Required
View of the screen where the event occurred.
user
object
Required
Details of the user associated with the event.
Properties
_id
string
Required
Unique identifier for the user.
username
string
Required
Username of the user.
emails
array of Undefined Type
Required
Email addresses associated with the user.
gender
string
Required
Gender of the user.
active
boolean
Required
Flag indicating whether the user is active or not.
first_name
string
Required
First name of the user.
last_name
string
Required
Last name of the user.
phone_numbers
array of object
Required
Phone numbers associated with the user.
Array of Properties
phone
string
Required
Phone number.
active
boolean
Required
Flag indicating whether the phone number is active or not.
primary
boolean
Required
Flag indicating whether the phone number is primary or not.
verified
boolean
Required
Flag indicating whether the phone number is verified or not.
country_code
integer
Required
Country code of the phone number.
account_type
string
Required
Type of the user account.
profile_pic_url
string
Required
URL of the user's profile picture.
user_id
string
Required
Identifier of the user.
application_id
string
Required
Identifier of the application.
created_at
string
Required
Timestamp when the user was created.
updated_at
string
Required
Timestamp when the user was last updated.
user_id
string|null
Required
Unique identifier for the user.
anonymous_id
string
Required
Anonymous identifier for the user.
version
string
Required
Version of the event schema.
Payload Schema JSON
1{2 "type": "object",3 "description": "This event is emitted when a user completes to an order.",4 "properties": {5 "application_id": {6 "type": [7 "array",8 "string"9 ],10 "description": "Application ID(Sales Channel) for which this event is triggered"11 },12 "contains": {13 "type": "array",14 "description": "This array will have all the keys present at root level of 'payload' object",15 "items": {16 "type": "string"17 }18 },19 "event": {20 "type": "object",21 "required": [22 "category",23 "created_timestamp",24 "id",25 "name",26 "trace_id",27 "type",28 "version"29 ],30 "properties": {31 "category": {32 "type": "string",33 "description": "Category of the event. If it is at sales channel level or company level"34 },35 "created_timestamp": {36 "type": "integer",37 "description": "Event generation timestamp in epoch milliseconds"38 },39 "id": {40 "type": "string",41 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"42 },43 "name": {44 "type": "string",45 "description": "Name of the event"46 },47 "trace_id": {48 "type": "array",49 "description": "Internal trace_id for Fynd Platform services",50 "items": {51 "type": "string"52 }53 },54 "type": {55 "type": "string",56 "description": "Type/Action of the event. e.g. create/update/delete"57 },58 "version": {59 "type": "string",60 "description": "Version of the event."61 }62 }63 },64 "payload": {65 "type": "object",66 "description": "Payload for the emitted event",67 "properties": {68 "context": {69 "type": "object",70 "description": "Contextual information of the event.",71 "properties": {72 "library": {73 "type": "object",74 "description": "Information about the library.",75 "properties": {76 "name": {77 "type": "string",78 "description": "Name of the library."79 },80 "version": {81 "type": "string",82 "description": "Version of the library."83 }84 },85 "required": [86 "name",87 "version"88 ]89 },90 "os": {91 "type": "object",92 "description": "Operating system information.",93 "properties": {94 "name": {95 "type": "string",96 "description": "Name of the operating system."97 },98 "version": {99 "type": "string",100 "description": "Version of the operating system."101 }102 },103 "required": [104 "name",105 "version"106 ]107 },108 "timezone": {109 "type": "string",110 "description": "Timezone information."111 },112 "screen": {113 "type": "object",114 "description": "Screen resolution information.",115 "properties": {116 "width": {117 "type": "integer",118 "description": "Width of the screen."119 },120 "height": {121 "type": "integer",122 "description": "Height of the screen."123 }124 },125 "required": [126 "width",127 "height"128 ]129 },130 "userAgent": {131 "type": "string",132 "description": "User agent string indicating the browser or application."133 },134 "locale": {135 "type": "string",136 "description": "Locale information of the device."137 },138 "device": {139 "type": "object",140 "description": "Details of the device.",141 "properties": {142 "isMobile": {143 "type": "boolean",144 "description": "Flag indicating whether the device is a mobile device or not."145 }146 },147 "required": [148 "isMobile"149 ]150 }151 },152 "required": [153 "library",154 "os",155 "timezone",156 "screen",157 "userAgent",158 "locale",159 "device"160 ]161 },162 "event_action": {163 "type": "string",164 "description": "Name of the action."165 },166 "order_id": {167 "type": "string",168 "description": "Unique identifier for the order."169 },170 "status": {171 "type": "string",172 "description": "Status of the order."173 },174 "breakup_values_raw": {175 "type": "object",176 "description": "Breakup values of the order.",177 "properties": {178 "mrp_total": {179 "type": "integer",180 "description": "Total MRP of the items in the order."181 },182 "sub_total": {183 "type": "integer",184 "description": "Subtotal amount of the order."185 },186 "coupon": {187 "type": "integer",188 "description": "Coupon discount applied."189 },190 "discount": {191 "type": "integer",192 "description": "Discount amount applied."193 },194 "promotion": {195 "type": "integer",196 "description": "Promotion discount applied."197 },198 "applied_emi_discount": {199 "type": "integer",200 "description": "EMI discount applied."201 },202 "applied_instant_discount": {203 "type": "integer",204 "description": "Instant discount applied."205 },206 "reward_points": {207 "type": "integer",208 "description": "Reward points used in the order."209 },210 "cashback_applied": {211 "type": "integer",212 "description": "Cashback amount applied."213 },214 "delivery_charges": {215 "type": "integer",216 "description": "Delivery charges for the order."217 },218 "tcs_charge": {219 "type": "integer",220 "description": "Tax Collected at Source (TCS) charge."221 },222 "cod_charges": {223 "type": "integer",224 "description": "Cash on Delivery (COD) charges."225 },226 "gift_price": {227 "type": "integer",228 "description": "Price of any gift items included in the order."229 },230 "amount_to_be_collected": {231 "type": "integer",232 "description": "Total amount to be collected from the customer."233 },234 "total": {235 "type": "integer",236 "description": "Total amount of the order."237 }238 },239 "required": [240 "mrp_total",241 "sub_total",242 "coupon",243 "discount",244 "promotion",245 "reward_points",246 "cashback_applied",247 "delivery_charges",248 "cod_charges",249 "gift_price",250 "total"251 ]252 },253 "shipments": {254 "type": "array",255 "description": "Details of the shipments associated with the order.",256 "items": {257 "type": "object",258 "properties": {259 "shipment_id": {260 "type": "string",261 "description": "Unique identifier for the shipment."262 },263 "status": {264 "type": "string",265 "description": "Status of the shipment."266 },267 "payment_mode": {268 "type": "string",269 "description": "Payment mode for the shipment."270 }271 },272 "required": [273 "shipment_id",274 "status",275 "payment_mode"276 ]277 }278 },279 "items": {280 "type": "array",281 "description": "List of items in the order.",282 "items": {283 "type": "object",284 "properties": {285 "name": {286 "type": "string",287 "description": "Name of the item."288 },289 "brand": {290 "type": "object",291 "properties": {292 "name": {293 "type": "string",294 "description": "Brand name of the item."295 },296 "logo": {297 "type": "string",298 "description": "URL of the brand's logo."299 }300 },301 "required": [302 "name",303 "logo"304 ]305 },306 "image": {307 "type": "array",308 "description": "Array of image URLs representing the item.",309 "items": {310 "type": "string"311 }312 },313 "slug_key": {314 "type": "string",315 "description": "Slug key of the item."316 },317 "size": {318 "type": "string",319 "description": "Size of the item."320 },321 "code": {322 "type": "string",323 "description": "Product code or identifier."324 },325 "id": {326 "type": "integer",327 "description": "Unique identifier for the item."328 },329 "category": {330 "type": "array",331 "description": "Categories to which the item belongs.",332 "items": {}333 },334 "l3_category_name": {335 "type": "string",336 "description": "Name of the third-level category."337 },338 "l1_categories": {339 "type": "array",340 "description": "First-level category names.",341 "items": {342 "type": "string"343 }344 },345 "l2_categories": {346 "type": "array",347 "description": "Second-level category names.",348 "items": {349 "type": "string"350 }351 },352 "seller_identifier": {353 "type": "string",354 "description": "Identifier of the seller."355 },356 "attributes": {357 "type": "object",358 "description": "Attributes of the item.",359 "properties": {360 "name": {361 "type": "string",362 "description": "Name of the item attribute."363 },364 "brand_name": {365 "type": "string",366 "description": "Brand name of the item."367 },368 "media": {369 "type": "array",370 "description": "Media associated with the item.",371 "items": {}372 }373 },374 "required": [375 "name",376 "brand_name",377 "media"378 ]379 },380 "price": {381 "type": "integer",382 "description": "Price of the item."383 },384 "quantity": {385 "type": "integer",386 "description": "Quantity of the item in the order."387 }388 },389 "required": [390 "name",391 "brand",392 "image",393 "slug_key",394 "size",395 "code",396 "id",397 "category",398 "l3_category_name",399 "l1_categories",400 "l2_categories",401 "seller_identifier",402 "attributes",403 "price",404 "quantity"405 ]406 }407 },408 "screen": {409 "type": "string",410 "description": "Name of the screen where the event occurred."411 },412 "screen_view": {413 "type": "string",414 "description": "View of the screen where the event occurred."415 },416 "user": {417 "type": "object",418 "description": "Details of the user associated with the event.",419 "properties": {420 "_id": {421 "type": "string",422 "description": "Unique identifier for the user."423 },424 "username": {425 "type": "string",426 "description": "Username of the user."427 },428 "emails": {429 "type": "array",430 "description": "Email addresses associated with the user.",431 "items": {}432 },433 "gender": {434 "type": "string",435 "description": "Gender of the user."436 },437 "active": {438 "type": "boolean",439 "description": "Flag indicating whether the user is active or not."440 },441 "first_name": {442 "type": "string",443 "description": "First name of the user."444 },445 "last_name": {446 "type": "string",447 "description": "Last name of the user."448 },449 "phone_numbers": {450 "type": "array",451 "description": "Phone numbers associated with the user.",452 "items": {453 "type": "object",454 "properties": {455 "phone": {456 "type": "string",457 "description": "Phone number."458 },459 "active": {460 "type": "boolean",461 "description": "Flag indicating whether the phone number is active or not."462 },463 "primary": {464 "type": "boolean",465 "description": "Flag indicating whether the phone number is primary or not."466 },467 "verified": {468 "type": "boolean",469 "description": "Flag indicating whether the phone number is verified or not."470 },471 "country_code": {472 "type": "integer",473 "description": "Country code of the phone number."474 }475 },476 "required": [477 "phone",478 "active",479 "primary",480 "verified",481 "country_code"482 ]483 }484 },485 "account_type": {486 "type": "string",487 "description": "Type of the user account."488 },489 "profile_pic_url": {490 "type": "string",491 "description": "URL of the user's profile picture."492 },493 "user_id": {494 "type": "string",495 "description": "Identifier of the user."496 },497 "application_id": {498 "type": "string",499 "description": "Identifier of the application."500 },501 "created_at": {502 "type": "string",503 "description": "Timestamp when the user was created."504 },505 "updated_at": {506 "type": "string",507 "description": "Timestamp when the user was last updated."508 }509 },510 "required": [511 "_id",512 "username",513 "emails",514 "gender",515 "active",516 "first_name",517 "last_name",518 "phone_numbers",519 "account_type",520 "profile_pic_url",521 "user_id",522 "application_id",523 "created_at",524 "updated_at"525 ]526 },527 "user_id": {528 "type": [529 "string",530 "null"531 ],532 "description": "Unique identifier for the user."533 },534 "anonymous_id": {535 "type": "string",536 "description": "Anonymous identifier for the user."537 },538 "version": {539 "type": "string",540 "description": "Version of the event schema."541 }542 },543 "required": [544 "context",545 "event_action",546 "order_id",547 "status",548 "breakup_values_raw",549 "shipments",550 "items",551 "screen",552 "screen_view",553 "user",554 "user_id",555 "anonymous_id",556 "version"557 ]558 }559 },560 "required": [561 "application_id",562 "event",563 "contains",564 "payload"565 ]566}
Payload Example
1{2 "event": {3 "trace_id": [4 "C4h6o4keDpCIHNmLnpB3PlD6QXVpI1l/9TauXLFxenQ="5 ],6 "name": "order_complete",7 "type": "conversion",8 "version": "1",9 "created_timestamp": 1716271264185,10 "id": "C4h6o4keDpCIHNmLnpB3PlD6QXVpI1l/9TauXLFxenQ=",11 "category": "click"12 },13 "contains": [14 "context",15 "user_id",16 "anonymous_id",17 "order_id",18 "status",19 "breakup_values_raw",20 "shipments",21 "items",22 "event_action",23 "screen",24 "screen_view",25 "user",26 "version"27 ],28 "payload": {29 "context": {30 "library": {31 "name": "flick",32 "version": "1.0.4"33 },34 "os": {35 "name": "Mac OS",36 "version": "10.15.7"37 },38 "timezone": "Asia/Calcutta",39 "screen": {40 "width": 1512,41 "height": 85942 },43 "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36",44 "locale": "en-GB",45 "device": {46 "isMobile": false47 }48 },49 "user_id": null,50 "anonymous_id": "37a16fae-3b0d-4fdd-849b-791f622f8349",51 "order_id": "FY664C38930ED7F9B355",52 "status": "",53 "breakup_values_raw": {54 "mrp_total": 51989,55 "sub_total": 24990,56 "coupon": 0,57 "discount": -26999,58 "promotion": -17992,59 "reward_points": 0,60 "cashback_applied": 0,61 "delivery_charges": 0,62 "cod_charges": 0,63 "gift_price": 0,64 "total": 699865 },66 "shipments": [67 {68 "shipment_id": "17162712513251010600",69 "status": "Placed",70 "payment_mode": "CCAVENUEPG"71 }72 ],73 "items": [74 {75 "name": "Random Stripe Mens Suit Jacket Slim Fit 2 Button Blazer for Men Business Suits Blazer Casual Sport Coats (Only Blazer)",76 "brand": {77 "name": "ARCADIO BRAND",78 "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/brands/pictures/square-logo/original/8SWSgh8CB-Logo.png"79 },80 "image": [81 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/products/pictures/item/free/270x0/DRqynpnZo-61cNAVC3w6L._SY879_.jpg"82 ],83 "slug_key": "random-stripe-mens-suit-jacket-slim-fit-2-button-blazer-for-men-business-suits-blazer-casual-sport-coats-only-blazer-9787282",84 "size": "OS",85 "code": "LBX-28932",86 "id": 9787282,87 "category": [],88 "l3_category_name": "Blazers",89 "l1_categories": [90 "Clothing"91 ],92 "l2_categories": [93 "Suits & Blazers"94 ],95 "seller_identifier": "78928323",96 "attributes": {97 "name": "Random Stripe Mens Suit Jacket Slim Fit 2 Button Blazer for Men Business Suits Blazer Casual Sport Coats (Only Blazer)",98 "pattern": "waves",99 "currency": "INR",100 "lifestyle": [101 "Casualwear"102 ],103 "brand_name": "ARCADIO BRAND",104 "media": []105 },106 "price": 1499,107 "quantity": 1108 }109 ],110 "event_action": "order.processed",111 "screen": "landscape",112 "screen_view": "order_status",113 "user": {114 "_id": "64ab76c5bb9251c14ad2b2df",115 "gender": "male",116 "active": true,117 "emails": [118 {119 "email": "[email protected]",120 "active": true,121 "primary": true,122 "verified": true123 }124 ],125 "username": "singhjolly502_gmail_com_61833_000000000000000000000001",126 "account_type": "user",127 "profile_pic_url": "https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/theme/pictures/free/original/default-profile_nxhzui.png",128 "phone_numbers": [129 {130 "phone": "8851955993",131 "active": true,132 "primary": true,133 "verified": true,134 "country_code": 91135 }136 ],137 "application_id": "000000000000000000000001",138 "first_name": "jolly",139 "last_name": "singh",140 "user_id": "64ab76c5bb9251c14ad2b2df",141 "created_at": "2023-07-10T03:11:01.836Z",142 "updated_at": "2024-03-05T07:25:59.797Z"143 },144 "version": "1"145 },146 "application_id": [147 "000000000000000000000001"148 ]149}
Was this section helpful?
This event is generated to track product listing events, indicating when a user visits the product listing. It provides essential information about the user events.
Events
click/product_listing/conversion/v1
# This event is emitted when a user visits the product listing.
Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Payload for the generated event
Properties
query
string
Required
Searcg string passed by the user.
context
object
Required
Context information related to the event.
Properties
library
object
Required
Information about the library used.
Properties
name
string
Required
Name of the library.
version
string
Required
Version of the library.
os
object
Required
Operating system information.
Properties
name
string
Required
Name of the operating system.
version
string
Required
Version of the operating system.
timezone
string
Required
Timezone information.
screen
object
Required
Screen resolution information.
Properties
width
integer
Required
Width of the screen.
height
integer
Required
Height of the screen.
userAgent
string
Required
User agent string indicating the browser or application.
locale
string
Required
Locale information of the device.
device
object
Required
Details of the device.
Properties
isMobile
boolean
Required
Flag indicating whether the device is a mobile device or not.
item_total
integer
Required
Total items present in the listing page
products
array of object
Required
List of products present in the listing page
Array of Properties
name
string
Required
Name of the product
product_id
integer
Required
Unique identifier of the product
brand
string
Required
Brand name for the product
esp
number
Required
Effective selling price of the product
mrp
number
Required
Maximum retail price of the product
currency
string
Required
currency code for the product
user_id
string|null
Required
Unique identifier for the user.
anonymous_id
string
Required
Anonymous identifier for the user.
version
string
Required
Version of the event.
Payload Schema JSON
1{2 "type": "object",3 "properties": {4 "application_id": {5 "type": [6 "array",7 "string"8 ],9 "description": "Application ID(Sales Channel) for which this event is triggered"10 },11 "contains": {12 "type": "array",13 "description": "This array will have all the keys present at root level of 'payload' object",14 "items": {15 "type": "string"16 }17 },18 "event": {19 "type": "object",20 "required": [21 "category",22 "created_timestamp",23 "id",24 "name",25 "trace_id",26 "type",27 "version"28 ],29 "properties": {30 "category": {31 "type": "string",32 "description": "Category of the event. If it is at sales channel level or company level"33 },34 "created_timestamp": {35 "type": "integer",36 "description": "Event generation timestamp in epoch milliseconds"37 },38 "id": {39 "type": "string",40 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"41 },42 "name": {43 "type": "string",44 "description": "Name of the event"45 },46 "trace_id": {47 "type": "array",48 "description": "Internal trace_id for Fynd Platform services",49 "items": {50 "type": "string"51 }52 },53 "type": {54 "type": "string",55 "description": "Type/Action of the event. e.g. create/update/delete"56 },57 "version": {58 "type": "string",59 "description": "Version of the event."60 }61 }62 },63 "payload": {64 "type": "object",65 "description": "Payload for the generated event",66 "required": [67 "context",68 "query",69 "item_total",70 "products",71 "user_id",72 "anonymous_id",73 "version"74 ],75 "properties": {76 "query": {77 "type": "string",78 "description": "Searcg string passed by the user."79 },80 "context": {81 "type": "object",82 "required": [83 "library",84 "os",85 "timezone",86 "screen",87 "userAgent",88 "locale",89 "device"90 ],91 "description": "Context information related to the event.",92 "properties": {93 "library": {94 "type": "object",95 "description": "Information about the library used.",96 "properties": {97 "name": {98 "type": "string",99 "description": "Name of the library."100 },101 "version": {102 "type": "string",103 "description": "Version of the library."104 }105 },106 "required": [107 "name",108 "version"109 ]110 },111 "os": {112 "type": "object",113 "description": "Operating system information.",114 "properties": {115 "name": {116 "type": "string",117 "description": "Name of the operating system."118 },119 "version": {120 "type": "string",121 "description": "Version of the operating system."122 }123 },124 "required": [125 "name",126 "version"127 ]128 },129 "timezone": {130 "type": "string",131 "description": "Timezone information."132 },133 "screen": {134 "type": "object",135 "description": "Screen resolution information.",136 "properties": {137 "width": {138 "type": "integer",139 "description": "Width of the screen."140 },141 "height": {142 "type": "integer",143 "description": "Height of the screen."144 }145 },146 "required": [147 "width",148 "height"149 ]150 },151 "userAgent": {152 "type": "string",153 "description": "User agent string indicating the browser or application."154 },155 "locale": {156 "type": "string",157 "description": "Locale information of the device."158 },159 "device": {160 "type": "object",161 "description": "Details of the device.",162 "properties": {163 "isMobile": {164 "type": "boolean",165 "description": "Flag indicating whether the device is a mobile device or not."166 }167 },168 "required": [169 "isMobile"170 ]171 }172 }173 },174 "item_total": {175 "type": "integer",176 "description": "Total items present in the listing page"177 },178 "products": {179 "type": "array",180 "description": "List of products present in the listing page",181 "items": {182 "type": "object",183 "description": "product details present in the list",184 "required": [185 "name",186 "product_id",187 "brand",188 "esp",189 "mrp",190 "currency",191 "source_url"192 ],193 "properties": {194 "name": {195 "type": "string",196 "description": "Name of the product"197 },198 "product_id": {199 "type": "integer",200 "description": "Unique identifier of the product"201 },202 "brand": {203 "type": "string",204 "description": "Brand name for the product"205 },206 "esp": {207 "type": "number",208 "description": "Effective selling price of the product"209 },210 "mrp": {211 "type": "number",212 "description": "Maximum retail price of the product"213 },214 "currency": {215 "type": "string",216 "description": "currency code for the product"217 }218 }219 }220 },221 "user_id": {222 "type": [223 "string",224 "null"225 ],226 "description": "Unique identifier for the user."227 },228 "anonymous_id": {229 "type": "string",230 "description": "Anonymous identifier for the user."231 },232 "version": {233 "type": "string",234 "description": "Version of the event."235 }236 }237 }238 },239 "required": [240 "application_id",241 "contains",242 "event",243 "payload"244 ]245}
Payload Example
1{2 "event": {3 "trace_id": [4 "A5ls7UG+vRaQ3JNxnyJu/Vdlp50vSJLYUpIJzZsx1H8="5 ],6 "name": "order_checkedout",7 "type": "conversion",8 "version": "1",9 "created_timestamp": 1716285106309,10 "id": "A5ls7UG+vRaQ3JNxnyJu/Vdlp50vSJLYUpIJzZsx1H8=",11 "category": "click"12 },13 "contains": [14 "context",15 "user_id",16 "anonymous_id",17 "cart_id",18 "order_id",19 "cart_total",20 "shipping",21 "tax",22 "order_total",23 "currency",24 "products",25 "version"26 ],27 "payload": {28 "query": "allen solly",29 "item_total": 1,30 "context": {31 "library": {32 "name": "flick",33 "version": "1.0.4"34 },35 "os": {36 "name": "Mac OS",37 "version": "10.15.7"38 },39 "timezone": "Asia/Calcutta",40 "screen": {41 "width": 1512,42 "height": 85943 },44 "userAgent": "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",45 "locale": "en-GB",46 "device": {47 "isMobile": false48 }49 },50 "user_id": "791392dc-e279-43f9-914c-e8a42a9ee421",51 "anonymous_id": "791392dc-e279-43f9-914c-e8a42a9ee421",52 "products": [53 {54 "product_id": 7839296,55 "name": "painted pants",56 "brand": "Allen solly",57 "esp": 10,58 "mrp": 14,59 "currency": "INR"60 }61 ],62 "version": "1"63 },64 "application_id": [65 "000000000000000000000001"66 ]67}
Was this section helpful?
This event generated to track the products searched by the user. It captures actions such as search queries performed along with the query entered by the user. It also provides details like user device and user details to be used for analytical purposes.
Events
click/product_search/search/v1
# This event is triggered when a user interacts with the product search functionality on the storefront.
Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Payload of the emitted event
Properties
item_total
integer
Required
Total number of items returned by the search
products
array of string
Required
List of product names returned by the search
context
object
Required
Context information related to the event.
Properties
library
object
Required
Information about the library used.
Properties
name
string
Required
Name of the library.
version
string
Required
Version of the library.
os
object
Required
Information about the operating system.
Properties
name
string
Required
Name of the operating system.
version
string
Required
Version of the operating system.
timezone
string
Required
Timezone of the user's location.
screen
object
Required
Information about the screen.
Properties
width
integer
Required
Width of the screen in pixels.
height
integer
Required
Height of the screen in pixels.
userAgent
string
Required
User agent string of the device.
locale
string
Required
Locale information of the user.
device
object
Required
Information about the device.
Properties
isMobile
boolean
Required
Flag indicating whether the device is mobile or not.
query
string
Required
Search query entered by the user.
user_id
string|null
Required
Identifier of the user.
anonymous_id
string
Required
Anonymous identifier of the user.
version
string
Required
Version of the event schema.
Payload Schema JSON
1{2 "type": "object",3 "description": "This event will track when user searches for any product on the sales channel",4 "properties": {5 "application_id": {6 "type": [7 "array",8 "string"9 ],10 "description": "Application ID(Sales Channel) for which this event is triggered"11 },12 "contains": {13 "type": "array",14 "description": "This array will have all the keys present at root level of 'payload' object",15 "items": {16 "type": "string"17 }18 },19 "event": {20 "type": "object",21 "required": [22 "category",23 "created_timestamp",24 "id",25 "name",26 "trace_id",27 "type",28 "version"29 ],30 "properties": {31 "category": {32 "type": "string",33 "description": "Category of the event. If it is at sales channel level or company level"34 },35 "created_timestamp": {36 "type": "integer",37 "description": "Event generation timestamp in epoch milliseconds"38 },39 "id": {40 "type": "string",41 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"42 },43 "name": {44 "type": "string",45 "description": "Name of the event"46 },47 "trace_id": {48 "type": "array",49 "description": "Internal trace_id for Fynd Platform services",50 "items": {51 "type": "string"52 }53 },54 "type": {55 "type": "string",56 "description": "Type/Action of the event. e.g. create/update/delete"57 },58 "version": {59 "type": "string",60 "description": "Version of the event."61 }62 }63 },64 "payload": {65 "type": "object",66 "description": "Payload of the emitted event",67 "properties": {68 "item_total": {69 "type": "integer",70 "description": "Total number of items returned by the search"71 },72 "products": {73 "type": "array",74 "description": "List of product names returned by the search",75 "items": {76 "type": "string",77 "description": "Name of the product"78 }79 },80 "context": {81 "type": "object",82 "description": "Context information related to the event.",83 "properties": {84 "library": {85 "type": "object",86 "description": "Information about the library used.",87 "properties": {88 "name": {89 "type": "string",90 "description": "Name of the library."91 },92 "version": {93 "type": "string",94 "description": "Version of the library."95 }96 },97 "required": [98 "name",99 "version"100 ]101 },102 "os": {103 "type": "object",104 "description": "Information about the operating system.",105 "properties": {106 "name": {107 "type": "string",108 "description": "Name of the operating system."109 },110 "version": {111 "type": "string",112 "description": "Version of the operating system."113 }114 },115 "required": [116 "name",117 "version"118 ]119 },120 "timezone": {121 "type": "string",122 "description": "Timezone of the user's location."123 },124 "screen": {125 "type": "object",126 "description": "Information about the screen.",127 "properties": {128 "width": {129 "type": "integer",130 "description": "Width of the screen in pixels."131 },132 "height": {133 "type": "integer",134 "description": "Height of the screen in pixels."135 }136 },137 "required": [138 "width",139 "height"140 ]141 },142 "userAgent": {143 "type": "string",144 "description": "User agent string of the device."145 },146 "locale": {147 "type": "string",148 "description": "Locale information of the user."149 },150 "device": {151 "type": "object",152 "description": "Information about the device.",153 "properties": {154 "isMobile": {155 "type": "boolean",156 "description": "Flag indicating whether the device is mobile or not."157 }158 },159 "required": [160 "isMobile"161 ]162 }163 },164 "required": [165 "library",166 "os",167 "timezone",168 "screen",169 "userAgent",170 "locale",171 "device"172 ]173 },174 "query": {175 "type": "string",176 "description": "Search query entered by the user."177 },178 "user_id": {179 "type": [180 "string",181 "null"182 ],183 "description": "Identifier of the user."184 },185 "anonymous_id": {186 "type": "string",187 "description": "Anonymous identifier of the user."188 },189 "version": {190 "type": "string",191 "description": "Version of the event schema."192 }193 },194 "required": [195 "context",196 "query",197 "user_id",198 "item_total",199 "products",200 "anonymous_id",201 "version"202 ]203 }204 },205 "required": [206 "application_id",207 "payload",208 "contains",209 "event"210 ]211}
Payload Example
1{2 "event": {3 "trace_id": [4 "KGS8Q5JbsGZcMHYEUrVnVM4cFk4kE7Fty18gkjiCV8I="5 ],6 "name": "product_search",7 "type": "search",8 "version": "1",9 "created_timestamp": 1715866448387,10 "id": "KGS8Q5JbsGZcMHYEUrVnVM4cFk4kE7Fty18gkjiCV8I=",11 "category": "click"12 },13 "contains": [14 "context",15 "user_id",16 "anonymous_id",17 "query",18 "version"19 ],20 "payload": {21 "item_total": 1,22 "products": [23 "Printed shirt",24 "Printed Pants"25 ],26 "context": {27 "library": {28 "name": "flick",29 "version": "1.0.4"30 },31 "os": {32 "name": "Mac OS",33 "version": "10.15.7"34 },35 "timezone": "Asia/Calcutta",36 "screen": {37 "width": 1440,38 "height": 90039 },40 "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36",41 "locale": "en-GB",42 "device": {43 "isMobile": false44 }45 },46 "user_id": null,47 "anonymous_id": "6d9ef02b-2d66-4642-b552-1adeebd63c18",48 "query": "duck",49 "version": "1"50 },51 "application_id": [52 "000000000000000000000001"53 ]54}
Was this section helpful?
This event is triggered when the user views a product within the storefront. It captures details such as product ID, category, price, and user information, providing valuable insights for analytical and marketing purposes.
Events
click/product_view/click/v1
# This event is triggered when a user views a product within the storefront.
Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
payload for the emitted event
Properties
query
string
Required
Query entered by the user
utm_medium
string
This field captures the medium through which the visitor has reached the product
utm_source
string
This field specifies the origin of your navigation, whether trending, or frequently bought together
utm_campaign
string
This field is used to identify a specific product promotion or recommendation being applied.
context
object
Required
Contextual information about the event.
Properties
library
object
Required
Information about the library used.
Properties
name
string
Required
Name of the library.
version
string
Required
Version of the library.
os
object
Required
Information about the operating system.
Properties
name
string
Required
Name of the operating system.
version
string
Required
Version of the operating system.
timezone
string
Required
Timezone of the event.
screen
object
Required
Information about the screen.
Properties
width
integer
Required
Width of the screen.
height
integer
Required
Height of the screen.
userAgent
string
Required
User agent of the device.
locale
string
Required
Locale of the event.
device
object
Required
Information about the device.
Properties
isMobile
boolean
Required
Indicates if the device is mobile or not.
product_id
integer
Required
ID of the product viewed.
currency
string
Required
Currency used for the product.
brand
string
Required
Brand of the product.
l3_category
string
Required
Level 3 category of the product.
mrp
integer
Required
Maximum retail price of the product.
esp
integer
Required
Effective selling price of the product.
l1_category
string
Required
Level 1 category of the product.
source_url
string
Required
Source URL of the product.
quantity
integer
Required
Quantity of the product viewed.
position
string
Required
Position of the product in the view.
user_id
null|string
Required
ID of the user (if available).
anonymous_id
string
Required
Anonymous ID of the user.
version
string
Required
Version of the event schema.
Payload Schema JSON
1{2 "type": "object",3 "description": "Payload for the product view event.",4 "properties": {5 "application_id": {6 "type": [7 "array",8 "string"9 ],10 "description": "Application ID(Sales Channel) for which this event is triggered"11 },12 "contains": {13 "type": "array",14 "description": "This array will have all the keys present at root level of 'payload' object",15 "items": {16 "type": "string"17 }18 },19 "event": {20 "type": "object",21 "required": [22 "category",23 "created_timestamp",24 "id",25 "name",26 "trace_id",27 "type",28 "version"29 ],30 "properties": {31 "category": {32 "type": "string",33 "description": "Category of the event. If it is at sales channel level or company level"34 },35 "created_timestamp": {36 "type": "integer",37 "description": "Event generation timestamp in epoch milliseconds"38 },39 "id": {40 "type": "string",41 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"42 },43 "name": {44 "type": "string",45 "description": "Name of the event"46 },47 "trace_id": {48 "type": "array",49 "description": "Internal trace_id for Fynd Platform services",50 "items": {51 "type": "string"52 }53 },54 "type": {55 "type": "string",56 "description": "Type/Action of the event. e.g. create/update/delete"57 },58 "version": {59 "type": "string",60 "description": "Version of the event."61 }62 }63 },64 "payload": {65 "type": "object",66 "description": "payload for the emitted event",67 "required": [68 "context",69 "product_id",70 "currency",71 "brand",72 "l3_category",73 "mrp",74 "esp",75 "l1_category",76 "source_url",77 "quantity",78 "position",79 "user_id",80 "anonymous_id",81 "version",82 "query"83 ],84 "properties": {85 "query": {86 "type": "string",87 "description": "Query entered by the user"88 },89 "utm_medium": {90 "type": "string",91 "description": "This field captures the medium through which the visitor has reached the product"92 },93 "utm_source": {94 "type": "string",95 "description": "This field specifies the origin of your navigation, whether trending, or frequently bought together"96 },97 "utm_campaign": {98 "type": "string",99 "description": "This field is used to identify a specific product promotion or recommendation being applied."100 },101 "context": {102 "type": "object",103 "description": "Contextual information about the event.",104 "properties": {105 "library": {106 "type": "object",107 "description": "Information about the library used.",108 "properties": {109 "name": {110 "type": "string",111 "description": "Name of the library."112 },113 "version": {114 "type": "string",115 "description": "Version of the library."116 }117 },118 "required": [119 "name",120 "version"121 ]122 },123 "os": {124 "type": "object",125 "description": "Information about the operating system.",126 "properties": {127 "name": {128 "type": "string",129 "description": "Name of the operating system."130 },131 "version": {132 "type": "string",133 "description": "Version of the operating system."134 }135 },136 "required": [137 "name",138 "version"139 ]140 },141 "timezone": {142 "type": "string",143 "description": "Timezone of the event."144 },145 "screen": {146 "type": "object",147 "description": "Information about the screen.",148 "properties": {149 "width": {150 "type": "integer",151 "description": "Width of the screen."152 },153 "height": {154 "type": "integer",155 "description": "Height of the screen."156 }157 },158 "required": [159 "width",160 "height"161 ]162 },163 "userAgent": {164 "type": "string",165 "description": "User agent of the device."166 },167 "locale": {168 "type": "string",169 "description": "Locale of the event."170 },171 "device": {172 "type": "object",173 "description": "Information about the device.",174 "properties": {175 "isMobile": {176 "type": "boolean",177 "description": "Indicates if the device is mobile or not."178 }179 },180 "required": [181 "isMobile"182 ]183 }184 },185 "required": [186 "library",187 "os",188 "timezone",189 "screen",190 "userAgent",191 "locale",192 "device"193 ]194 },195 "product_id": {196 "type": "integer",197 "description": "ID of the product viewed."198 },199 "currency": {200 "type": "string",201 "description": "Currency used for the product."202 },203 "brand": {204 "type": "string",205 "description": "Brand of the product."206 },207 "l3_category": {208 "type": "string",209 "description": "Level 3 category of the product."210 },211 "mrp": {212 "type": "integer",213 "description": "Maximum retail price of the product."214 },215 "esp": {216 "type": "integer",217 "description": "Effective selling price of the product."218 },219 "l1_category": {220 "type": "string",221 "description": "Level 1 category of the product."222 },223 "source_url": {224 "type": "string",225 "description": "Source URL of the product."226 },227 "quantity": {228 "type": "integer",229 "description": "Quantity of the product viewed."230 },231 "position": {232 "type": "string",233 "description": "Position of the product in the view."234 },235 "user_id": {236 "type": [237 "null",238 "string"239 ],240 "description": "ID of the user (if available)."241 },242 "anonymous_id": {243 "type": "string",244 "description": "Anonymous ID of the user."245 },246 "version": {247 "type": "string",248 "description": "Version of the event schema."249 }250 }251 }252 },253 "required": [254 "application_id",255 "contains",256 "event",257 "payload"258 ]259}
Payload Example
1{2 "event": {3 "trace_id": [4 "HpWvKcTnuS9buC4qIZiYMYZQEU/QkwdtCYResZd8Y9E="5 ],6 "name": "product_view",7 "type": "click",8 "version": "1",9 "created_timestamp": 1716282808521,10 "id": "HpWvKcTnuS9buC4qIZiYMYZQEU/QkwdtCYResZd8Y9E=",11 "category": "click"12 },13 "contains": [14 "context",15 "user_id",16 "anonymous_id",17 "product_id",18 "currency",19 "brand",20 "l3_category",21 "mrp",22 "esp",23 "l1_category",24 "source_url",25 "quantity",26 "position",27 "version"28 ],29 "payload": {30 "query": "Allen",31 "utm_medium": "product_recommendation",32 "utm_source": "product_page",33 "utm_campaign": "similar_products",34 "context": {35 "library": {36 "name": "flick",37 "version": "1.0.4"38 },39 "os": {40 "name": "Mac OS",41 "version": "10.15.7"42 },43 "timezone": "Asia/Calcutta",44 "screen": {45 "width": 1512,46 "height": 95047 },48 "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36",49 "locale": "en-GB",50 "device": {51 "isMobile": false52 }53 },54 "user_id": null,55 "anonymous_id": "c0225840-1973-42c9-b092-0362ebfab9e0",56 "product_id": 7838932,57 "currency": "INR",58 "brand": "Nike",59 "l3_category": "Lights",60 "mrp": 400,61 "esp": 400,62 "l1_category": "Electronic",63 "source_url": "/product/uat-aditya-prism-2-7838932",64 "quantity": 1330,65 "position": "TODO",66 "version": "1"67 },68 "application_id": [69 "000000000000000000000001"70 ]71}
Was this section helpful?
This event is triggered when a user adds a product to their wishlist within the storefront. It captures details such as wishlist name, ID, product details, and user information, providing valuable insights for tracking user engagement and preferences.
Events
click/product_wishlist_add/engagement/v1
# This event is triggered when a user adds a product to their wishlist within the storefront.
Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
position
number
Required
Position of the item in product listing page
utm_medium
string
This field captures the medium through which the visitor has reached the product
utm_source
string
This field specifies the origin of your navigation, whether trending, or frequently bought together
utm_campaign
string
This field is used to identify a specific product promotion or recommendation being applied.
query
string
Required
Query entered by the user
context
object
Required
Contextual information about the event.
Properties
library
object
Required
Information about the library used.
Properties
name
string
Required
Name of the library.
version
string
Required
Version of the library.
os
object
Required
Information about the operating system.
Properties
name
string
Required
Name of the operating system.
version
string
Required
Version of the operating system.
timezone
string
Required
Timezone of the event.
screen
object
Required
Information about the screen.
Properties
width
integer
Required
Width of the screen.
height
integer
Required
Height of the screen.
userAgent
string
Required
User agent of the device.
locale
string
Required
Locale of the event.
device
object
Required
Information about the device.
Properties
isMobile
boolean
Required
Indicates if the device is mobile or not.
wishlist_name
string
Required
Name of the wishlist.
wishlist_id
string
Required
ID of the wishlist.
product_id
integer
Required
ID of the product in the wishlist.
brand
string
Required
Brand of the product.
l3_category
string
Required
Level 3 category of the product.
mrp
null
Required
Maximum retail price of the product (if applicable).
quantity
string
Required
Quantity of the product in the wishlist.
esp
null
Required
Effective selling price of the product (if applicable).
currency
null
Required
Currency used for the product (if applicable).
value
string
Required
Value associated with the product in the wishlist.
source_url
string
Required
Source URL of the product.
user_id
string|null
Required
ID of the user.
anonymous_id
string
Required
Anonymous ID of the user.
version
string
Required
Version of the event schema.
Payload Schema JSON
1{2 "description": "payload for product whislist add event",3 "type": "object",4 "properties": {5 "application_id": {6 "type": [7 "array",8 "string"9 ],10 "description": "Application ID(Sales Channel) for which this event is triggered"11 },12 "contains": {13 "type": "array",14 "description": "This array will have all the keys present at root level of 'payload' object",15 "items": {16 "type": "string"17 }18 },19 "event": {20 "type": "object",21 "required": [22 "category",23 "created_timestamp",24 "id",25 "name",26 "trace_id",27 "type",28 "version"29 ],30 "properties": {31 "category": {32 "type": "string",33 "description": "Category of the event. If it is at sales channel level or company level"34 },35 "created_timestamp": {36 "type": "integer",37 "description": "Event generation timestamp in epoch milliseconds"38 },39 "id": {40 "type": "string",41 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"42 },43 "name": {44 "type": "string",45 "description": "Name of the event"46 },47 "trace_id": {48 "type": "array",49 "description": "Internal trace_id for Fynd Platform services",50 "items": {51 "type": "string"52 }53 },54 "type": {55 "type": "string",56 "description": "Type/Action of the event. e.g. create/update/delete"57 },58 "version": {59 "type": "string",60 "description": "Version of the event."61 }62 }63 },64 "payload": {65 "type": "object",66 "properties": {67 "position": {68 "type": "number",69 "description": "Position of the item in product listing page"70 },71 "utm_medium": {72 "type": "string",73 "description": "This field captures the medium through which the visitor has reached the product"74 },75 "utm_source": {76 "type": "string",77 "description": "This field specifies the origin of your navigation, whether trending, or frequently bought together"78 },79 "utm_campaign": {80 "type": "string",81 "description": "This field is used to identify a specific product promotion or recommendation being applied."82 },83 "query": {84 "type": "string",85 "description": "Query entered by the user"86 },87 "context": {88 "type": "object",89 "description": "Contextual information about the event.",90 "properties": {91 "library": {92 "type": "object",93 "description": "Information about the library used.",94 "properties": {95 "name": {96 "type": "string",97 "description": "Name of the library."98 },99 "version": {100 "type": "string",101 "description": "Version of the library."102 }103 },104 "required": [105 "name",106 "version"107 ]108 },109 "os": {110 "type": "object",111 "description": "Information about the operating system.",112 "properties": {113 "name": {114 "type": "string",115 "description": "Name of the operating system."116 },117 "version": {118 "type": "string",119 "description": "Version of the operating system."120 }121 },122 "required": [123 "name",124 "version"125 ]126 },127 "timezone": {128 "type": "string",129 "description": "Timezone of the event."130 },131 "screen": {132 "type": "object",133 "description": "Information about the screen.",134 "properties": {135 "width": {136 "type": "integer",137 "description": "Width of the screen."138 },139 "height": {140 "type": "integer",141 "description": "Height of the screen."142 }143 },144 "required": [145 "width",146 "height"147 ]148 },149 "userAgent": {150 "type": "string",151 "description": "User agent of the device."152 },153 "locale": {154 "type": "string",155 "description": "Locale of the event."156 },157 "device": {158 "type": "object",159 "description": "Information about the device.",160 "properties": {161 "isMobile": {162 "type": "boolean",163 "description": "Indicates if the device is mobile or not."164 }165 },166 "required": [167 "isMobile"168 ]169 }170 },171 "required": [172 "library",173 "os",174 "timezone",175 "screen",176 "userAgent",177 "locale",178 "device"179 ]180 },181 "wishlist_name": {182 "type": "string",183 "description": "Name of the wishlist."184 },185 "wishlist_id": {186 "type": "string",187 "description": "ID of the wishlist."188 },189 "product_id": {190 "type": "integer",191 "description": "ID of the product in the wishlist."192 },193 "brand": {194 "type": "string",195 "description": "Brand of the product."196 },197 "l3_category": {198 "type": "string",199 "description": "Level 3 category of the product."200 },201 "mrp": {202 "type": "null",203 "description": "Maximum retail price of the product (if applicable)."204 },205 "quantity": {206 "type": "string",207 "description": "Quantity of the product in the wishlist."208 },209 "esp": {210 "type": "null",211 "description": "Effective selling price of the product (if applicable)."212 },213 "currency": {214 "type": "null",215 "description": "Currency used for the product (if applicable)."216 },217 "value": {218 "type": "string",219 "description": "Value associated with the product in the wishlist."220 },221 "source_url": {222 "type": "string",223 "description": "Source URL of the product.",224 "required": [225 "wishlist_name",226 "wishlist_id",227 "event_type",228 "product_id",229 "brand",230 "l3_category",231 "mrp",232 "quantity",233 "esp",234 "currency",235 "value",236 "source_url"237 ]238 },239 "user_id": {240 "type": [241 "string",242 "null"243 ],244 "description": "ID of the user."245 },246 "anonymous_id": {247 "type": "string",248 "description": "Anonymous ID of the user."249 },250 "version": {251 "type": "string",252 "description": "Version of the event schema."253 }254 },255 "required": [256 "context",257 "wishlist_name",258 "wishlist_id",259 "product_id",260 "brand",261 "l3_category",262 "mrp",263 "quantity",264 "esp",265 "currency",266 "value",267 "query",268 "position",269 "source_url",270 "user_id",271 "version",272 "anonymous_id"273 ]274 }275 },276 "required": [277 "application_id",278 "contains",279 "event",280 "payload"281 ]282}
Payload Example
1{2 "event": {3 "trace_id": [4 "VgFGTgI4ZUytTK4d4qLiUynDAWmQEt89RjFPCyizLOY="5 ],6 "name": "product_wishlist_add",7 "type": "engagement",8 "version": "1",9 "created_timestamp": 1716277585646,10 "id": "VgFGTgI4ZUytTK4d4qLiUynDAWmQEt89RjFPCyizLOY=",11 "category": "click"12 },13 "contains": [14 "context",15 "user_id",16 "wishlist_name",17 "wishlist_id",18 "product_id",19 "brand",20 "l3_category",21 "mrp",22 "quantity",23 "esp",24 "currency",25 "value",26 "source_url",27 "version"28 ],29 "payload": {30 "context": {31 "utm_medium": "product_recommendation",32 "utm_source": "product_page",33 "utm_campaign": "similar_products",34 "position": 1,35 "query": "allen solly",36 "library": {37 "name": "flick",38 "version": "1.0.4"39 },40 "os": {41 "name": "Mac OS",42 "version": "10.15.7"43 },44 "timezone": "Asia/Calcutta",45 "screen": {46 "width": 1512,47 "height": 94448 },49 "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36",50 "locale": "en-US",51 "device": {52 "isMobile": false53 }54 },55 "user_id": "65e89a08fe5e1020d276095f",56 "anonymous_id": "65e89a08fe5e1020d276095f",57 "wishlist_name": "TODO",58 "wishlist_id": "TODO",59 "product_id": 7868730,60 "brand": "Mad Over Print",61 "l3_category": "Oversized T-Shirts",62 "mrp": null,63 "quantity": "TODO",64 "esp": null,65 "currency": null,66 "value": "TODO",67 "source_url": "TODO",68 "version": "1"69 },70 "application_id": [71 "000000000000000000000001"72 ]73}
Was this section helpful?
This event is triggered when a user removes a product from their wishlist within the storefront. It captures details such as wishlist name, ID, product details, and user information, providing valuable insights for tracking user engagement and preferences.
Events
click/product_wishlist_remove/engagement/v1
# This event is triggered when a user removes a product from their wishlist within the storefront.
Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Payload for the event emitted
Properties
context
object
Required
Contextual information about the event.
Properties
library
object
Required
Information about the library used.
Properties
name
string
Required
Name of the library.
version
string
Required
Version of the library.
os
object
Required
Information about the operating system.
Properties
name
string
Required
Name of the operating system.
version
string
Required
Version of the operating system.
timezone
string
Required
Timezone of the event.
screen
object
Required
Information about the screen.
Properties
width
integer
Required
Width of the screen.
height
integer
Required
Height of the screen.
userAgent
string
Required
User agent of the device.
locale
string
Required
Locale of the event.
device
object
Required
Information about the device.
Properties
isMobile
boolean
Required
Indicates if the device is mobile or not.
wishlist_name
string
Required
Name of the wishlist.
wishlist_id
string
Required
ID of the wishlist.
product_id
integer
Required
ID of the product removed from the wishlist.
brand
string
Required
Brand of the product.
l3_category
string
Required
Level 3 category of the product.
mrp
null|number
Required
Maximum retail price of the product (if applicable).
quantity
string
Required
Quantity of the product in the wishlist.
esp
null|number
Required
Effective selling price of the product (if applicable).
currency
null|string
Required
Currency used for the product (if applicable).
value
string
Required
Value associated with the product in the wishlist.
source_url
string
Required
Source URL of the product.
user_id
string|null
Required
ID of the user.
anonymous_id
string
Required
Anonymous ID of the user.
version
string
Required
Version of the event schema.
Payload Schema JSON
1{2 "description": "Payload for the event associated with product removed from whishlist",3 "type": "object",4 "properties": {5 "application_id": {6 "type": [7 "array",8 "string"9 ],10 "description": "Application ID(Sales Channel) for which this event is triggered"11 },12 "contains": {13 "type": "array",14 "description": "This array will have all the keys present at root level of 'payload' object",15 "items": {16 "type": "string"17 }18 },19 "event": {20 "type": "object",21 "required": [22 "category",23 "created_timestamp",24 "id",25 "name",26 "trace_id",27 "type",28 "version"29 ],30 "properties": {31 "category": {32 "type": "string",33 "description": "Category of the event. If it is at sales channel level or company level"34 },35 "created_timestamp": {36 "type": "integer",37 "description": "Event generation timestamp in epoch milliseconds"38 },39 "id": {40 "type": "string",41 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"42 },43 "name": {44 "type": "string",45 "description": "Name of the event"46 },47 "trace_id": {48 "type": "array",49 "description": "Internal trace_id for Fynd Platform services",50 "items": {51 "type": "string"52 }53 },54 "type": {55 "type": "string",56 "description": "Type/Action of the event. e.g. create/update/delete"57 },58 "version": {59 "type": "string",60 "description": "Version of the event."61 }62 }63 },64 "payload": {65 "type": "object",66 "description": "Payload for the event emitted",67 "required": [68 "wishlist_name",69 "wishlist_id",70 "product_id",71 "brand",72 "l3_category",73 "mrp",74 "quantity",75 "esp",76 "currency",77 "value",78 "anonymous_id",79 "version",80 "context",81 "source_url",82 "user_id"83 ],84 "properties": {85 "context": {86 "type": "object",87 "description": "Contextual information about the event.",88 "properties": {89 "library": {90 "type": "object",91 "description": "Information about the library used.",92 "properties": {93 "name": {94 "type": "string",95 "description": "Name of the library."96 },97 "version": {98 "type": "string",99 "description": "Version of the library."100 }101 },102 "required": [103 "name",104 "version"105 ]106 },107 "os": {108 "type": "object",109 "description": "Information about the operating system.",110 "properties": {111 "name": {112 "type": "string",113 "description": "Name of the operating system."114 },115 "version": {116 "type": "string",117 "description": "Version of the operating system."118 }119 },120 "required": [121 "name",122 "version"123 ]124 },125 "timezone": {126 "type": "string",127 "description": "Timezone of the event."128 },129 "screen": {130 "type": "object",131 "description": "Information about the screen.",132 "properties": {133 "width": {134 "type": "integer",135 "description": "Width of the screen."136 },137 "height": {138 "type": "integer",139 "description": "Height of the screen."140 }141 },142 "required": [143 "width",144 "height"145 ]146 },147 "userAgent": {148 "type": "string",149 "description": "User agent of the device."150 },151 "locale": {152 "type": "string",153 "description": "Locale of the event."154 },155 "device": {156 "type": "object",157 "description": "Information about the device.",158 "properties": {159 "isMobile": {160 "type": "boolean",161 "description": "Indicates if the device is mobile or not."162 }163 },164 "required": [165 "isMobile"166 ]167 }168 },169 "required": [170 "library",171 "os",172 "timezone",173 "screen",174 "userAgent",175 "locale",176 "device"177 ]178 },179 "wishlist_name": {180 "type": "string",181 "description": "Name of the wishlist."182 },183 "wishlist_id": {184 "type": "string",185 "description": "ID of the wishlist."186 },187 "product_id": {188 "type": "integer",189 "description": "ID of the product removed from the wishlist."190 },191 "brand": {192 "type": "string",193 "description": "Brand of the product."194 },195 "l3_category": {196 "type": "string",197 "description": "Level 3 category of the product."198 },199 "mrp": {200 "type": [201 "null",202 "number"203 ],204 "description": "Maximum retail price of the product (if applicable)."205 },206 "quantity": {207 "type": "string",208 "description": "Quantity of the product in the wishlist."209 },210 "esp": {211 "type": [212 "null",213 "number"214 ],215 "description": "Effective selling price of the product (if applicable)."216 },217 "currency": {218 "type": [219 "null",220 "string"221 ],222 "description": "Currency used for the product (if applicable)."223 },224 "value": {225 "type": "string",226 "description": "Value associated with the product in the wishlist."227 },228 "source_url": {229 "type": "string",230 "description": "Source URL of the product."231 },232 "user_id": {233 "type": [234 "string",235 "null"236 ],237 "description": "ID of the user."238 },239 "anonymous_id": {240 "type": "string",241 "description": "Anonymous ID of the user."242 },243 "version": {244 "type": "string",245 "description": "Version of the event schema."246 }247 }248 }249 },250 "required": [251 "application_id",252 "contains",253 "event",254 "payload"255 ]256}
Payload Example
1{2 "event": {3 "trace_id": [4 "wow7H+y/E3AQ5hEKTtDOFaAJotMFCR5Xfu7aJvg1kFY="5 ],6 "name": "product_wishlist_remove",7 "type": "engagement",8 "version": "1",9 "created_timestamp": 1715849306370,10 "id": "wow7H+y/E3AQ5hEKTtDOFaAJotMFCR5Xfu7aJvg1kFY=",11 "category": "click"12 },13 "contains": [14 "context",15 "user_id",16 "anonymous_id",17 "wishlist_name",18 "wishlist_id",19 "product_id",20 "brand",21 "l3_category",22 "mrp",23 "quantity",24 "esp",25 "currency",26 "value",27 "source_url",28 "version"29 ],30 "payload": {31 "context": {32 "library": {33 "name": "flick",34 "version": "1.0.4"35 },36 "os": {37 "name": "Mac OS",38 "version": "10.15.7"39 },40 "timezone": "Asia/Calcutta",41 "screen": {42 "width": 1512,43 "height": 87644 },45 "userAgent": "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",46 "locale": "en-GB",47 "device": {48 "isMobile": false49 }50 },51 "user_id": "643f83231847e3c51b6bdb01",52 "anonymous_id": "00ac57d5-9d73-42e5-b186-fe4c8bea214d",53 "wishlist_name": "TODO",54 "wishlist_id": "TODO",55 "product_id": 7821808,56 "brand": "Sika",57 "l3_category": "Lights",58 "mrp": 1299,59 "quantity": "TODO",60 "esp": 1299,61 "currency": "INR",62 "value": "TODO",63 "source_url": "TODO",64 "version": "1"65 },66 "application_id": [67 "000000000000000000000001"68 ]69}
Was this section helpful?
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.
Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Payload for the emitted event.
Properties
context
object
Required
Contextual information about the event.
Properties
library
object
Required
Information about the library used.
Properties
name
string
Required
Name of the library.
version
string
Required
Version of the library.
os
object
Required
Information about the operating system.
Properties
name
string
Required
Name of the operating system.
version
string
Required
Version of the operating system.
timezone
string
Required
Timezone of the event.
screen
object
Required
Information about the screen.
Properties
width
integer
Required
Width of the screen.
height
integer
Required
Height of the screen.
userAgent
string
Required
User agent of the device.
locale
string
Required
Locale of the event.
device
object
Required
Information about the device.
Properties
isMobile
boolean
Required
Indicates if the device is mobile or not.
cart_id
string
Required
ID of the cart from which the product is being removed.
event_type
string
Type of the event.
product_id
integer
Required
ID of the product being removed from the cart.
brand
string
Required
Brand of the product.
l3_category
string
Required
Level 3 category of the product.
l1_category
string
Required
Level 1 category of the product.
currency
string
Required
Currency used for the product.
price
integer
Required
Price of the product.
quantity
integer
Required
Quantity of the product being removed.
source_url
string
Required
Source URL of the product.
position
string
Required
Position of the product in the cart.
value
string
Required
Value associated with the product being removed.
user_id
string|null
Required
ID of the user.
anonymous_id
string
Anonymous ID of the user.
version
string
Version of the event schema.
Payload Schema JSON
1{2 "description": "Payload for remove from cart event",3 "type": "object",4 "properties": {5 "application_id": {6 "type": [7 "array",8 "string"9 ],10 "description": "Application ID(Sales Channel) for which this event is triggered"11 },12 "contains": {13 "type": "array",14 "description": "This array will have all the keys present at root level of 'payload' object",15 "items": {16 "type": "string"17 }18 },19 "event": {20 "type": "object",21 "required": [22 "category",23 "created_timestamp",24 "id",25 "name",26 "trace_id",27 "type",28 "version"29 ],30 "properties": {31 "category": {32 "type": "string",33 "description": "Category of the event. If it is at sales channel level or company level"34 },35 "created_timestamp": {36 "type": "integer",37 "description": "Event generation timestamp in epoch milliseconds"38 },39 "id": {40 "type": "string",41 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"42 },43 "name": {44 "type": "string",45 "description": "Name of the event"46 },47 "trace_id": {48 "type": "array",49 "description": "Internal trace_id for Fynd Platform services",50 "items": {51 "type": "string"52 }53 },54 "type": {55 "type": "string",56 "description": "Type/Action of the event. e.g. create/update/delete"57 },58 "version": {59 "type": "string",60 "description": "Version of the event."61 }62 }63 },64 "payload": {65 "type": "object",66 "description": "Payload for the emitted event.",67 "properties": {68 "context": {69 "type": "object",70 "description": "Contextual information about the event.",71 "properties": {72 "library": {73 "type": "object",74 "description": "Information about the library used.",75 "properties": {76 "name": {77 "type": "string",78 "description": "Name of the library."79 },80 "version": {81 "type": "string",82 "description": "Version of the library."83 }84 },85 "required": [86 "name",87 "version"88 ]89 },90 "os": {91 "type": "object",92 "description": "Information about the operating system.",93 "properties": {94 "name": {95 "type": "string",96 "description": "Name of the operating system."97 },98 "version": {99 "type": "string",100 "description": "Version of the operating system."101 }102 },103 "required": [104 "name",105 "version"106 ]107 },108 "timezone": {109 "type": "string",110 "description": "Timezone of the event."111 },112 "screen": {113 "type": "object",114 "description": "Information about the screen.",115 "properties": {116 "width": {117 "type": "integer",118 "description": "Width of the screen."119 },120 "height": {121 "type": "integer",122 "description": "Height of the screen."123 }124 },125 "required": [126 "width",127 "height"128 ]129 },130 "userAgent": {131 "type": "string",132 "description": "User agent of the device."133 },134 "locale": {135 "type": "string",136 "description": "Locale of the event."137 },138 "device": {139 "type": "object",140 "description": "Information about the device.",141 "properties": {142 "isMobile": {143 "type": "boolean",144 "description": "Indicates if the device is mobile or not."145 }146 },147 "required": [148 "isMobile"149 ]150 }151 },152 "required": [153 "library",154 "os",155 "timezone",156 "screen",157 "userAgent",158 "locale",159 "device"160 ]161 },162 "cart_id": {163 "type": "string",164 "description": "ID of the cart from which the product is being removed."165 },166 "event_type": {167 "type": "string",168 "description": "Type of the event."169 },170 "product_id": {171 "type": "integer",172 "description": "ID of the product being removed from the cart."173 },174 "brand": {175 "type": "string",176 "description": "Brand of the product."177 },178 "l3_category": {179 "type": "string",180 "description": "Level 3 category of the product."181 },182 "l1_category": {183 "type": "string",184 "description": "Level 1 category of the product."185 },186 "currency": {187 "type": "string",188 "description": "Currency used for the product."189 },190 "price": {191 "type": "integer",192 "description": "Price of the product."193 },194 "quantity": {195 "type": "integer",196 "description": "Quantity of the product being removed."197 },198 "source_url": {199 "type": "string",200 "description": "Source URL of the product."201 },202 "position": {203 "type": "string",204 "description": "Position of the product in the cart."205 },206 "value": {207 "type": "string",208 "description": "Value associated with the product being removed."209 },210 "user_id": {211 "type": [212 "string",213 "null"214 ],215 "description": "ID of the user."216 },217 "anonymous_id": {218 "type": "string",219 "description": "Anonymous ID of the user."220 },221 "version": {222 "type": "string",223 "description": "Version of the event schema."224 }225 },226 "required": [227 "cart_id",228 "product_id",229 "brand",230 "l3_category",231 "l1_category",232 "currency",233 "price",234 "quantity",235 "source_url",236 "position",237 "value",238 "user_id",239 "context"240 ]241 }242 },243 "required": [244 "application_id",245 "contains",246 "event",247 "payload"248 ]249}
Payload Example
1{2 "event": {3 "trace_id": [4 "4svNI7KYTeRbXLfNL6SONy7LkTglJpYLSDEwpSdO9sw="5 ],6 "name": "remove_from_cart",7 "type": "engagement",8 "version": "1",9 "created_timestamp": 1716282514140,10 "id": "4svNI7KYTeRbXLfNL6SONy7LkTglJpYLSDEwpSdO9sw=",11 "category": "click"12 },13 "contains": [14 "context",15 "user_id",16 "cart_id",17 "product_id",18 "brand",19 "l3_category",20 "l1_category",21 "currency",22 "price",23 "quantity",24 "source_url",25 "position",26 "value",27 "version"28 ],29 "payload": {30 "context": {31 "library": {32 "name": "flick",33 "version": "1.0.4"34 },35 "os": {36 "name": "Mac OS",37 "version": "10.15.7"38 },39 "timezone": "Asia/Calcutta",40 "screen": {41 "width": 1512,42 "height": 94443 },44 "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36",45 "locale": "en-US",46 "device": {47 "isMobile": false48 }49 },50 "user_id": "65e89a08fe5e1020d276095f",51 "cart_id": "6613a2354410b7c4b14fef39",52 "product_id": 7803026,53 "brand": "REKOON",54 "l3_category": "Activewear T-Shirts",55 "l1_category": "TODO",56 "currency": "INR",57 "price": 186,58 "quantity": 3,59 "source_url": "TODO",60 "position": "TODO",61 "value": "TODO",62 "version": "1"63 },64 "application_id": [65 "000000000000000000000001"66 ]67}
Was this section helpful?
This event is triggered when a user logs into the storefront. It captures details such as login method, user device, and timestamp, providing insights into user authentication and behavior.
Events
click/user_login/identity/v1
# This event is triggered when a user logs into the storefront.
Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Payload for the generated event
Properties
context
object
Required
Contextual information about the event.
Properties
library
object
Required
Information about the library used.
Properties
name
string
Required
Name of the library.
version
string
Required
Version of the library.
os
object
Required
Information about the operating system.
Properties
name
string
Required
Name of the operating system.
version
string
Required
Version of the operating system.
timezone
string
Required
Timezone of the event.
screen
object
Required
Information about the screen.
Properties
width
integer
Required
Width of the screen.
height
integer
Required
Height of the screen.
userAgent
string
Required
User agent of the device.
locale
string
Required
Locale of the event.
device
object
Required
Information about the device.
Properties
isMobile
boolean
Required
Indicates if the device is mobile or not.
user_id
string|null
Required
ID of the user if they are logged in
anonymous_id
string
Required
User identifier in case user is not logged in
version
string
Required
Version of the event schema.
email
string
Email Id associated with the user
login_value
string
Required
Value associated with the login, might contain email id or number depending on the method
method
string
Required
Type of login opted by the user
phone
string
Phone number associated with the user
Payload Schema JSON
1{2 "description": "Payload for user login event",3 "type": "object",4 "properties": {5 "application_id": {6 "type": [7 "array",8 "string"9 ],10 "description": "Application ID(Sales Channel) for which this event is triggered"11 },12 "contains": {13 "type": "array",14 "description": "This array will have all the keys present at root level of 'payload' object",15 "items": {16 "type": "string"17 }18 },19 "event": {20 "type": "object",21 "required": [22 "category",23 "created_timestamp",24 "id",25 "name",26 "trace_id",27 "type",28 "version"29 ],30 "properties": {31 "category": {32 "type": "string",33 "description": "Category of the event. If it is at sales channel level or company level"34 },35 "created_timestamp": {36 "type": "integer",37 "description": "Event generation timestamp in epoch milliseconds"38 },39 "id": {40 "type": "string",41 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"42 },43 "name": {44 "type": "string",45 "description": "Name of the event"46 },47 "trace_id": {48 "type": "array",49 "description": "Internal trace_id for Fynd Platform services",50 "items": {51 "type": "string"52 }53 },54 "type": {55 "type": "string",56 "description": "Type/Action of the event. e.g. create/update/delete"57 },58 "version": {59 "type": "string",60 "description": "Version of the event."61 }62 }63 },64 "payload": {65 "type": "object",66 "description": "Payload for the generated event",67 "required": [68 "context",69 "user_id",70 "anonymous_id",71 "version",72 "login_value",73 "method"74 ],75 "properties": {76 "context": {77 "type": "object",78 "description": "Contextual information about the event.",79 "properties": {80 "library": {81 "type": "object",82 "description": "Information about the library used.",83 "properties": {84 "name": {85 "type": "string",86 "description": "Name of the library."87 },88 "version": {89 "type": "string",90 "description": "Version of the library."91 }92 },93 "required": [94 "name",95 "version"96 ]97 },98 "os": {99 "type": "object",100 "description": "Information about the operating system.",101 "properties": {102 "name": {103 "type": "string",104 "description": "Name of the operating system."105 },106 "version": {107 "type": "string",108 "description": "Version of the operating system."109 }110 },111 "required": [112 "name",113 "version"114 ]115 },116 "timezone": {117 "type": "string",118 "description": "Timezone of the event."119 },120 "screen": {121 "type": "object",122 "description": "Information about the screen.",123 "properties": {124 "width": {125 "type": "integer",126 "description": "Width of the screen."127 },128 "height": {129 "type": "integer",130 "description": "Height of the screen."131 }132 },133 "required": [134 "width",135 "height"136 ]137 },138 "userAgent": {139 "type": "string",140 "description": "User agent of the device."141 },142 "locale": {143 "type": "string",144 "description": "Locale of the event."145 },146 "device": {147 "type": "object",148 "description": "Information about the device.",149 "properties": {150 "isMobile": {151 "type": "boolean",152 "description": "Indicates if the device is mobile or not."153 }154 },155 "required": [156 "isMobile"157 ]158 }159 },160 "required": [161 "library",162 "os",163 "timezone",164 "screen",165 "userAgent",166 "locale",167 "device"168 ]169 },170 "user_id": {171 "type": [172 "string",173 "null"174 ],175 "description": "ID of the user if they are logged in"176 },177 "anonymous_id": {178 "type": "string",179 "description": "User identifier in case user is not logged in"180 },181 "version": {182 "type": "string",183 "description": "Version of the event schema."184 },185 "email": {186 "type": "string",187 "description": "Email Id associated with the user"188 },189 "login_value": {190 "type": "string",191 "description": "Value associated with the login, might contain email id or number depending on the method"192 },193 "method": {194 "type": "string",195 "description": "Type of login opted by the user"196 },197 "phone": {198 "type": "string",199 "description": "Phone number associated with the user"200 }201 }202 }203 },204 "required": [205 "contains",206 "event",207 "payload",208 "application_id"209 ]210}
Payload Example
1{2 "event": {3 "trace_id": [4 "6bSEmR1i0UsZt/eBKNE+AZQR8fCXHNptylXLFA9aneY="5 ],6 "name": "user_login",7 "type": "identity",8 "version": "1",9 "created_timestamp": 1716284742764,10 "id": "6bSEmR1i0UsZt/eBKNE+AZQR8fCXHNptylXLFA9aneY=",11 "category": "click"12 },13 "contains": [14 "context",15 "user_id",16 "email",17 "phone",18 "login_value",19 "method",20 "version"21 ],22 "payload": {23 "context": {24 "library": {25 "name": "flick",26 "version": "1.0.4"27 },28 "os": {29 "name": "Mac OS",30 "version": "10.15.7"31 },32 "timezone": "Asia/Calcutta",33 "screen": {34 "width": 1512,35 "height": 94436 },37 "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36",38 "locale": "en-US",39 "device": {40 "isMobile": false41 }42 },43 "user_id": "65e89a08fe5e1020d276095f",44 "anonymous_id": "65e8989f78e767670981f",45 "email": "[email protected]",46 "phone": "7738845950",47 "login_value": "7738845950",48 "method": "phone",49 "version": "1"50 },51 "application_id": [52 "000000000000000000000001"53 ]54}
Was this section helpful?
This event is triggered when a user logs out of the storefront. It provides insights into user session management and behavior.
Events
click/user_logout/identity/v1
# This event is triggered when a user logs out of the storefront.
Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Payload for the emitted event
Properties
context
object
Required
Contextual information about the event.
Properties
library
object
Required
Information about the library used.
Properties
name
string
Required
Name of the library.
version
string
Required
Version of the library.
os
object
Required
Information about the operating system.
Properties
name
string
Required
Name of the operating system.
version
string
Required
Version of the operating system.
timezone
string
Required
Timezone of the event.
screen
object
Required
Information about the screen.
Properties
width
integer
Required
Width of the screen.
height
integer
Required
Height of the screen.
userAgent
string
Required
User agent of the device.
locale
string
Required
Locale of the event.
device
object
Required
Information about the device.
Properties
isMobile
boolean
Required
Indicates if the device is mobile or not.
user_id
string|null
Required
ID of the user.
anonymous_id
string
Required
Anonymous ID of the user.
version
string
Required
Version of the event schema.
Payload Schema JSON
1{2 "description": "Paylod for the user logout event",3 "type": "object",4 "properties": {5 "application_id": {6 "type": [7 "array",8 "string"9 ],10 "description": "Application ID(Sales Channel) for which this event is triggered"11 },12 "contains": {13 "type": "array",14 "description": "This array will have all the keys present at root level of 'payload' object",15 "items": {16 "type": "string"17 }18 },19 "event": {20 "type": "object",21 "required": [22 "category",23 "created_timestamp",24 "id",25 "name",26 "trace_id",27 "type",28 "version"29 ],30 "properties": {31 "category": {32 "type": "string",33 "description": "Category of the event. If it is at sales channel level or company level"34 },35 "created_timestamp": {36 "type": "integer",37 "description": "Event generation timestamp in epoch milliseconds"38 },39 "id": {40 "type": "string",41 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"42 },43 "name": {44 "type": "string",45 "description": "Name of the event"46 },47 "trace_id": {48 "type": "array",49 "description": "Internal trace_id for Fynd Platform services",50 "items": {51 "type": "string"52 }53 },54 "type": {55 "type": "string",56 "description": "Type/Action of the event. e.g. create/update/delete"57 },58 "version": {59 "type": "string",60 "description": "Version of the event."61 }62 }63 },64 "payload": {65 "type": "object",66 "description": "Payload for the emitted event",67 "properties": {68 "context": {69 "type": "object",70 "description": "Contextual information about the event.",71 "properties": {72 "library": {73 "type": "object",74 "description": "Information about the library used.",75 "properties": {76 "name": {77 "type": "string",78 "description": "Name of the library."79 },80 "version": {81 "type": "string",82 "description": "Version of the library."83 }84 },85 "required": [86 "name",87 "version"88 ]89 },90 "os": {91 "type": "object",92 "description": "Information about the operating system.",93 "properties": {94 "name": {95 "type": "string",96 "description": "Name of the operating system."97 },98 "version": {99 "type": "string",100 "description": "Version of the operating system."101 }102 },103 "required": [104 "name",105 "version"106 ]107 },108 "timezone": {109 "type": "string",110 "description": "Timezone of the event."111 },112 "screen": {113 "type": "object",114 "description": "Information about the screen.",115 "properties": {116 "width": {117 "type": "integer",118 "description": "Width of the screen."119 },120 "height": {121 "type": "integer",122 "description": "Height of the screen."123 }124 },125 "required": [126 "width",127 "height"128 ]129 },130 "userAgent": {131 "type": "string",132 "description": "User agent of the device."133 },134 "locale": {135 "type": "string",136 "description": "Locale of the event."137 },138 "device": {139 "type": "object",140 "description": "Information about the device.",141 "properties": {142 "isMobile": {143 "type": "boolean",144 "description": "Indicates if the device is mobile or not."145 }146 },147 "required": [148 "isMobile"149 ]150 }151 },152 "required": [153 "library",154 "os",155 "timezone",156 "screen",157 "userAgent",158 "locale",159 "device"160 ]161 },162 "user_id": {163 "type": [164 "string",165 "null"166 ],167 "description": "ID of the user."168 },169 "anonymous_id": {170 "type": "string",171 "description": "Anonymous ID of the user."172 },173 "version": {174 "type": "string",175 "description": "Version of the event schema."176 }177 },178 "required": [179 "context",180 "user_id",181 "anonymous_id",182 "version"183 ]184 }185 },186 "required": [187 "application_id",188 "payload",189 "event",190 "contains"191 ]192}
Payload Example
1{2 "event": {3 "trace_id": [4 "AK3li886JoInd+cftJRD8GHZBS0kCMGjH8tfxT2N1k0="5 ],6 "name": "user_logout",7 "type": "identity",8 "version": "1",9 "created_timestamp": 1715843984995,10 "id": "AK3li886JoInd+cftJRD8GHZBS0kCMGjH8tfxT2N1k0=",11 "category": "click"12 },13 "contains": [14 "context",15 "user_id",16 "anonymous_id",17 "version"18 ],19 "payload": {20 "context": {21 "library": {22 "name": "flick",23 "version": "1.0.4"24 },25 "os": {26 "name": "Mac OS",27 "version": "10.15.7"28 },29 "timezone": "Asia/Calcutta",30 "screen": {31 "width": 1512,32 "height": 87633 },34 "userAgent": "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",35 "locale": "en-GB",36 "device": {37 "isMobile": false38 }39 },40 "user_id": "643f83231847e3c51b6bdb01",41 "anonymous_id": "d523da88-ee04-4f5a-b309-2a3de1bf28bb",42 "version": "1"43 },44 "application_id": [45 "000000000000000000000001"46 ]47}
Was this section helpful?