Company
Events categorised under company level will be triggered when any action performed on company. e.g. If new brand is created.
Events
company/company/create/v2
# this event is triggered when company is created
company/company/update/v2
# this event is triggered when company is updated
company/company/delete/v2
# this event is triggered when company is deleted
Payload
Properties
company_id
integer
Required
company ID 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
company
object
Required
Properties
uid
integer
The user ID associated with the company
mode
string
The mode of the company
Enum
name
string
Required
The name of the company
stage
string
The stage of the company
Enum
taxes
array of object
The list of taxes associated with the company.
Array of Properties
rate
number
The GST tax rate value added at company level.
enable
boolean
A boolean value indicating whether the rate is enabled or not.
effective_date
string
The effective date of the rate.
domain
string
The domain associated with the company added during onboard for application creation.
warnings
object
The warnings associated with the company ( can contain any key value pair )
addresses
array of object
The list of addresses associated with the company.
Array of Properties
city
string
Required
The city of the address.
state
string
Required
The state of the address.
country
string
Required
The country of the address.
pincode
string
Required
The pincode of the address.
address1
string
Required
The first line of the address.
address2
string
The second line of the address.
landmark
string
The landmark near the address.
latitude
number
Required
The latitude of the address.
longitude
number
Required
The longitude of the address.
address_type
string
The type of address.
Enum
country_code
string
The ISO 3166-1 alpha-2 country code of the country where the business operates.
created_on
string
The date and time when the company was created
modified_on
string
The date and time when the company was last modified
documents
array of object
The list of documents associated with the company
Array of Properties
url
string
The URL of the document.
type
string
Required
The type of the document.
value
string
Required
The value of the document.
verified
boolean
Indicates whether the document is verified.
legal_name
string
The legal name associated with the document.
verified_by
object
The user who verified the brand.
Properties
user_id
string
Required
User ID of the user who verified the company
verified_on
string
The date and time when the company was verified
_custom_json
object
Custom JSON data associated with the company
company_type
string
The type of the company
Enum
marketplaces
array of string
The list of marketplaces associated with the company
business_info
string
The business information of the company
business_type
string
The business type of the company
Enum
referral_info
object
The referral information associated with the company
Properties
referral_code
string
Referral code for the user
reject_reason
string
The reason why the company was rejected
contact_details
object
The contact details associated with the company
Properties
phone
array of object
List of phone numbers.
Array of Properties
number
string
Required
The phone number for contact person.
country_code
integer
Required
The country code for the contact person.
emails
array of string
List of email addresses.
business_details
object
Additional business details
Properties
website
object
Required
Details about the website of the business.
Properties
url
string
The URL of the website.
franchise_enabled
boolean
Whether the company is a franchise
notification_emails
array of string
The list of email addresses for notifications
business_country_info
object
The country and country code of the company
Properties
country
string
The name of the country where the business operates
country_code
string
The ISO 3166-1 alpha-2 country code of the country where the business operates
Payload Schema JSON
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 "company"70 ],71 "properties": {72 "company": {73 "type": "object",74 "required": [75 "name"76 ],77 "properties": {78 "uid": {79 "type": "integer",80 "description": "The user ID associated with the company"81 },82 "mode": {83 "type": "string",84 "enum": [85 "live",86 "development"87 ],88 "description": "The mode of the company"89 },90 "name": {91 "type": "string",92 "description": "The name of the company"93 },94 "stage": {95 "type": "string",96 "description": "The stage of the company",97 "enum": [98 "verified",99 "complete"100 ]101 },102 "taxes": {103 "type": "array",104 "items": {105 "type": "object",106 "required": [],107 "properties": {108 "rate": {109 "type": "number",110 "description": "The GST tax rate value added at company level."111 },112 "enable": {113 "type": "boolean",114 "description": "A boolean value indicating whether the rate is enabled or not."115 },116 "effective_date": {117 "type": "string",118 "description": "The effective date of the rate."119 }120 }121 },122 "description": "The list of taxes associated with the company."123 },124 "domain": {125 "type": "string",126 "description": "The domain associated with the company added during onboard for application creation."127 },128 "warnings": {129 "type": "object",130 "description": "The warnings associated with the company ( can contain any key value pair )",131 "example": "{company: Company not verified!}"132 },133 "addresses": {134 "type": "array",135 "items": {136 "type": "object",137 "required": [138 "country",139 "state",140 "city",141 "pincode",142 "address1",143 "latitude",144 "longitude"145 ],146 "properties": {147 "city": {148 "type": "string",149 "description": "The city of the address."150 },151 "state": {152 "type": "string",153 "description": "The state of the address."154 },155 "country": {156 "type": "string",157 "description": "The country of the address."158 },159 "pincode": {160 "type": "string",161 "description": "The pincode of the address."162 },163 "address1": {164 "type": "string",165 "description": "The first line of the address."166 },167 "address2": {168 "type": "string",169 "description": "The second line of the address."170 },171 "landmark": {172 "type": "string",173 "description": "The landmark near the address."174 },175 "latitude": {176 "type": "number",177 "description": "The latitude of the address."178 },179 "longitude": {180 "type": "number",181 "description": "The longitude of the address."182 },183 "address_type": {184 "type": "string",185 "description": "The type of address.",186 "enum": [187 "office",188 "registered"189 ]190 },191 "country_code": {192 "type": "string",193 "description": "The ISO 3166-1 alpha-2 country code of the country where the business operates."194 }195 }196 },197 "description": "The list of addresses associated with the company."198 },199 "created_on": {200 "type": "string",201 "description": "The date and time when the company was created"202 },203 "modified_on": {204 "type": "string",205 "description": "The date and time when the company was last modified"206 },207 "documents": {208 "type": "array",209 "items": {210 "type": "object",211 "required": [212 "type",213 "value"214 ],215 "properties": {216 "url": {217 "type": "string",218 "description": "The URL of the document."219 },220 "type": {221 "type": "string",222 "description": "The type of the document."223 },224 "value": {225 "type": "string",226 "description": "The value of the document."227 },228 "verified": {229 "type": "boolean",230 "description": "Indicates whether the document is verified."231 },232 "legal_name": {233 "type": "string",234 "description": "The legal name associated with the document."235 }236 }237 },238 "description": "The list of documents associated with the company"239 },240 "verified_by": {241 "type": "object",242 "required": [243 "user_id"244 ],245 "properties": {246 "user_id": {247 "type": "string",248 "description": "User ID of the user who verified the company"249 }250 },251 "description": "The user who verified the brand."252 },253 "verified_on": {254 "type": "string",255 "description": "The date and time when the company was verified"256 },257 "_custom_json": {258 "type": "object",259 "description": "Custom JSON data associated with the company"260 },261 "company_type": {262 "type": "string",263 "description": "The type of the company",264 "enum": [265 "distributor",266 "franchise",267 "mbo",268 "manufacturer-owner"269 ]270 },271 "marketplaces": {272 "type": "array",273 "items": {274 "type": "string"275 },276 "description": "The list of marketplaces associated with the company",277 "example": [278 "flipkart",279 "ajio"280 ]281 },282 "business_info": {283 "type": "string",284 "description": "The business information of the company"285 },286 "business_type": {287 "type": "string",288 "description": "The business type of the company",289 "enum": [290 "Private",291 "LLP-Partnership",292 "HUF-Proprietorship"293 ]294 },295 "referral_info": {296 "type": "object",297 "required": [],298 "properties": {299 "referral_code": {300 "type": "string",301 "description": "Referral code for the user"302 }303 },304 "description": "The referral information associated with the company"305 },306 "reject_reason": {307 "type": "string",308 "description": "The reason why the company was rejected"309 },310 "contact_details": {311 "type": "object",312 "required": [],313 "properties": {314 "phone": {315 "type": "array",316 "items": {317 "type": "object",318 "required": [319 "number",320 "country_code"321 ],322 "properties": {323 "number": {324 "type": "string",325 "description": "The phone number for contact person."326 },327 "country_code": {328 "type": "integer",329 "description": "The country code for the contact person."330 }331 }332 },333 "description": "List of phone numbers."334 },335 "emails": {336 "type": "array",337 "items": {338 "type": "string"339 },340 "description": "List of email addresses."341 }342 },343 "description": "The contact details associated with the company"344 },345 "business_details": {346 "type": "object",347 "required": [348 "website"349 ],350 "properties": {351 "website": {352 "type": "object",353 "required": [],354 "properties": {355 "url": {356 "type": "string",357 "description": "The URL of the website."358 }359 },360 "description": "Details about the website of the business."361 }362 },363 "description": "Additional business details"364 },365 "franchise_enabled": {366 "type": "boolean",367 "description": "Whether the company is a franchise"368 },369 "notification_emails": {370 "type": "array",371 "items": {372 "type": "string"373 },374 "description": "The list of email addresses for notifications"375 },376 "business_country_info": {377 "type": "object",378 "required": [],379 "properties": {380 "country": {381 "type": "string",382 "description": "The name of the country where the business operates"383 },384 "country_code": {385 "type": "string",386 "description": "The ISO 3166-1 alpha-2 country code of the country where the business operates"387 }388 },389 "description": "The country and country code of the company"390 }391 },392 "description": ""393 }394 }395 }396 }397}
Payload Example
1{2 "event": {3 "trace_id": [4 "WheelJack.797f1d88-f1a7-11ee-b6ea-debb6fb35f76"5 ],6 "name": "company",7 "type": "create",8 "version": "2",9 "created_timestamp": 1712141209527,10 "id": "xPc6LLIyH5FO3grgqrPAb4+AL+chQf4/yToehgQR9FE=",11 "category": "company"12 },13 "company_id": 7186,14 "contains": [15 "company"16 ],17 "payload": {18 "company": {19 "uid": 7186,20 "name": "TALKING SOX PRIVATE LIMITED",21 "addresses": [22 {23 "country": "INDIA",24 "state": "DELHI",25 "city": "EAST DELHI",26 "pincode": 110096,27 "address1": "dummy address",28 "latitude": 19.0653252,29 "longitude": 72.8423802,30 "country_code": "IN",31 "address_type": "office"32 },33 {34 "country": "INDIA",35 "state": "DELHI",36 "city": "EAST DELHI",37 "pincode": 110096,38 "address1": "dummy address",39 "latitude": 19.0653252,40 "longitude": 72.8423802,41 "country_code": "IN",42 "address_type": "registered"43 }44 ],45 "company_type": "mbo",46 "stage": "complete",47 "notification_emails": [48 "test@example.com"49 ],50 "documents": [51 {52 "type": "pan",53 "value": "xxxxxx",54 "verified": true55 }56 ],57 "business_country_info": {58 "country": "India",59 "country_code": "IN",60 "currency": {61 "code": "INR",62 "symbol": "₹",63 "name": "Indian Rupee"64 },65 "timezone": "Asia/Kolkata"66 },67 "franchise_enabled": false,68 "warnings": {},69 "marketplaces": [70 "Ajio"71 ],72 "mode": "live"73 }74 }75}
Payload
Properties
company_id
integer
Required
company ID 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
company
object
Required
Company for which the event is triggered
Properties
uid
integer
Required
The user ID associated with the company
mode
Undefined Type
The mode of the company
Enum
name
string
The name of the company
stage
string
Required
The stage of the company
Enum
taxes
array of object
The list of taxes associated with the company.
Array of Properties
rate
number
The GST tax rate value added at company level.
enable
boolean
A boolean value indicating whether the rate is enabled or not.
effective_date
string
The effective date of the rate.
domain
string
The domain associated with the company added during onboard for application creation.
warnings
object
The warnings associated with the company ( can contain any key value pair )
addresses
array of object
The list of addresses associated with the company.
Array of Properties
city
string
Required
The city of the address.
state
string
Required
The state of the address.
country
string
Required
The country of the address.
pincode
string
Required
The pincode of the address.
address1
string
Required
The first line of the address.
address2
string
The second line of the address.
landmark
string
The landmark near the address.
latitude
number
Required
The latitude of the address.
longitude
number
Required
The longitude of the address.
address_type
string
The type of address.
Enum
country_code
string
The country code of the address.
created_on
string
The date and time when the company was created
modified_on
string
The date and time when the company was last modified
documents
array of object
The list of documents associated with the company
Array of Properties
url
string
The URL of the document.
type
string
Required
The type of the document.
value
string
Required
The value of the document.
verified
boolean
Indicates whether the document is verified.
legal_name
string
The legal name associated with the document.
verified_by
object
The user who verified the brand.
Properties
user_id
string
Required
User ID of the user who verified the company
verified_on
string
The date and time when the company was verified
_custom_json
object
Custom JSON data associated with the company
company_type
string
The type of the company
Enum
marketplaces
array of string
The list of marketplaces associated with the company
business_info
string
The business information of the company
business_type
string
The business type of the company
Enum
referral_info
object
The referral information associated with the company
Properties
referral_code
string
Referral code for the user
reject_reason
string
The reason why the company was rejected
contact_details
object
The contact details associated with the company
Properties
phone
array of object
List of phone numbers.
Array of Properties
number
string
Required
country_code
integer
Required
emails
array of string
List of email addresses.
business_details
object
Additional business details
Properties
website
object
Required
Details about the website of the business.
Properties
url
string
The URL of the website.
franchise_enabled
boolean
Whether the company is a franchise
notification_emails
array of string
The list of email addresses for notifications
business_country_info
object
The country and country code of the company
Properties
country
string
The name of the country where the business operates
country_code
string
The ISO 3166-1 alpha-2 country code of the country where the business operates
Payload Schema JSON
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 "company"70 ],71 "properties": {72 "company": {73 "type": "object",74 "required": [75 "uid",76 "stage"77 ],78 "properties": {79 "uid": {80 "type": "integer",81 "description": "The user ID associated with the company"82 },83 "mode": {84 "enum": [85 "live",86 "development"87 ],88 "description": "The mode of the company"89 },90 "name": {91 "type": "string",92 "description": "The name of the company"93 },94 "stage": {95 "type": "string",96 "description": "The stage of the company",97 "enum": [98 "verified",99 "complete"100 ]101 },102 "taxes": {103 "type": "array",104 "items": {105 "type": "object",106 "required": [],107 "properties": {108 "rate": {109 "type": "number",110 "description": "The GST tax rate value added at company level."111 },112 "enable": {113 "type": "boolean",114 "description": "A boolean value indicating whether the rate is enabled or not."115 },116 "effective_date": {117 "type": "string",118 "description": "The effective date of the rate."119 }120 }121 },122 "description": "The list of taxes associated with the company."123 },124 "domain": {125 "type": "string",126 "description": "The domain associated with the company added during onboard for application creation."127 },128 "warnings": {129 "type": "object",130 "description": "The warnings associated with the company ( can contain any key value pair )",131 "example": "{company: Company not verified!}"132 },133 "addresses": {134 "type": "array",135 "items": {136 "type": "object",137 "required": [138 "country",139 "state",140 "city",141 "pincode",142 "address1",143 "latitude",144 "longitude"145 ],146 "properties": {147 "city": {148 "type": "string",149 "description": "The city of the address."150 },151 "state": {152 "type": "string",153 "description": "The state of the address."154 },155 "country": {156 "type": "string",157 "description": "The country of the address."158 },159 "pincode": {160 "type": "string",161 "description": "The pincode of the address."162 },163 "address1": {164 "type": "string",165 "description": "The first line of the address."166 },167 "address2": {168 "type": "string",169 "description": "The second line of the address."170 },171 "landmark": {172 "type": "string",173 "description": "The landmark near the address."174 },175 "latitude": {176 "type": "number",177 "description": "The latitude of the address."178 },179 "longitude": {180 "type": "number",181 "description": "The longitude of the address."182 },183 "address_type": {184 "type": "string",185 "description": "The type of address.",186 "enum": [187 "office",188 "registered"189 ]190 },191 "country_code": {192 "type": "string",193 "description": "The country code of the address."194 }195 }196 },197 "description": "The list of addresses associated with the company."198 },199 "created_on": {200 "type": "string",201 "description": "The date and time when the company was created"202 },203 "modified_on": {204 "type": "string",205 "description": "The date and time when the company was last modified"206 },207 "documents": {208 "type": "array",209 "items": {210 "type": "object",211 "required": [212 "type",213 "value"214 ],215 "properties": {216 "url": {217 "type": "string",218 "description": "The URL of the document."219 },220 "type": {221 "type": "string",222 "description": "The type of the document."223 },224 "value": {225 "type": "string",226 "description": "The value of the document."227 },228 "verified": {229 "type": "boolean",230 "description": "Indicates whether the document is verified."231 },232 "legal_name": {233 "type": "string",234 "description": "The legal name associated with the document."235 }236 }237 },238 "description": "The list of documents associated with the company"239 },240 "verified_by": {241 "type": "object",242 "required": [243 "user_id"244 ],245 "properties": {246 "user_id": {247 "type": "string",248 "description": "User ID of the user who verified the company"249 }250 },251 "description": "The user who verified the brand."252 },253 "verified_on": {254 "type": "string",255 "description": "The date and time when the company was verified"256 },257 "_custom_json": {258 "type": "object",259 "description": "Custom JSON data associated with the company"260 },261 "company_type": {262 "type": "string",263 "description": "The type of the company",264 "enum": [265 "distributor",266 "franchise",267 "mbo",268 "manufacturer-owner"269 ]270 },271 "marketplaces": {272 "type": "array",273 "items": {274 "type": "string"275 },276 "description": "The list of marketplaces associated with the company"277 },278 "business_info": {279 "type": "string",280 "description": "The business information of the company"281 },282 "business_type": {283 "type": "string",284 "description": "The business type of the company",285 "enum": [286 "Private",287 "LLP-Partnership",288 "HUF-Proprietorship"289 ]290 },291 "referral_info": {292 "type": "object",293 "required": [],294 "properties": {295 "referral_code": {296 "type": "string",297 "description": "Referral code for the user"298 }299 },300 "description": "The referral information associated with the company"301 },302 "reject_reason": {303 "type": "string",304 "description": "The reason why the company was rejected"305 },306 "contact_details": {307 "type": "object",308 "required": [],309 "properties": {310 "phone": {311 "type": "array",312 "items": {313 "type": "object",314 "required": [315 "number",316 "country_code"317 ],318 "properties": {319 "number": {320 "type": "string"321 },322 "country_code": {323 "type": "integer"324 }325 }326 },327 "description": "List of phone numbers."328 },329 "emails": {330 "type": "array",331 "items": {332 "type": "string"333 },334 "description": "List of email addresses."335 }336 },337 "description": "The contact details associated with the company"338 },339 "business_details": {340 "type": "object",341 "required": [342 "website"343 ],344 "properties": {345 "website": {346 "type": "object",347 "required": [],348 "properties": {349 "url": {350 "type": "string",351 "description": "The URL of the website."352 }353 },354 "description": "Details about the website of the business."355 }356 },357 "description": "Additional business details"358 },359 "franchise_enabled": {360 "type": "boolean",361 "description": "Whether the company is a franchise"362 },363 "notification_emails": {364 "type": "array",365 "items": {366 "type": "string"367 },368 "description": "The list of email addresses for notifications"369 },370 "business_country_info": {371 "type": "object",372 "required": [],373 "properties": {374 "country": {375 "type": "string",376 "description": "The name of the country where the business operates"377 },378 "country_code": {379 "type": "string",380 "description": "The ISO 3166-1 alpha-2 country code of the country where the business operates"381 }382 },383 "description": "The country and country code of the company"384 }385 },386 "description": "Company for which the event is triggered"387 }388 }389 }390 }391}
Payload Example
1{2 "event": {3 "trace_id": [4 "WheelJack.7a9e835c-f1a7-11ee-bfd0-8e34926824aa"5 ],6 "name": "company",7 "type": "update",8 "version": "2",9 "created_timestamp": 1712141211410,10 "id": "/xQ2OXxIcI7BEDB6N2Pg0RAxuB5JQXSNn9V/FpsPju4=",11 "category": "company"12 },13 "company_id": 7186,14 "contains": [15 "company"16 ],17 "payload": {18 "company": {19 "verified_on": "2024-04-03T10:46:50.756214",20 "verified_by": {21 "user_id": "0"22 },23 "uid": 7186,24 "name": "TALKING SOX PRIVATE LIMITED",25 "addresses": [26 {27 "country": "INDIA",28 "state": "DELHI",29 "city": "EAST DELHI",30 "pincode": 110096,31 "address1": "dummy address",32 "latitude": 19.0653252,33 "longitude": 72.8423802,34 "country_code": "IN",35 "address_type": "office"36 },37 {38 "country": "INDIA",39 "state": "DELHI",40 "city": "EAST DELHI",41 "pincode": 110096,42 "address1": "dummy address",43 "latitude": 19.0653252,44 "longitude": 72.8423802,45 "country_code": "IN",46 "address_type": "registered"47 }48 ],49 "company_type": "mbo",50 "stage": "verified",51 "notification_emails": [52 "test@example.com"53 ],54 "documents": [55 {56 "type": "pan",57 "value": "XXXXXXXX",58 "verified": true59 }60 ],61 "business_country_info": {62 "country": "India",63 "country_code": "IN",64 "currency": {65 "code": "INR",66 "symbol": "₹",67 "name": "Indian Rupee"68 },69 "timezone": "Asia/Kolkata"70 },71 "franchise_enabled": false,72 "warnings": {},73 "marketplaces": [74 "Ajio"75 ],76 "mode": "live"77 }78 }79}
Payload
Properties
company_id
integer
Required
company ID 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
company
object
Required
Company for which the event is triggered
Properties
uid
integer
Required
The user ID associated with the company
mode
Undefined Type
The mode of the company
Enum
name
string
The name of the company
stage
string
Required
The stage of the company
Enum
taxes
array of object
The list of taxes associated with the company.
Array of Properties
rate
number
The GST tax rate value added at company level.
enable
boolean
A boolean value indicating whether the rate is enabled or not.
effective_date
string
The effective date of the rate.
domain
string
The domain associated with the company added during onboard for application creation.
warnings
object
The warnings associated with the company ( can contain any key value pair )
addresses
array of object
The list of addresses associated with the company.
Array of Properties
city
string
Required
The city of the address.
state
string
Required
The state of the address.
country
string
Required
The country of the address.
pincode
string
Required
The pincode of the address.
address1
string
Required
The first line of the address.
address2
string
The second line of the address.
landmark
string
The landmark near the address.
latitude
number
Required
The latitude of the address.
longitude
number
Required
The longitude of the address.
address_type
string
The type of address.
Enum
country_code
string
The country code of the address.
created_on
string
The date and time when the company was created
modified_on
string
The date and time when the company was last modified
documents
array of object
The list of documents associated with the company
Array of Properties
url
string
The URL of the document.
type
string
Required
The type of the document.
value
string
Required
The value of the document.
verified
boolean
Indicates whether the document is verified.
legal_name
string
The legal name associated with the document.
verified_by
object
The user who verified the brand.
Properties
user_id
string
Required
User ID of the user who verified the company
verified_on
string
The date and time when the company was verified
_custom_json
object
Custom JSON data associated with the company
company_type
string
The type of the company
Enum
marketplaces
array of string
The list of marketplaces associated with the company
business_info
string
The business information of the company
business_type
string
The business type of the company
Enum
referral_info
object
The referral information associated with the company
Properties
referral_code
string
Referral code for the user
reject_reason
string
The reason why the company was rejected
contact_details
object
The contact details associated with the company
Properties
phone
array of object
List of phone numbers.
Array of Properties
number
string
Required
country_code
integer
Required
emails
array of string
List of email addresses.
business_details
object
Additional business details
Properties
website
object
Required
Details about the website of the business.
Properties
url
string
The URL of the website.
franchise_enabled
boolean
Whether the company is a franchise
notification_emails
array of string
The list of email addresses for notifications
business_country_info
object
The country and country code of the company
Properties
country
string
The name of the country where the business operates
country_code
string
The ISO 3166-1 alpha-2 country code of the country where the business operates
Payload Schema JSON
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 "company"70 ],71 "properties": {72 "company": {73 "type": "object",74 "required": [75 "uid",76 "stage"77 ],78 "properties": {79 "uid": {80 "type": "integer",81 "description": "The user ID associated with the company"82 },83 "mode": {84 "enum": [85 "live",86 "development"87 ],88 "description": "The mode of the company"89 },90 "name": {91 "type": "string",92 "description": "The name of the company"93 },94 "stage": {95 "type": "string",96 "description": "The stage of the company",97 "enum": [98 "scheduled_for_deletion"99 ]100 },101 "taxes": {102 "type": "array",103 "items": {104 "type": "object",105 "required": [],106 "properties": {107 "rate": {108 "type": "number",109 "description": "The GST tax rate value added at company level."110 },111 "enable": {112 "type": "boolean",113 "description": "A boolean value indicating whether the rate is enabled or not."114 },115 "effective_date": {116 "type": "string",117 "description": "The effective date of the rate."118 }119 }120 },121 "description": "The list of taxes associated with the company."122 },123 "domain": {124 "type": "string",125 "description": "The domain associated with the company added during onboard for application creation."126 },127 "warnings": {128 "type": "object",129 "description": "The warnings associated with the company ( can contain any key value pair )",130 "example": "{company: Company not verified!}"131 },132 "addresses": {133 "type": "array",134 "items": {135 "type": "object",136 "required": [137 "country",138 "state",139 "city",140 "pincode",141 "address1",142 "latitude",143 "longitude"144 ],145 "properties": {146 "city": {147 "type": "string",148 "description": "The city of the address."149 },150 "state": {151 "type": "string",152 "description": "The state of the address."153 },154 "country": {155 "type": "string",156 "description": "The country of the address."157 },158 "pincode": {159 "type": "string",160 "description": "The pincode of the address."161 },162 "address1": {163 "type": "string",164 "description": "The first line of the address."165 },166 "address2": {167 "type": "string",168 "description": "The second line of the address."169 },170 "landmark": {171 "type": "string",172 "description": "The landmark near the address."173 },174 "latitude": {175 "type": "number",176 "description": "The latitude of the address."177 },178 "longitude": {179 "type": "number",180 "description": "The longitude of the address."181 },182 "address_type": {183 "type": "string",184 "description": "The type of address.",185 "enum": [186 "office",187 "registered"188 ]189 },190 "country_code": {191 "type": "string",192 "description": "The country code of the address."193 }194 }195 },196 "description": "The list of addresses associated with the company."197 },198 "created_on": {199 "type": "string",200 "description": "The date and time when the company was created"201 },202 "modified_on": {203 "type": "string",204 "description": "The date and time when the company was last modified"205 },206 "documents": {207 "type": "array",208 "items": {209 "type": "object",210 "required": [211 "type",212 "value"213 ],214 "properties": {215 "url": {216 "type": "string",217 "description": "The URL of the document."218 },219 "type": {220 "type": "string",221 "description": "The type of the document."222 },223 "value": {224 "type": "string",225 "description": "The value of the document."226 },227 "verified": {228 "type": "boolean",229 "description": "Indicates whether the document is verified."230 },231 "legal_name": {232 "type": "string",233 "description": "The legal name associated with the document."234 }235 }236 },237 "description": "The list of documents associated with the company"238 },239 "verified_by": {240 "type": "object",241 "required": [242 "user_id"243 ],244 "properties": {245 "user_id": {246 "type": "string",247 "description": "User ID of the user who verified the company"248 }249 },250 "description": "The user who verified the brand."251 },252 "verified_on": {253 "type": "string",254 "description": "The date and time when the company was verified"255 },256 "_custom_json": {257 "type": "object",258 "description": "Custom JSON data associated with the company"259 },260 "company_type": {261 "type": "string",262 "description": "The type of the company",263 "enum": [264 "distributor",265 "franchise",266 "mbo",267 "manufacturer-owner"268 ]269 },270 "marketplaces": {271 "type": "array",272 "items": {273 "type": "string"274 },275 "description": "The list of marketplaces associated with the company"276 },277 "business_info": {278 "type": "string",279 "description": "The business information of the company"280 },281 "business_type": {282 "type": "string",283 "description": "The business type of the company",284 "enum": [285 "Private",286 "LLP-Partnership",287 "HUF-Proprietorship"288 ]289 },290 "referral_info": {291 "type": "object",292 "required": [],293 "properties": {294 "referral_code": {295 "type": "string",296 "description": "Referral code for the user"297 }298 },299 "description": "The referral information associated with the company"300 },301 "reject_reason": {302 "type": "string",303 "description": "The reason why the company was rejected"304 },305 "contact_details": {306 "type": "object",307 "required": [],308 "properties": {309 "phone": {310 "type": "array",311 "items": {312 "type": "object",313 "required": [314 "number",315 "country_code"316 ],317 "properties": {318 "number": {319 "type": "string"320 },321 "country_code": {322 "type": "integer"323 }324 }325 },326 "description": "List of phone numbers."327 },328 "emails": {329 "type": "array",330 "items": {331 "type": "string"332 },333 "description": "List of email addresses."334 }335 },336 "description": "The contact details associated with the company"337 },338 "business_details": {339 "type": "object",340 "required": [341 "website"342 ],343 "properties": {344 "website": {345 "type": "object",346 "required": [],347 "properties": {348 "url": {349 "type": "string",350 "description": "The URL of the website."351 }352 },353 "description": "Details about the website of the business."354 }355 },356 "description": "Additional business details"357 },358 "franchise_enabled": {359 "type": "boolean",360 "description": "Whether the company is a franchise"361 },362 "notification_emails": {363 "type": "array",364 "items": {365 "type": "string"366 },367 "description": "The list of email addresses for notifications"368 },369 "business_country_info": {370 "type": "object",371 "required": [],372 "properties": {373 "country": {374 "type": "string",375 "description": "The name of the country where the business operates"376 },377 "country_code": {378 "type": "string",379 "description": "The ISO 3166-1 alpha-2 country code of the country where the business operates"380 }381 },382 "description": "The country and country code of the company"383 }384 },385 "description": "Company for which the event is triggered"386 }387 }388 }389 }390}
Payload Example
1{2 "event": {3 "trace_id": [4 "silverbolt.d7f41f8a-5b50-11f0-bbd6-3a769819df2b"5 ],6 "name": "company",7 "type": "delete",8 "version": "2",9 "created_timestamp": 1712141211410,10 "id": "/xQ2OXxIcI7BEDB6N2Pg0RAxuB5JQXSNn9V/FpsPju4=",11 "category": "company"12 },13 "company_id": 7186,14 "contains": [15 "company"16 ],17 "payload": {18 "company": {19 "verified_on": "2024-04-03T10:46:50.756214",20 "verified_by": {21 "user_id": "0"22 },23 "uid": 7186,24 "name": "TALKING SOX PRIVATE LIMITED",25 "addresses": [26 {27 "country": "INDIA",28 "state": "DELHI",29 "city": "EAST DELHI",30 "pincode": 110096,31 "address1": "dummy address",32 "latitude": 19.0653252,33 "longitude": 72.8423802,34 "country_code": "IN",35 "address_type": "office"36 },37 {38 "country": "INDIA",39 "state": "DELHI",40 "city": "EAST DELHI",41 "pincode": 110096,42 "address1": "dummy address",43 "latitude": 19.0653252,44 "longitude": 72.8423802,45 "country_code": "IN",46 "address_type": "registered"47 }48 ],49 "company_type": "mbo",50 "stage": "scheduled_for_deletion",51 "notification_emails": [52 "test@example.com"53 ],54 "documents": [55 {56 "type": "pan",57 "value": "XXXXXXXX",58 "verified": true59 }60 ],61 "business_country_info": {62 "country": "India",63 "country_code": "IN",64 "currency": {65 "code": "INR",66 "symbol": "₹",67 "name": "Indian Rupee"68 },69 "timezone": "Asia/Kolkata"70 },71 "franchise_enabled": false,72 "warnings": {},73 "marketplaces": [74 "Ajio"75 ],76 "mode": "live"77 }78 }79}