Company
Events categorised under company level will be triggered when any action performed on company. e.g. If new brand is created.
Events
company/location-price/create/v1
# this event is triggered when location price is created
company/location-price/update/v1
# this event is triggered when location price is updated
company/location-price/delete/v1
# this event is triggered when location price 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
prices
array of object
Required
Array of Properties
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
size
string
Required
Product size (e.g., S, M, L, XL).
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
price
object
Required
Pricing details of the product, including various price types.
Properties
marked
number
Required
Marked price or original listed price of the product.
currency
string
Required
Currency used for the product's pricing (e.g., USD, EUR).
transfer
number
Required
Transfer price of the product.
effective
number
Required
Final price after applying discounts.
cost
number
The original price incurred to produce or acquire a product before any markup.
updated_at
string|null
| date-time
Date and time when the pricing information was last updated.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
item_id
integer
Required
Unique identifier for the item.
date_meta
object
Timestamps for important events in the product's lifecycle.
Properties
created_on
string
| date-time
Date and time when the product was first created.
modified_on
string
| date-time
Required
Last modification timestamp of the product inventory details.
added_on_store
string
| date-time
Date and time when the product was added to the store.
inventory_updated_on
string
| date-time
Last inventory update timestamp.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
stage
string
Current stage of the product lifecycle (e.g., verified).
is_active
boolean
Indicates if the product is currently active (available for sale).
tags
array of string
Tags or labels assigned to the product for categorization or search purposes.
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 "prices"70 ],71 "properties": {72 "prices": {73 "type": "array",74 "items": {75 "type": "object",76 "required": [77 "uid",78 "item_id",79 "fynd_item_code",80 "store",81 "brand",82 "company",83 "size",84 "seller_identifier",85 "price"86 ],87 "properties": {88 "uid": {89 "type": "string",90 "description": "Combination of item code and store ID to uniquely identify the article."91 },92 "size": {93 "type": "string",94 "description": "Product size (e.g., S, M, L, XL)."95 },96 "brand": {97 "type": "object",98 "description": "Details about the product's brand.",99 "properties": {100 "id": {101 "type": "integer",102 "description": "Unique identifier for the brand."103 }104 },105 "required": [106 "id"107 ]108 },109 "price": {110 "type": "object",111 "description": "Pricing details of the product, including various price types.",112 "properties": {113 "marked": {114 "type": "number",115 "description": "Marked price or original listed price of the product."116 },117 "currency": {118 "type": "string",119 "description": "Currency used for the product's pricing (e.g., USD, EUR)."120 },121 "transfer": {122 "type": "number",123 "description": "Transfer price of the product."124 },125 "effective": {126 "type": "number",127 "description": "Final price after applying discounts."128 },129 "cost": {130 "type": "number",131 "description": "The original price incurred to produce or acquire a product before any markup."132 },133 "updated_at": {134 "type": [135 "string",136 "null"137 ],138 "format": "date-time",139 "description": "Date and time when the pricing information was last updated."140 }141 },142 "required": [143 "transfer",144 "effective",145 "marked",146 "currency"147 ]148 },149 "store": {150 "type": "object",151 "description": "Information about the store selling the product.",152 "properties": {153 "id": {154 "type": "integer",155 "description": "Unique identifier for the store."156 }157 },158 "required": [159 "id"160 ]161 },162 "company": {163 "type": "object",164 "description": "Information about the company producing or selling the product.",165 "properties": {166 "id": {167 "type": "integer",168 "description": "Unique identifier for the company."169 }170 },171 "required": [172 "id"173 ]174 },175 "item_id": {176 "type": "integer",177 "description": "Unique identifier for the item."178 },179 "date_meta": {180 "type": "object",181 "description": "Timestamps for important events in the product's lifecycle.",182 "properties": {183 "created_on": {184 "type": "string",185 "format": "date-time",186 "description": "Date and time when the product was first created."187 },188 "modified_on": {189 "type": "string",190 "format": "date-time",191 "description": "Last modification timestamp of the product inventory details."192 },193 "added_on_store": {194 "type": "string",195 "format": "date-time",196 "description": "Date and time when the product was added to the store."197 },198 "inventory_updated_on": {199 "type": "string",200 "format": "date-time",201 "description": "Last inventory update timestamp."202 }203 },204 "required": [205 "modified_on"206 ]207 },208 "fynd_item_code": {209 "type": "string",210 "description": "Fynd's unique internal code for the product."211 },212 "seller_identifier": {213 "type": "string",214 "description": "Unique identifier used by the seller for the product."215 },216 "stage": {217 "type": "string",218 "description": "Current stage of the product lifecycle (e.g., verified)."219 },220 "is_active": {221 "type": "boolean",222 "description": "Indicates if the product is currently active (available for sale)."223 },224 "tags": {225 "type": "array",226 "description": "Tags or labels assigned to the product for categorization or search purposes.",227 "items": {228 "type": "string"229 }230 }231 }232 }233 }234 }235 }236 }237}
Payload Example
1{2 "company_id": 3932,3 "contains": [4 "prices"5 ],6 "event": {7 "category": "company",8 "created_timestamp": 1712213140518,9 "id": "uVxPGUEmbYi7/WCvNFfFY03tJiSTOqP6kgMZOxxmGrI=",10 "name": "location-price",11 "trace_id": [12 "silverbolt.f3b55ffc-f24e-11ee-ad2e-c227286f4511"13 ],14 "type": "create",15 "version": "1"16 },17 "payload": {18 "prices": [19 {20 "brand": {21 "id": 41422 },23 "company": {24 "id": 393225 },26 "date_meta": {27 "added_on_store": "2024-04-04 06:45:40.083507+00:00",28 "created_on": "2024-04-04 06:45:40.072820",29 "inventory_updated_on": "2024-04-04 06:45:40.072820",30 "modified_on": "2024-04-04 06:45:40.072820"31 },32 "fynd_item_code": "MFK-9332-Q-163-LIGHT BLUE",33 "item_id": 8684655,34 "price": {35 "currency": "INR",36 "effective": 2199,37 "marked": 2199,38 "transfer": 039 },40 "seller_identifier": "8905310270582",41 "size": "L",42 "store": {43 "id": 2363044 },45 "uid": "23630_8905310270582",46 "is_active": true,47 "stage": "verified",48 "tags": []49 }50 ]51 }52}
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
prices
array of object
Required
Array of Properties
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
size
string
Required
Product size (e.g., S, M, L, XL).
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
price
object
Required
Pricing details of the product, including various price types.
Properties
marked
number
Required
Marked price or original listed price of the product.
currency
string
Required
Currency used for the product's pricing (e.g., USD, EUR).
transfer
number
Required
Transfer price of the product.
effective
number
Required
Final price after applying discounts.
cost
number
The original price incurred to produce or acquire a product before any markup.
updated_at
string|null
| date-time
Date and time when the pricing information was last updated.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
item_id
integer
Required
Unique identifier for the item.
date_meta
object
Timestamps for important events in the product's lifecycle.
Properties
created_on
string
| date-time
Date and time when the product was first created.
modified_on
string
| date-time
Required
Last modification timestamp of the product inventory details.
added_on_store
string
| date-time
Date and time when the product was added to the store.
inventory_updated_on
string
| date-time
Last inventory update timestamp.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
stage
string
Current stage of the product lifecycle (e.g., verified).
is_active
boolean
Indicates if the product is currently active (available for sale).
tags
array of string
Tags or labels assigned to the product for categorization or search purposes.
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 "prices"70 ],71 "properties": {72 "prices": {73 "type": "array",74 "items": {75 "type": "object",76 "required": [77 "uid",78 "item_id",79 "fynd_item_code",80 "store",81 "brand",82 "company",83 "size",84 "seller_identifier",85 "price"86 ],87 "properties": {88 "uid": {89 "type": "string",90 "description": "Combination of item code and store ID to uniquely identify the article."91 },92 "size": {93 "type": "string",94 "description": "Product size (e.g., S, M, L, XL)."95 },96 "brand": {97 "type": "object",98 "description": "Details about the product's brand.",99 "properties": {100 "id": {101 "type": "integer",102 "description": "Unique identifier for the brand."103 }104 },105 "required": [106 "id"107 ]108 },109 "price": {110 "type": "object",111 "description": "Pricing details of the product, including various price types.",112 "properties": {113 "marked": {114 "type": "number",115 "description": "Marked price or original listed price of the product."116 },117 "currency": {118 "type": "string",119 "description": "Currency used for the product's pricing (e.g., USD, EUR)."120 },121 "transfer": {122 "type": "number",123 "description": "Transfer price of the product."124 },125 "effective": {126 "type": "number",127 "description": "Final price after applying discounts."128 },129 "cost": {130 "type": "number",131 "description": "The original price incurred to produce or acquire a product before any markup."132 },133 "updated_at": {134 "type": [135 "string",136 "null"137 ],138 "format": "date-time",139 "description": "Date and time when the pricing information was last updated."140 }141 },142 "required": [143 "transfer",144 "effective",145 "marked",146 "currency"147 ]148 },149 "store": {150 "type": "object",151 "description": "Information about the store selling the product.",152 "properties": {153 "id": {154 "type": "integer",155 "description": "Unique identifier for the store."156 }157 },158 "required": [159 "id"160 ]161 },162 "company": {163 "type": "object",164 "description": "Information about the company producing or selling the product.",165 "properties": {166 "id": {167 "type": "integer",168 "description": "Unique identifier for the company."169 }170 },171 "required": [172 "id"173 ]174 },175 "item_id": {176 "type": "integer",177 "description": "Unique identifier for the item."178 },179 "date_meta": {180 "type": "object",181 "description": "Timestamps for important events in the product's lifecycle.",182 "properties": {183 "created_on": {184 "type": "string",185 "format": "date-time",186 "description": "Date and time when the product was first created."187 },188 "modified_on": {189 "type": "string",190 "format": "date-time",191 "description": "Last modification timestamp of the product inventory details."192 },193 "added_on_store": {194 "type": "string",195 "format": "date-time",196 "description": "Date and time when the product was added to the store."197 },198 "inventory_updated_on": {199 "type": "string",200 "format": "date-time",201 "description": "Last inventory update timestamp."202 }203 },204 "required": [205 "modified_on"206 ]207 },208 "fynd_item_code": {209 "type": "string",210 "description": "Fynd's unique internal code for the product."211 },212 "seller_identifier": {213 "type": "string",214 "description": "Unique identifier used by the seller for the product."215 },216 "stage": {217 "type": "string",218 "description": "Current stage of the product lifecycle (e.g., verified)."219 },220 "is_active": {221 "type": "boolean",222 "description": "Indicates if the product is currently active (available for sale)."223 },224 "tags": {225 "type": "array",226 "description": "Tags or labels assigned to the product for categorization or search purposes.",227 "items": {228 "type": "string"229 }230 }231 }232 }233 }234 }235 }236 }237}
Payload Example
1{2 "company_id": 3932,3 "contains": [4 "prices"5 ],6 "event": {7 "category": "company",8 "created_timestamp": 1712213140518,9 "id": "uVxPGUEmbYi7/WCvNFfFY03tJiSTOqP6kgMZOxxmGrI=",10 "name": "location-price",11 "trace_id": [12 "silverbolt.f3b55ffc-f24e-11ee-ad2e-c227286f4511"13 ],14 "type": "update",15 "version": "1"16 },17 "payload": {18 "prices": [19 {20 "brand": {21 "id": 41422 },23 "company": {24 "id": 393225 },26 "date_meta": {27 "added_on_store": "2024-04-04 06:45:40.083507+00:00",28 "created_on": "2024-04-04 06:45:40.072820",29 "inventory_updated_on": "2024-04-04 06:45:40.072820",30 "modified_on": "2024-04-04 06:45:40.072820"31 },32 "fynd_item_code": "MFK-9332-Q-163-LIGHT BLUE",33 "item_id": 8684655,34 "price": {35 "currency": "INR",36 "effective": 2199,37 "marked": 2199,38 "transfer": 039 },40 "seller_identifier": "8905310270582",41 "size": "L",42 "store": {43 "id": 2363044 },45 "uid": "23630_8905310270582",46 "is_active": true,47 "stage": "verified",48 "tags": []49 }50 ]51 }52}
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
prices
array of object
Required
Array of Properties
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
size
string
Required
Product size (e.g., S, M, L, XL).
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
item_id
integer
Required
Unique identifier for the item.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
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 "prices"70 ],71 "properties": {72 "prices": {73 "type": "array",74 "items": {75 "type": "object",76 "required": [77 "uid",78 "item_id",79 "fynd_item_code",80 "store",81 "brand",82 "company",83 "size",84 "seller_identifier"85 ],86 "properties": {87 "uid": {88 "type": "string",89 "description": "Combination of item code and store ID to uniquely identify the article."90 },91 "size": {92 "type": "string",93 "description": "Product size (e.g., S, M, L, XL)."94 },95 "brand": {96 "type": "object",97 "description": "Details about the product's brand.",98 "properties": {99 "id": {100 "type": "integer",101 "description": "Unique identifier for the brand."102 }103 },104 "required": [105 "id"106 ]107 },108 "store": {109 "type": "object",110 "description": "Information about the store selling the product.",111 "properties": {112 "id": {113 "type": "integer",114 "description": "Unique identifier for the store."115 }116 },117 "required": [118 "id"119 ]120 },121 "company": {122 "type": "object",123 "description": "Information about the company producing or selling the product.",124 "properties": {125 "id": {126 "type": "integer",127 "description": "Unique identifier for the company."128 }129 },130 "required": [131 "id"132 ]133 },134 "item_id": {135 "type": "integer",136 "description": "Unique identifier for the item."137 },138 "fynd_item_code": {139 "type": "string",140 "description": "Fynd's unique internal code for the product."141 },142 "seller_identifier": {143 "type": "string",144 "description": "Unique identifier used by the seller for the product."145 }146 }147 }148 }149 }150 }151 }152}
Payload Example
1{2 "company_id": 61,3 "contains": [4 "prices"5 ],6 "event": {7 "category": "company",8 "created_timestamp": 1711552926254,9 "id": "TnDwx8zqahrSj4ZoX7pGG0wqnchYTJt9BduujJ+RM2M=",10 "name": "location-price",11 "trace_id": [12 "silverbolt.c5576594-ec4d-11ee-ba7a-36c24ca45877"13 ],14 "type": "delete",15 "version": "1"16 },17 "payload": {18 "articles": [19 {20 "brand": {21 "id": 355922 },23 "company": {24 "id": 6125 },26 "fynd_item_code": "DSJHJJKSVD",27 "item_id": 10198724,28 "seller_identifier": "SDVKJNSVD",29 "size": "OS",30 "store": {31 "id": 1541132 },33 "uid": "15411_SDVKJNSVD"34 }35 ]36 }37}