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-quantity/create/v1
# this event is triggered when location quantity is created
company/location-quantity/update/v1
# this event is triggered when location quantity is updated
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
quantities
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.
total_quantity
integer
Required
Total quantity available for the product.
quantities
object
Required
Information about product quantities, including available and unavailable stock.
Properties
damaged
object|null
Details of damaged stock.
Properties
count
integer
Required
Number of damaged units.
updated_at
string
Required
Timestamp of the last damaged stock update.
sellable
object
Required
Sellable stock information.
Properties
count
integer
Required
Number of sellable units available.
updated_at
string
Required
Timestamp of the last sellable stock update.
not_available
object|null
Information about unavailable stock.
Properties
count
integer
Required
Number of unavailable units.
updated_at
string
Required
Timestamp of the last unavailable stock update.
order_committed
object|null
Details of committed orders.
Properties
count
integer
Number of units committed to orders.
updated_at
string
Timestamp of the last order committed update.
expiration_date
string
Expiration or validity end date for the product.
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.
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 "quantities"70 ],71 "properties": {72 "quantities": {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 "total_quantity",86 "quantities"87 ],88 "properties": {89 "uid": {90 "type": "string",91 "description": "Combination of item code and store ID to uniquely identify the article."92 },93 "size": {94 "type": "string",95 "description": "Product size (e.g., S, M, L, XL)."96 },97 "brand": {98 "type": "object",99 "description": "Details about the product's brand.",100 "properties": {101 "id": {102 "type": "integer",103 "description": "Unique identifier for the brand."104 }105 },106 "required": [107 "id"108 ]109 },110 "total_quantity": {111 "type": "integer",112 "description": "Total quantity available for the product."113 },114 "quantities": {115 "type": "object",116 "description": "Information about product quantities, including available and unavailable stock.",117 "properties": {118 "damaged": {119 "type": [120 "object",121 "null"122 ],123 "description": "Details of damaged stock.",124 "properties": {125 "count": {126 "type": "integer",127 "description": "Number of damaged units."128 },129 "updated_at": {130 "type": "string",131 "description": "Timestamp of the last damaged stock update."132 }133 },134 "required": [135 "count",136 "updated_at"137 ]138 },139 "sellable": {140 "type": "object",141 "description": "Sellable stock information.",142 "properties": {143 "count": {144 "type": "integer",145 "description": "Number of sellable units available."146 },147 "updated_at": {148 "type": "string",149 "description": "Timestamp of the last sellable stock update."150 }151 },152 "required": [153 "count",154 "updated_at"155 ]156 },157 "not_available": {158 "type": [159 "object",160 "null"161 ],162 "description": "Information about unavailable stock.",163 "properties": {164 "count": {165 "type": "integer",166 "description": "Number of unavailable units."167 },168 "updated_at": {169 "type": "string",170 "description": "Timestamp of the last unavailable stock update."171 }172 },173 "required": [174 "count",175 "updated_at"176 ]177 },178 "order_committed": {179 "type": [180 "object",181 "null"182 ],183 "description": "Details of committed orders.",184 "properties": {185 "count": {186 "type": "integer",187 "description": "Number of units committed to orders."188 },189 "updated_at": {190 "type": "string",191 "description": "Timestamp of the last order committed update."192 }193 }194 }195 },196 "required": [197 "sellable"198 ]199 },200 "expiration_date": {201 "type": "string",202 "description": "Expiration or validity end date for the product."203 },204 "store": {205 "type": "object",206 "description": "Information about the store selling the product.",207 "properties": {208 "id": {209 "type": "integer",210 "description": "Unique identifier for the store."211 }212 },213 "required": [214 "id"215 ]216 },217 "company": {218 "type": "object",219 "description": "Information about the company producing or selling the product.",220 "properties": {221 "id": {222 "type": "integer",223 "description": "Unique identifier for the company."224 }225 },226 "required": [227 "id"228 ]229 },230 "item_id": {231 "type": "integer",232 "description": "Unique identifier for the item."233 },234 "date_meta": {235 "type": "object",236 "description": "Timestamps for important events in the product's lifecycle.",237 "properties": {238 "created_on": {239 "type": "string",240 "format": "date-time",241 "description": "Date and time when the product was first created."242 },243 "modified_on": {244 "type": "string",245 "format": "date-time",246 "description": "Last modification timestamp of the product inventory details."247 },248 "added_on_store": {249 "type": "string",250 "format": "date-time",251 "description": "Date and time when the product was added to the store."252 },253 "inventory_updated_on": {254 "type": "string",255 "format": "date-time",256 "description": "Last inventory update timestamp."257 }258 },259 "required": [260 "modified_on"261 ]262 },263 "fynd_item_code": {264 "type": "string",265 "description": "Fynd's unique internal code for the product."266 },267 "seller_identifier": {268 "type": "string",269 "description": "Unique identifier used by the seller for the product."270 }271 }272 }273 }274 }275 }276 }277}
Payload Example
1{2 "company_id": 3932,3 "contains": [4 "quantities"5 ],6 "event": {7 "category": "company",8 "created_timestamp": 1712213140518,9 "id": "uVxPGUEmbYi7/WCvNFfFY03tJiSTOqP6kgMZOxxmGrI=",10 "name": "location-quantity",11 "trace_id": [12 "silverbolt.f3b55ffc-f24e-11ee-ad2e-c227286f4511"13 ],14 "type": "update",15 "version": "1"16 },17 "payload": {18 "quantities": [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 "seller_identifier": "8905310270582",35 "size": "L",36 "store": {37 "id": 2363038 },39 "uid": "23630_8905310270582",40 "quantities": {41 "sellable": {42 "count": 1,43 "updated_at": "2024-04-04 06:45:40.072820"44 }45 },46 "total_quantity": 1,47 "expiration_date": "9998-01-30 23:59:00"48 }49 ]50 }51}
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
quantities
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.
total_quantity
integer
Required
Total quantity available for the product.
quantities
object
Required
Information about product quantities, including available and unavailable stock.
Properties
damaged
object|null
Details of damaged stock.
Properties
count
integer
Required
Number of damaged units.
updated_at
string
Required
Timestamp of the last damaged stock update.
sellable
object
Required
Sellable stock information.
Properties
count
integer
Required
Number of sellable units available.
updated_at
string
Required
Timestamp of the last sellable stock update.
not_available
object|null
Information about unavailable stock.
Properties
count
integer
Required
Number of unavailable units.
updated_at
string
Required
Timestamp of the last unavailable stock update.
order_committed
object|null
Details of committed orders.
Properties
count
integer
Number of units committed to orders.
updated_at
string
Timestamp of the last order committed update.
expiration_date
string
Expiration or validity end date for the product.
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.
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 "quantities"70 ],71 "properties": {72 "quantities": {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 "total_quantity",86 "quantities"87 ],88 "properties": {89 "uid": {90 "type": "string",91 "description": "Combination of item code and store ID to uniquely identify the article."92 },93 "size": {94 "type": "string",95 "description": "Product size (e.g., S, M, L, XL)."96 },97 "brand": {98 "type": "object",99 "description": "Details about the product's brand.",100 "properties": {101 "id": {102 "type": "integer",103 "description": "Unique identifier for the brand."104 }105 },106 "required": [107 "id"108 ]109 },110 "total_quantity": {111 "type": "integer",112 "description": "Total quantity available for the product."113 },114 "quantities": {115 "type": "object",116 "description": "Information about product quantities, including available and unavailable stock.",117 "properties": {118 "damaged": {119 "type": [120 "object",121 "null"122 ],123 "description": "Details of damaged stock.",124 "properties": {125 "count": {126 "type": "integer",127 "description": "Number of damaged units."128 },129 "updated_at": {130 "type": "string",131 "description": "Timestamp of the last damaged stock update."132 }133 },134 "required": [135 "count",136 "updated_at"137 ]138 },139 "sellable": {140 "type": "object",141 "description": "Sellable stock information.",142 "properties": {143 "count": {144 "type": "integer",145 "description": "Number of sellable units available."146 },147 "updated_at": {148 "type": "string",149 "description": "Timestamp of the last sellable stock update."150 }151 },152 "required": [153 "count",154 "updated_at"155 ]156 },157 "not_available": {158 "type": [159 "object",160 "null"161 ],162 "description": "Information about unavailable stock.",163 "properties": {164 "count": {165 "type": "integer",166 "description": "Number of unavailable units."167 },168 "updated_at": {169 "type": "string",170 "description": "Timestamp of the last unavailable stock update."171 }172 },173 "required": [174 "count",175 "updated_at"176 ]177 },178 "order_committed": {179 "type": [180 "object",181 "null"182 ],183 "description": "Details of committed orders.",184 "properties": {185 "count": {186 "type": "integer",187 "description": "Number of units committed to orders."188 },189 "updated_at": {190 "type": "string",191 "description": "Timestamp of the last order committed update."192 }193 }194 }195 },196 "required": [197 "sellable"198 ]199 },200 "expiration_date": {201 "type": "string",202 "description": "Expiration or validity end date for the product."203 },204 "store": {205 "type": "object",206 "description": "Information about the store selling the product.",207 "properties": {208 "id": {209 "type": "integer",210 "description": "Unique identifier for the store."211 }212 },213 "required": [214 "id"215 ]216 },217 "company": {218 "type": "object",219 "description": "Information about the company producing or selling the product.",220 "properties": {221 "id": {222 "type": "integer",223 "description": "Unique identifier for the company."224 }225 },226 "required": [227 "id"228 ]229 },230 "item_id": {231 "type": "integer",232 "description": "Unique identifier for the item."233 },234 "date_meta": {235 "type": "object",236 "description": "Timestamps for important events in the product's lifecycle.",237 "properties": {238 "created_on": {239 "type": "string",240 "format": "date-time",241 "description": "Date and time when the product was first created."242 },243 "modified_on": {244 "type": "string",245 "format": "date-time",246 "description": "Last modification timestamp of the product inventory details."247 },248 "added_on_store": {249 "type": "string",250 "format": "date-time",251 "description": "Date and time when the product was added to the store."252 },253 "inventory_updated_on": {254 "type": "string",255 "format": "date-time",256 "description": "Last inventory update timestamp."257 }258 },259 "required": [260 "modified_on"261 ]262 },263 "fynd_item_code": {264 "type": "string",265 "description": "Fynd's unique internal code for the product."266 },267 "seller_identifier": {268 "type": "string",269 "description": "Unique identifier used by the seller for the product."270 }271 }272 }273 }274 }275 }276 }277}
Payload Example
1{2 "company_id": 3932,3 "contains": [4 "quantities"5 ],6 "event": {7 "category": "company",8 "created_timestamp": 1712213140518,9 "id": "uVxPGUEmbYi7/WCvNFfFY03tJiSTOqP6kgMZOxxmGrI=",10 "name": "location-quantity",11 "trace_id": [12 "silverbolt.f3b55ffc-f24e-11ee-ad2e-c227286f4511"13 ],14 "type": "update",15 "version": "1"16 },17 "payload": {18 "quantities": [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 "seller_identifier": "8905310270582",35 "size": "L",36 "store": {37 "id": 2363038 },39 "uid": "23630_8905310270582",40 "quantities": {41 "sellable": {42 "count": 1,43 "updated_at": "2024-04-04 06:45:40.072820"44 }45 },46 "total_quantity": 1,47 "expiration_date": "9998-01-30 23:59:00"48 }49 ]50 }51}