Company

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "required": [
69        "brand"
70      ],
71      "properties": {
72        "brand": {
73          "type": "object",
74          "required": [
75            "name",
76            "uid",
77            "company_id",
78            "slug_key",
79            "stage",
80            "logo"
81          ],
82          "properties": {
83            "id": {
84              "type": "string",
85              "description": "The unique ID of the brand."
86            },
87            "uid": {
88              "type": "integer",
89              "description": "The UID of the brand."
90            },
91            "_cls": {
92              "type": "string",
93              "description": "Class information of the brand."
94            },
95            "logo": {
96              "type": "string",
97              "description": "The URL of the brand's logo."
98            },
99            "mode": {
100              "type": "string",
101              "description": "The mode of the brand."
102            },
103            "name": {
104              "type": "string",
105              "description": "The name of the brand."
106            },
107            "stage": {
108              "type": "string",
109              "description": "The stage of the brand."
110            },
111            "banner": {
112              "type": "object",
113              "required": [],
114              "properties": {
115                "portrait": {
116                  "type": "string",
117                  "description": "The URL of the brand's portrait banner."
118                },
119                "landscape": {
120                  "type": "string",
121                  "description": "The URL of the brand's landscape banner."
122                }
123              },
124              "description": "The banner images of the brand."
125            },
126            "slug_key": {
127              "type": "string",
128              "description": "The slug key of the brand."
129            },
130            "synonyms": {
131              "type": "array",
132              "items": {
133                "type": "string"
134              },
135              "description": "A list of synonyms for the brand name."
136            },
137            "warnings": {
138              "type": "object",
139              "description": "A dictionary of warnings related to the brand."
140            },
141            "meta_json": {
142              "type": "object",
143              "properties": {
144                "company_id": {
145                  "type": "integer",
146                  "description": "The ID of the company associated with this meta data."
147                }
148              },
149              "description": "The meta data for the brand."
150            },
151            "company_id": {
152              "type": "integer",
153              "description": "The ID of the company the brand belongs to."
154            },
155            "created_by": {
156              "type": "object",
157              "required": [
158                "user_id"
159              ],
160              "properties": {
161                "user_id": {
162                  "type": "string",
163                  "description": "The unique ID of the user who created the brand."
164                }
165              },
166              "description": "The user who created the brand."
167            },
168            "created_on": {
169              "type": "string",
170              "description": "The date and time when the brand was created."
171            },
172            "description": {
173              "type": "string",
174              "description": "A description of the brand."
175            },
176            "modified_by": {
177              "type": "object",
178              "required": [
179                "user_id"
180              ],
181              "properties": {
182                "user_id": {
183                  "type": "string",
184                  "description": "The unique ID of the user who last modified the brand."
185                }
186              },
187              "description": "The user who last modified the brand."
188            },
189            "modified_on": {
190              "type": "string",
191              "description": "The date and time when the brand was last modified."
192            },
193            "verified_by": {
194              "type": "object",
195              "required": [
196                "user_id"
197              ],
198              "properties": {
199                "user_id": {
200                  "type": "string",
201                  "description": "The unique ID of the user who verified the brand."
202                },
203                "username": {
204                  "type": "string",
205                  "description": "The username of the user who verified the brand."
206                }
207              },
208              "description": "The user who verified the brand."
209            },
210            "verified_on": {
211              "type": "string",
212              "description": "The date and time when the brand was verified."
213            },
214            "_custom_json": {
215              "type": "object",
216              "description": "Custom JSON data for the brand."
217            },
218            "_locale_language": {
219              "type": "object",
220              "description": "The language settings for the brand."
221            }
222          },
223          "description": "Brand details."
224        }
225      }
226    }
227  }
228}

1{
2  "company_id": 61,
3  "contains": [
4    "brand"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1711688290399,
9    "id": "UZKh3R1YKpTUlQx5AL970V72Y2Z2bSwOIATEwLXAu6I=",
10    "name": "brand",
11    "trace_id": [
12      "WheelJack.f0a8c382-ed88-11ee-bea0-620952f5da1a"
13    ],
14    "type": "create",
15    "version": "1"
16  },
17  "payload": {
18    "brand": {
19      "_locale_language": {},
20      "banner": {
21        "landscape": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/landscape-banner/original/Cb_ArFhPE-Landsacpe-Banner.png",
22        "portrait": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/portrait-banner/original/k3ety-h39-Portrait-Banner.png"
23      },
24      "company_id": 61,
25      "description": "",
26      "id": "66064a624ebfdd9d40a91309",
27      "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/square-logo/original/Eg3oiR_bw-Logo.jpeg",
28      "mode": "live",
29      "name": "Mirraw",
30      "slug_key": "mirraw",
31      "stage": "complete",
32      "uid": 7990
33    }
34  }
35}

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "properties": {
69        "brand": {
70          "type": "object",
71          "properties": {
72            "uid": {
73              "type": "integer",
74              "description": "The UID of the brand."
75            },
76            "name": {
77              "type": "string",
78              "description": "The name of the brand."
79            },
80            "stage": {
81              "type": "string",
82              "description": "The stage of the brand."
83            },
84            "logo": {
85              "type": "string",
86              "description": "The URL of the brand's logo."
87            },
88            "banner": {
89              "type": "object",
90              "properties": {
91                "portrait": {
92                  "type": "string",
93                  "description": "The URL of the brand's portrait banner."
94                },
95                "landscape": {
96                  "type": "string",
97                  "description": "The URL of the brand's landscape banner."
98                }
99              },
100              "required": [
101                "portrait",
102                "landscape"
103              ],
104              "description": "The banner images of the brand."
105            },
106            "description": {
107              "type": "string",
108              "description": "A description of the brand."
109            },
110            "_locale_language": {
111              "type": "object",
112              "description": "The language settings for the brand."
113            },
114            "company_id": {
115              "type": "integer",
116              "description": "The ID of the company the brand belongs to."
117            },
118            "id": {
119              "type": "string",
120              "description": "The unique ID of the brand."
121            }
122          },
123          "required": [
124            "uid",
125            "name",
126            "stage",
127            "logo",
128            "banner",
129            "company_id",
130            "id"
131          ],
132          "description": "Brand details."
133        }
134      },
135      "required": [
136        "brand"
137      ]
138    }
139  }
140}

1{
2  "company_id": 61,
3  "contains": [
4    "brand"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1711643753177,
9    "id": "RHL08gMG11SDwyix7lwCN1lMrRCVPbkv72mje0AOrXQ=",
10    "name": "brand",
11    "trace_id": [
12      "WheelJack.3e681ebe-ed21-11ee-aaad-9e29e151ef18"
13    ],
14    "type": "update",
15    "version": "1"
16  },
17  "payload": {
18    "brand": {
19      "_locale_language": {},
20      "banner": {
21        "landscape": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/landscape-banner/original/xS3yYSccB-3Y7m0I3J5-Landsacpe-Banner.jpeg",
22        "portrait": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/portrait-banner/original/kCTYrsIHp-0QOLHIHiT-Portrait-Banner.jpeg"
23      },
24      "company_id": 61,
25      "description": "",
26      "id": "65241a754c42bd82ac09e1bd",
27      "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/square-logo/original/LnJda98-q-juwas-TRj-Logo.png",
28      "name": "DIOR",
29      "stage": "complete",
30      "uid": 7392
31    }
32  }
33}