Global

Events categorised under global level will be triggered when any action performed for all companies. e.g. If new department is created.

Category

This event will be generated where there is any action done on category

Events

global/category/create/v1

# this event is triggered when category is created

global/category/update/v1

# this event is triggered when category is updated

Category/category/create/v1

this event is triggered when category is created

Payload

Hide

contains

array of string

Required

This array will have all the keys present at root level of 'payload' object

event

object

Required

Show

payload

object

Required

Show

category

object

Required

Category information

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "contains",
5    "event",
6    "payload"
7  ],
8  "properties": {
9    "contains": {
10      "type": "array",
11      "description": "This array will have all the keys present at root level of 'payload' object",
12      "items": {
13        "type": "string"
14      }
15    },
16    "event": {
17      "type": "object",
18      "required": [
19        "category",
20        "created_timestamp",
21        "id",
22        "name",
23        "trace_id",
24        "type",
25        "version"
26      ],
27      "properties": {
28        "category": {
29          "type": "string",
30          "description": "category of the event. If it is at sales channel level or company level"
31        },
32        "created_timestamp": {
33          "type": "integer",
34          "description": "event generation timestamp in epoch milliseconds"
35        },
36        "id": {
37          "type": "string",
38          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
39        },
40        "name": {
41          "type": "string",
42          "description": "Name of the event"
43        },
44        "trace_id": {
45          "type": "array",
46          "description": "internal trace_id for Fynd Platform services",
47          "items": {
48            "type": "string"
49          }
50        },
51        "type": {
52          "type": "string",
53          "description": "Type/Action of the event. e.g. create/update/delete"
54        },
55        "version": {
56          "type": "string",
57          "description": "Version of the event."
58        }
59      }
60    },
61    "payload": {
62      "type": "object",
63      "required": [
64        "category"
65      ],
66      "properties": {
67        "category": {
68          "type": "object",
69          "required": [
70            "name",
71            "level",
72            "departments",
73            "priority",
74            "is_active"
75          ],
76          "properties": {
77            "id": {
78              "type": "string",
79              "description": "ID of the category"
80            },
81            "uid": {
82              "type": "integer",
83              "description": "ID of the category"
84            },
85            "name": {
86              "type": "string",
87              "description": "Name of the category"
88            },
89            "slug": {
90              "type": "string",
91              "description": "Slug for the category"
92            },
93            "level": {
94              "type": "integer",
95              "description": "Level of the category"
96            },
97            "media": {
98              "type": "object",
99              "properties": {
100                "logo": {
101                  "type": "string",
102                  "description": "URL for the category logo image"
103                },
104                "portrait": {
105                  "type": "string",
106                  "description": "URL for the category portrait image"
107                },
108                "landscape": {
109                  "type": "string",
110                  "description": "URL for the category landscape image"
111                }
112              },
113              "description": "Media information for the category."
114            },
115            "tryouts": {
116              "type": "array",
117              "items": {
118                "type": "string"
119              },
120              "description": "List of tryouts for the category"
121            },
122            "priority": {
123              "type": "integer",
124              "description": "Priority of the category"
125            },
126            "synonyms": {
127              "type": "array",
128              "items": {
129                "type": "string"
130              },
131              "description": "List of synonyms for the category"
132            },
133            "hierarchy": {
134              "type": "array",
135              "items": {
136                "type": "object",
137                "properties": {
138                  "l1": {
139                    "type": "object",
140                    "required": [
141                      "uid",
142                      "name"
143                    ],
144                    "properties": {
145                      "uid": {
146                        "type": "integer"
147                      },
148                      "name": {
149                        "type": "string"
150                      },
151                      "slug": {
152                        "type": "string"
153                      }
154                    }
155                  },
156                  "l2": {
157                    "type": "object",
158                    "required": [
159                      "uid",
160                      "name"
161                    ],
162                    "properties": {
163                      "uid": {
164                        "type": "integer"
165                      },
166                      "name": {
167                        "type": "string"
168                      },
169                      "slug": {
170                        "type": "string"
171                      }
172                    }
173                  },
174                  "l3": {
175                    "type": "object",
176                    "required": [
177                      "uid",
178                      "name"
179                    ],
180                    "properties": {
181                      "uid": {
182                        "type": "integer"
183                      },
184                      "name": {
185                        "type": "string"
186                      },
187                      "slug": {
188                        "type": "string"
189                      }
190                    }
191                  },
192                  "is_active": {
193                    "type": "boolean"
194                  },
195                  "department": {
196                    "type": "object",
197                    "required": [
198                      "uid",
199                      "name"
200                    ],
201                    "properties": {
202                      "uid": {
203                        "type": "integer"
204                      },
205                      "name": {
206                        "type": "string"
207                      }
208                    }
209                  }
210                },
211                "additionalProperties": false
212              },
213              "description": "List of hierarchy for the category"
214            },
215            "is_active": {
216              "type": "boolean",
217              "description": "Whether the category is active or not"
218            },
219            "departments": {
220              "type": "array",
221              "items": {
222                "type": "object",
223                "required": [
224                  "uid",
225                  "name"
226                ],
227                "properties": {
228                  "uid": {
229                    "type": "integer"
230                  },
231                  "name": {
232                    "type": "string"
233                  }
234                }
235              },
236              "description": "List of department IDs for the category"
237            },
238            "marketplaces": {
239              "type": "object",
240              "properties": {
241                "ajio": {
242                  "type": "object",
243                  "required": [
244                    "name"
245                  ],
246                  "properties": {
247                    "name": {
248                      "type": "string",
249                      "description": "Name of the category in the Ajio marketplace"
250                    },
251                    "catalog_id": {
252                      "type": "integer",
253                      "description": "ID of the category in the Ajio catalog"
254                    }
255                  },
256                  "description": "Information about the category's presence on Ajio marketplace."
257                },
258                "google": {
259                  "type": "object",
260                  "required": [
261                    "name"
262                  ],
263                  "properties": {
264                    "name": {
265                      "type": "string",
266                      "description": "Name of the category in the Google marketplace"
267                    },
268                    "catalog_id": {
269                      "type": "integer",
270                      "description": "ID of the category in the Google catalog"
271                    }
272                  },
273                  "description": "Information about the category's presence on Google marketplace."
274                },
275                "facebook": {
276                  "type": "object",
277                  "required": [
278                    "name"
279                  ],
280                  "properties": {
281                    "name": {
282                      "type": "string",
283                      "description": "Name of the category in the Facebook marketplace"
284                    },
285                    "catalog_id": {
286                      "type": "integer",
287                      "description": "ID of the category in the Facebook catalog"
288                    }
289                  },
290                  "description": "Information about the category's presence on Facebook marketplace."
291                }
292              },
293              "description": "Marketplace information for the category."
294            },
295            "_id": {
296              "type": "string",
297              "description": "Unique identifier for the Category."
298            }
299          },
300          "description": "Category information"
301        }
302      }
303    }
304  }
305}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "silverbolt.56c086ee-f0ba-11ee-bda3-9ee9e3af0675"
5    ],
6    "name": "category",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712039360510,
10    "id": "lda2lJw1FVVoElFL5hFqDfk+6ZnGhLk4wUsPya4k378=",
11    "category": "global"
12  },
13  "contains": [
14    "category"
15  ],
16  "payload": {
17    "category": {
18      "slug": "Highbay-light",
19      "name": "Highbay Light",
20      "synonyms": [],
21      "departments": [
22        {
23          "uid": 32,
24          "name": "LED Lights"
25        }
26      ],
27      "uid": 3806,
28      "marketplaces": {},
29      "tryouts": [],
30      "hierarchy": [
31        {
32          "l1": {
33            "uid": 3662,
34            "slug": "outdoor-lights",
35            "name": "Outdoor Lights"
36          },
37          "l2": {
38            "uid": 3803,
39            "slug": "Outdoor-lights",
40            "name": "Outdoor Lights"
41          },
42          "l3": {
43            "uid": 3806,
44            "slug": "Highbay-light",
45            "name": "Highbay Light"
46          },
47          "department": {
48            "uid": 32,
49            "name": "LED Lights"
50          },
51          "is_active": true
52        }
53      ],
54      "_id": "660ba5bfaaf55b2bf7b01159",
55      "media": {
56        "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/category/pictures/square-logo/original/AhiOJgz6C-logo.jpeg",
57        "landscape": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/category/pictures/landscape-banner/original/d_u9KFMY9-landscape.jpeg",
58        "portrait": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/category/pictures/portrait-banner/original/-8OfBDfWK-banner.jpeg"
59      },
60      "is_active": true,
61      "level": 3,
62      "priority": 302,
63      "id": "660ba5bfaaf55b2bf7b01159"
64    }
65  }
66}

Category/category/update/v1

this event is triggered when category is updated

Payload

Hide

contains

array of string

Required

This array will have all the keys present at root level of 'payload' object

event

object

Required

Show

payload

object

Required

Show

category

object

Required

Category information

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "contains",
5    "event",
6    "payload"
7  ],
8  "properties": {
9    "contains": {
10      "type": "array",
11      "description": "This array will have all the keys present at root level of 'payload' object",
12      "items": {
13        "type": "string"
14      }
15    },
16    "event": {
17      "type": "object",
18      "required": [
19        "category",
20        "created_timestamp",
21        "id",
22        "name",
23        "trace_id",
24        "type",
25        "version"
26      ],
27      "properties": {
28        "category": {
29          "type": "string",
30          "description": "category of the event. If it is at sales channel level or company level"
31        },
32        "created_timestamp": {
33          "type": "integer",
34          "description": "event generation timestamp in epoch milliseconds"
35        },
36        "id": {
37          "type": "string",
38          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
39        },
40        "name": {
41          "type": "string",
42          "description": "Name of the event"
43        },
44        "trace_id": {
45          "type": "array",
46          "description": "internal trace_id for Fynd Platform services",
47          "items": {
48            "type": "string"
49          }
50        },
51        "type": {
52          "type": "string",
53          "description": "Type/Action of the event. e.g. create/update/delete"
54        },
55        "version": {
56          "type": "string",
57          "description": "Version of the event."
58        }
59      }
60    },
61    "payload": {
62      "type": "object",
63      "required": [
64        "category"
65      ],
66      "properties": {
67        "category": {
68          "type": "object",
69          "required": [
70            "name",
71            "level",
72            "departments",
73            "priority",
74            "is_active"
75          ],
76          "properties": {
77            "id": {
78              "type": "string",
79              "description": "ID of the category"
80            },
81            "uid": {
82              "type": "integer",
83              "description": "ID of the category"
84            },
85            "name": {
86              "type": "string",
87              "description": "Name of the category"
88            },
89            "slug": {
90              "type": "string",
91              "description": "Slug for the category"
92            },
93            "level": {
94              "type": "integer",
95              "description": "Level of the category"
96            },
97            "media": {
98              "type": "object",
99              "properties": {
100                "logo": {
101                  "type": "string",
102                  "description": "URL for the category logo image"
103                },
104                "portrait": {
105                  "type": "string",
106                  "description": "URL for the category portrait image"
107                },
108                "landscape": {
109                  "type": "string",
110                  "description": "URL for the category landscape image"
111                }
112              },
113              "description": "Media information for the category."
114            },
115            "tryouts": {
116              "type": "array",
117              "items": {
118                "type": "string"
119              },
120              "description": "List of tryouts for the category"
121            },
122            "priority": {
123              "type": "integer",
124              "description": "Priority of the category"
125            },
126            "synonyms": {
127              "type": "array",
128              "items": {
129                "type": "string"
130              },
131              "description": "List of synonyms for the category"
132            },
133            "hierarchy": {
134              "type": "array",
135              "items": {
136                "type": "object",
137                "properties": {
138                  "l1": {
139                    "type": "object",
140                    "required": [
141                      "uid",
142                      "name"
143                    ],
144                    "properties": {
145                      "uid": {
146                        "type": "integer"
147                      },
148                      "name": {
149                        "type": "string"
150                      },
151                      "slug": {
152                        "type": "string"
153                      }
154                    }
155                  },
156                  "l2": {
157                    "type": "object",
158                    "required": [
159                      "uid",
160                      "name"
161                    ],
162                    "properties": {
163                      "uid": {
164                        "type": "integer"
165                      },
166                      "name": {
167                        "type": "string"
168                      },
169                      "slug": {
170                        "type": "string"
171                      }
172                    }
173                  },
174                  "l3": {
175                    "type": "object",
176                    "required": [
177                      "uid",
178                      "name"
179                    ],
180                    "properties": {
181                      "uid": {
182                        "type": "integer"
183                      },
184                      "name": {
185                        "type": "string"
186                      },
187                      "slug": {
188                        "type": "string"
189                      }
190                    }
191                  },
192                  "is_active": {
193                    "type": "boolean"
194                  },
195                  "department": {
196                    "type": "object",
197                    "required": [
198                      "uid",
199                      "name"
200                    ],
201                    "properties": {
202                      "uid": {
203                        "type": "integer"
204                      },
205                      "name": {
206                        "type": "string"
207                      }
208                    }
209                  }
210                },
211                "additionalProperties": false
212              },
213              "description": "List of hierarchy for the category"
214            },
215            "is_active": {
216              "type": "boolean",
217              "description": "Whether the category is active or not"
218            },
219            "departments": {
220              "type": "array",
221              "items": {
222                "type": "object",
223                "required": [
224                  "uid",
225                  "name"
226                ],
227                "properties": {
228                  "uid": {
229                    "type": "integer"
230                  },
231                  "name": {
232                    "type": "string"
233                  }
234                }
235              },
236              "description": "List of department IDs for the category"
237            },
238            "marketplaces": {
239              "type": "object",
240              "properties": {
241                "ajio": {
242                  "type": "object",
243                  "required": [
244                    "name"
245                  ],
246                  "properties": {
247                    "name": {
248                      "type": "string",
249                      "description": "Name of the category in the Ajio marketplace"
250                    },
251                    "catalog_id": {
252                      "type": "integer",
253                      "description": "ID of the category in the Ajio catalog"
254                    }
255                  },
256                  "description": "Information about the category's presence on Ajio marketplace."
257                },
258                "google": {
259                  "type": "object",
260                  "required": [
261                    "name"
262                  ],
263                  "properties": {
264                    "name": {
265                      "type": "string",
266                      "description": "Name of the category in the Google marketplace"
267                    },
268                    "catalog_id": {
269                      "type": "integer",
270                      "description": "ID of the category in the Google catalog"
271                    }
272                  },
273                  "description": "Information about the category's presence on Google marketplace."
274                },
275                "facebook": {
276                  "type": "object",
277                  "required": [
278                    "name"
279                  ],
280                  "properties": {
281                    "name": {
282                      "type": "string",
283                      "description": "Name of the category in the Facebook marketplace"
284                    },
285                    "catalog_id": {
286                      "type": "integer",
287                      "description": "ID of the category in the Facebook catalog"
288                    }
289                  },
290                  "description": "Information about the category's presence on Facebook marketplace."
291                }
292              },
293              "description": "Marketplace information for the category."
294            },
295            "_id": {
296              "type": "string",
297              "description": "Unique identifier for the Category."
298            }
299          },
300          "description": "Category information"
301        }
302      }
303    }
304  }
305}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3cb34634-f0b4-11ee-bda3-9ee9e3af0675"
5    ],
6    "name": "category",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712036739822,
10    "id": "GhKrmn6vdniy/JYeXsUCWJiv67lXW0Y0CEKIbz8OZAY=",
11    "category": "global"
12  },
13  "contains": [
14    "category"
15  ],
16  "payload": {
17    "category": {
18      "is_active": true,
19      "name": "Cylinder Surface",
20      "tryouts": [],
21      "synonyms": [],
22      "media": {
23        "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/category/pictures/square-logo/original/bAyGPaLO3-logo.png",
24        "portrait": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/category/pictures/square-logo/original/bAyGPaLO3-logo.png",
25        "landscape": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/category/pictures/square-logo/original/bAyGPaLO3-logo.png"
26      },
27      "priority": 260,
28      "level": 3,
29      "departments": [
30        {
31          "uid": 32,
32          "name": "LED Lights"
33        }
34      ],
35      "marketplaces": {},
36      "hierarchy": [
37        {
38          "l1": {
39            "uid": 3660,
40            "slug": "indoor-lights",
41            "name": "Indoor Lights"
42          },
43          "l2": {
44            "uid": 3705,
45            "slug": "cob-light",
46            "name": "COB Light"
47          },
48          "l3": {
49            "uid": 3745,
50            "slug": "Cylinder--Surface",
51            "name": "Cylinder Surface"
52          },
53          "department": {
54            "uid": 32,
55            "name": "LED Lights"
56          },
57          "is_active": true
58        }
59      ],
60      "slug": "Cylinder--Surface",
61      "uid": 3745
62    }
63  }
64}

« zone/create/v1

department/create/v1 »