Company
Events categorised under company level will be triggered when any action performed on company. e.g. If new brand is created.
Events
company/article/create/v1
# this event is triggered when article is created
company/article/update/v1
# this event is triggered when article is updated
company/article/delete/v1
# this event is triggered when article is deleted
Payload
Hide
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
Show
payload
object
Required
Show
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 "articles"70 ],71 "properties": {72 "articles": {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 "identifier",85 "seller_identifier",86 "price",87 "total_quantity",88 "dimension",89 "weight",90 "manufacturer",91 "country_of_origin"92 ],93 "properties": {94 "id": {95 "type": "string",96 "description": "Unique identifier for the article."97 },98 "uid": {99 "type": "string",100 "description": "Combination of item code and store ID to uniquely identify the article."101 },102 "size": {103 "type": "string",104 "description": "Product size (e.g., S, M, L, XL)."105 },106 "brand": {107 "type": "object",108 "description": "Details about the product's brand.",109 "properties": {110 "id": {111 "type": "integer",112 "description": "Unique identifier for the brand."113 }114 },115 "required": [116 "id"117 ]118 },119 "price": {120 "type": "object",121 "description": "Pricing details of the product, including various price types.",122 "properties": {123 "marked": {124 "type": "number",125 "description": "Marked price or original listed price of the product."126 },127 "currency": {128 "type": "string",129 "description": "Currency used for the product's pricing (e.g., USD, EUR)."130 },131 "transfer": {132 "type": "number",133 "description": "Transfer price of the product."134 },135 "effective": {136 "type": "number",137 "description": "Final price after applying discounts."138 },139 "updated_at": {140 "type": "string",141 "format": "date-time",142 "description": "Date and time when the pricing information was last updated."143 },144 "cost": {145 "type": "number",146 "description": "The original price incurred to produce or acquire a product before any markup."147 }148 },149 "required": [150 "transfer",151 "effective",152 "marked",153 "currency"154 ]155 },156 "store": {157 "type": "object",158 "description": "Information about the store selling the product.",159 "properties": {160 "id": {161 "type": "integer",162 "description": "Unique identifier for the store."163 }164 },165 "required": [166 "id"167 ]168 },169 "is_set": {170 "type": "boolean",171 "description": "Indicates if the product is sold as part of a set."172 },173 "weight": {174 "type": "object",175 "description": "Weight details of the product.",176 "properties": {177 "unit": {178 "type": "string",179 "description": "Unit of weight measurement (e.g., kg, lbs)."180 },181 "shipping": {182 "type": "number",183 "description": "Shipping weight of the product."184 },185 "is_default": {186 "type": "boolean",187 "description": "Indicates if this is the default weight configuration."188 }189 },190 "required": [191 "unit",192 "shipping"193 ]194 },195 "company": {196 "type": "object",197 "description": "Information about the company producing or selling the product.",198 "properties": {199 "id": {200 "type": "integer",201 "description": "Unique identifier for the company."202 }203 },204 "required": [205 "id"206 ]207 },208 "item_id": {209 "type": "integer",210 "description": "Unique identifier for the item."211 },212 "date_meta": {213 "type": "object",214 "description": "Timestamps for important events in the product's lifecycle.",215 "properties": {216 "created_on": {217 "type": "string",218 "format": "date-time",219 "description": "Date and time when the product was first created."220 },221 "modified_on": {222 "type": "string",223 "format": "date-time",224 "description": "Last modification timestamp of the product inventory details."225 },226 "added_on_store": {227 "type": "string",228 "format": "date-time",229 "description": "Date and time when the product was added to the store."230 },231 "inventory_updated_on": {232 "type": "string",233 "format": "date-time",234 "description": "Last inventory update timestamp."235 }236 },237 "required": [238 "modified_on"239 ]240 },241 "dimension": {242 "type": "object",243 "description": "Dimension details of the product.",244 "properties": {245 "unit": {246 "type": "string",247 "description": "Unit of dimension measurement (e.g., cm, inches)."248 },249 "width": {250 "type": "number",251 "description": "Width of the product."252 },253 "height": {254 "type": "number",255 "description": "Height of the product."256 },257 "length": {258 "type": "number",259 "description": "Length of the product."260 },261 "is_default": {262 "type": "boolean",263 "description": "Indicates if these are the default dimensions."264 }265 },266 "required": [267 "unit",268 "height",269 "width",270 "length"271 ]272 },273 "is_active": {274 "type": "boolean",275 "description": "Indicates if the product is currently active (available for sale)."276 },277 "identifier": {278 "type": "object",279 "additionalProperties": true,280 "description": "Product-specific identifier details."281 },282 "quantities": {283 "type": "object",284 "description": "Information about product quantities, including available and unavailable stock.",285 "properties": {286 "damaged": {287 "type": "object",288 "description": "Details of damaged stock.",289 "properties": {290 "count": {291 "type": "integer",292 "description": "Number of damaged units."293 },294 "updated_at": {295 "type": "string",296 "description": "Timestamp of the last damaged stock update."297 }298 },299 "required": [300 "count",301 "updated_at"302 ]303 },304 "sellable": {305 "type": "object",306 "description": "Sellable stock information.",307 "properties": {308 "count": {309 "type": "integer",310 "description": "Number of sellable units available."311 },312 "updated_at": {313 "type": "string",314 "description": "Timestamp of the last sellable stock update."315 }316 },317 "required": [318 "count",319 "updated_at"320 ]321 },322 "not_available": {323 "type": "object",324 "description": "Information about unavailable stock.",325 "properties": {326 "count": {327 "type": "integer",328 "description": "Number of unavailable units."329 },330 "updated_at": {331 "type": "string",332 "description": "Timestamp of the last unavailable stock update."333 }334 },335 "required": [336 "count",337 "updated_at"338 ]339 },340 "order_committed": {341 "type": "object",342 "description": "Details of committed orders.",343 "properties": {344 "count": {345 "type": "integer",346 "description": "Number of units committed to orders."347 },348 "updated_at": {349 "type": "string",350 "description": "Timestamp of the last order committed update."351 }352 }353 }354 },355 "required": [356 "sellable"357 ]358 },359 "_custom_json": {360 "type": "object",361 "description": "Custom JSON data associated with the product."362 },363 "trader": {364 "type": "array",365 "description": "List of traders associated with the product.",366 "items": {367 "type": "object",368 "properties": {369 "name": {370 "type": "string",371 "description": "Trader's name."372 },373 "type": {374 "type": "string",375 "enum": [376 "Manufacturer",377 "Importer",378 "Packer",379 "Marketer"380 ],381 "description": "Indicates the trader type."382 },383 "address": {384 "type": "array",385 "description": "List of addresses associated with the trader.",386 "items": {387 "type": "string"388 }389 }390 }391 }392 },393 "manufacturer": {394 "type": "object",395 "description": "Information about the product's manufacturer.",396 "properties": {397 "name": {398 "type": "string",399 "description": "Manufacturer's name."400 },401 "address": {402 "type": "string",403 "description": "Manufacturer's physical address."404 },405 "is_default": {406 "type": "boolean",407 "description": "Indicates if this is the default manufacturer for the product."408 }409 },410 "required": [411 "name",412 "address"413 ]414 },415 "return_config": {416 "type": "object",417 "description": "Return policy configuration for the product.",418 "properties": {419 "unit": {420 "type": "string",421 "enum": [422 "days",423 "hours"424 ],425 "description": "Time unit for the return period (either days or hours)."426 },427 "time": {428 "type": "integer",429 "description": "Duration within which the product can be returned."430 },431 "returnable": {432 "type": "boolean",433 "description": "Indicates if the product is returnable."434 }435 },436 "required": [437 "returnable"438 ]439 },440 "fynd_item_code": {441 "type": "string",442 "description": "Fynd's unique internal code for the product."443 },444 "tax_identifier": {445 "type": "object",446 "description": "Tax-related identification for the product",447 "properties": {448 "tax_rule_id": {449 "type": "string",450 "description": "Id of tax rule."451 },452 "hsn_code_id": {453 "type": [454 "string",455 "null"456 ],457 "description": "HSN (Harmonized System of Nomenclature) code identifier."458 }459 }460 },461 "hs_code": {462 "type": [463 "string",464 "null"465 ],466 "description": "Harmonized System (HS) code for the product."467 },468 "total_quantity": {469 "type": "integer",470 "description": "Total quantity available for the product."471 },472 "expiration_date": {473 "type": "string",474 "description": "Expiration or validity end date for the product."475 },476 "track_inventory": {477 "type": "boolean",478 "description": "Indicates if inventory tracking is enabled for the product."479 },480 "country_of_origin": {481 "type": "string",482 "description": "Country where the product was manufactured or originated."483 },484 "stage": {485 "type": "string",486 "description": "Current stage of the product lifecycle (e.g., verified)."487 },488 "set": {489 "type": "object",490 "description": "Configuration of the set, if the product is sold as one.",491 "properties": {492 "quantity": {493 "type": "integer",494 "description": "Total number of items in the set."495 },496 "size_distribution": {497 "type": "object",498 "description": "Size distribution details within the set.",499 "properties": {500 "sizes": {501 "type": "array",502 "description": "List of sizes and their respective quantities.",503 "items": {504 "type": "object",505 "properties": {506 "size": {507 "type": "string",508 "description": "Label of the size (e.g., S, M, L)."509 },510 "pieces": {511 "type": "integer",512 "description": "Quantity of pieces for the corresponding size."513 }514 }515 }516 }517 }518 }519 }520 },521 "seller_identifier": {522 "type": "string",523 "description": "Unique identifier used by the seller for the product."524 },525 "trace_id": {526 "type": "string",527 "description": "internal trace_id for Fynd Platform services"528 },529 "tags": {530 "type": "array",531 "description": "Tags or labels assigned to the product for categorization or search purposes.",532 "items": {533 "type": "string"534 }535 },536 "modified_by": {537 "type": "object",538 "description": "Details of the user who modified the product inventory.",539 "properties": {540 "user_id": {541 "type": "string",542 "description": "User ID of the modifier."543 }544 }545 },546 "created_by": {547 "type": "object",548 "description": "Details of the user who added/created the product inventory.",549 "properties": {550 "user_id": {551 "type": "string",552 "description": "User ID of the creator."553 }554 }555 }556 }557 }558 }559 }560 }561 }562}
Payload Example
1{2 "company_id": 3932,3 "contains": [4 "articles"5 ],6 "event": {7 "category": "company",8 "created_timestamp": 1712213140518,9 "id": "uVxPGUEmbYi7/WCvNFfFY03tJiSTOqP6kgMZOxxmGrI=",10 "name": "article",11 "trace_id": [12 "silverbolt.f3b55ffc-f24e-11ee-ad2e-c227286f4511"13 ],14 "type": "create",15 "version": "1"16 },17 "payload": {18 "articles": [19 {20 "_custom_json": {},21 "brand": {22 "id": 41423 },24 "company": {25 "id": 393226 },27 "country_of_origin": "India",28 "date_meta": {29 "added_on_store": "2024-04-04 06:45:40.083507+00:00",30 "created_on": "2024-04-04 06:45:40.072820",31 "inventory_updated_on": "2024-04-04 06:45:40.072820",32 "modified_on": "2024-04-04 06:45:40.072820"33 },34 "dimension": {35 "height": 5,36 "length": 33,37 "unit": "cm",38 "width": 2539 },40 "expiration_date": "9998-01-30 23:59:00",41 "fynd_item_code": "MFK-9332-Q-163-LIGHT BLUE",42 "id": "",43 "identifier": {44 "ean": "8905310270582"45 },46 "is_active": true,47 "is_set": false,48 "item_id": 8684655,49 "manufacturer": {50 "address": "B-8, MIDC CENTRAL ROAD, MAROL, NEXT TO MIDC POLICE STATION, ANDHERI EAST, MUMBAI -400093, , Maharashtra, Mumbai",51 "name": "Credo Brands Marketing Limited"52 },53 "price": {54 "currency": "INR",55 "effective": 2199,56 "marked": 2199,57 "transfer": 058 },59 "quantities": {60 "sellable": {61 "count": 1,62 "updated_at": "2024-04-04 06:45:40.072820"63 }64 },65 "return_config": {66 "returnable": true,67 "time": 30,68 "unit": "days"69 },70 "seller_identifier": "8905310270582",71 "size": "L",72 "stage": "verified",73 "store": {74 "id": 2363075 },76 "tags": [],77 "tax_identifier": {78 "tax_rule_id": "6277837c5e4c6fdbc8be3e93",79 "hsn_code_id": "6277837c5e4c6fdbc8be3e93"80 },81 "hs_code": "1234",82 "total_quantity": 1,83 "trace_id": "inventory.f366a506-f24e-11ee-ad2e-c227286f4511",84 "track_inventory": true,85 "uid": "23630_8905310270582",86 "weight": {87 "shipping": 250,88 "unit": "gram"89 }90 }91 ]92 }93}
Payload
Hide
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
Show
payload
object
Required
Show
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 "articles"70 ],71 "properties": {72 "articles": {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 "identifier",85 "seller_identifier",86 "price",87 "total_quantity",88 "dimension",89 "weight",90 "manufacturer",91 "country_of_origin"92 ],93 "properties": {94 "id": {95 "type": "string",96 "description": "Unique identifier for the article."97 },98 "uid": {99 "type": "string",100 "description": "Combination of item code and store ID to uniquely identify the article."101 },102 "size": {103 "type": "string",104 "description": "Product size (e.g., S, M, L, XL)."105 },106 "brand": {107 "type": "object",108 "description": "Details about the product's brand.",109 "properties": {110 "id": {111 "type": "integer",112 "description": "Unique identifier for the brand."113 }114 },115 "required": [116 "id"117 ]118 },119 "price": {120 "type": "object",121 "description": "Pricing details of the product, including various price types.",122 "properties": {123 "marked": {124 "type": "number",125 "description": "Marked price or original listed price of the product."126 },127 "currency": {128 "type": "string",129 "description": "Currency used for the product's pricing (e.g., USD, EUR)."130 },131 "transfer": {132 "type": "number",133 "description": "Transfer price of the product."134 },135 "effective": {136 "type": "number",137 "description": "Final price after applying discounts."138 },139 "updated_at": {140 "type": "string",141 "format": "date-time",142 "description": "Date and time when the pricing information was last updated."143 },144 "cost": {145 "type": "number",146 "description": "The original price incurred to produce or acquire a product before any markup."147 }148 },149 "required": [150 "transfer",151 "effective",152 "marked",153 "currency"154 ]155 },156 "store": {157 "type": "object",158 "description": "Information about the store selling the product.",159 "properties": {160 "id": {161 "type": "integer",162 "description": "Unique identifier for the store."163 }164 },165 "required": [166 "id"167 ]168 },169 "is_set": {170 "type": "boolean",171 "description": "Indicates if the product is sold as part of a set."172 },173 "weight": {174 "type": "object",175 "description": "Weight details of the product.",176 "properties": {177 "unit": {178 "type": "string",179 "description": "Unit of weight measurement (e.g., kg, lbs)."180 },181 "shipping": {182 "type": "number",183 "description": "Shipping weight of the product."184 },185 "is_default": {186 "type": "boolean",187 "description": "Indicates if this is the default weight configuration."188 }189 },190 "required": [191 "unit",192 "shipping"193 ]194 },195 "company": {196 "type": "object",197 "description": "Information about the company producing or selling the product.",198 "properties": {199 "id": {200 "type": "integer",201 "description": "Unique identifier for the company."202 }203 },204 "required": [205 "id"206 ]207 },208 "item_id": {209 "type": "integer",210 "description": "Unique identifier for the item."211 },212 "date_meta": {213 "type": "object",214 "description": "Timestamps for important events in the product's lifecycle.",215 "properties": {216 "created_on": {217 "type": "string",218 "format": "date-time",219 "description": "Date and time when the product was first created."220 },221 "modified_on": {222 "type": "string",223 "format": "date-time",224 "description": "Last modification timestamp of the product inventory details."225 },226 "added_on_store": {227 "type": "string",228 "format": "date-time",229 "description": "Date and time when the product was added to the store."230 },231 "inventory_updated_on": {232 "type": "string",233 "format": "date-time",234 "description": "Last inventory update timestamp."235 }236 },237 "required": [238 "modified_on"239 ]240 },241 "dimension": {242 "type": "object",243 "description": "Dimension details of the product.",244 "properties": {245 "unit": {246 "type": "string",247 "description": "Unit of dimension measurement (e.g., cm, inches)."248 },249 "width": {250 "type": "number",251 "description": "Width of the product."252 },253 "height": {254 "type": "number",255 "description": "Height of the product."256 },257 "length": {258 "type": "number",259 "description": "Length of the product."260 },261 "is_default": {262 "type": "boolean",263 "description": "Indicates if these are the default dimensions."264 }265 },266 "required": [267 "unit",268 "height",269 "width",270 "length"271 ]272 },273 "is_active": {274 "type": "boolean",275 "description": "Indicates if the product is currently active (available for sale)."276 },277 "identifier": {278 "type": "object",279 "additionalProperties": true,280 "description": "Product-specific identifier details."281 },282 "quantities": {283 "type": "object",284 "description": "Information about product quantities, including available and unavailable stock.",285 "properties": {286 "damaged": {287 "type": "object",288 "description": "Details of damaged stock.",289 "properties": {290 "count": {291 "type": "integer",292 "description": "Number of damaged units."293 },294 "updated_at": {295 "type": "string",296 "description": "Timestamp of the last damaged stock update."297 }298 },299 "required": [300 "count",301 "updated_at"302 ]303 },304 "sellable": {305 "type": "object",306 "description": "Sellable stock information.",307 "properties": {308 "count": {309 "type": "integer",310 "description": "Number of sellable units available."311 },312 "updated_at": {313 "type": "string",314 "description": "Timestamp of the last sellable stock update."315 }316 },317 "required": [318 "count",319 "updated_at"320 ]321 },322 "not_available": {323 "type": "object",324 "description": "Information about unavailable stock.",325 "properties": {326 "count": {327 "type": "integer",328 "description": "Number of unavailable units."329 },330 "updated_at": {331 "type": "string",332 "description": "Timestamp of the last unavailable stock update."333 }334 },335 "required": [336 "count",337 "updated_at"338 ]339 },340 "order_committed": {341 "type": "object",342 "description": "Details of committed orders.",343 "properties": {344 "count": {345 "type": "integer",346 "description": "Number of units committed to orders."347 },348 "updated_at": {349 "type": "string",350 "description": "Timestamp of the last order committed update."351 }352 }353 }354 },355 "required": [356 "sellable"357 ]358 },359 "_custom_json": {360 "type": "object",361 "description": "Custom JSON data associated with the product."362 },363 "trader": {364 "type": "array",365 "description": "List of traders associated with the product.",366 "items": {367 "type": "object",368 "properties": {369 "name": {370 "type": "string",371 "description": "Trader's name."372 },373 "type": {374 "type": "string",375 "enum": [376 "Manufacturer",377 "Importer",378 "Packer",379 "Marketer"380 ],381 "description": "Indicates the trader type."382 },383 "address": {384 "type": "array",385 "description": "List of addresses associated with the trader.",386 "items": {387 "type": "string"388 }389 }390 }391 }392 },393 "manufacturer": {394 "type": "object",395 "description": "Information about the product's manufacturer.",396 "properties": {397 "name": {398 "type": "string",399 "description": "Manufacturer's name."400 },401 "address": {402 "type": "string",403 "description": "Manufacturer's physical address."404 },405 "is_default": {406 "type": "boolean",407 "description": "Indicates if this is the default manufacturer for the product."408 }409 },410 "required": [411 "name",412 "address"413 ]414 },415 "return_config": {416 "type": "object",417 "description": "Return policy configuration for the product.",418 "properties": {419 "unit": {420 "type": "string",421 "enum": [422 "days",423 "hours"424 ],425 "description": "Time unit for the return period (either days or hours)."426 },427 "time": {428 "type": "integer",429 "description": "Duration within which the product can be returned."430 },431 "returnable": {432 "type": "boolean",433 "description": "Indicates if the product is returnable."434 }435 },436 "required": [437 "returnable"438 ]439 },440 "fynd_item_code": {441 "type": "string",442 "description": "Fynd's unique internal code for the product."443 },444 "tax_identifier": {445 "type": "object",446 "description": "Tax-related identification for the product.",447 "properties": {448 "tax_rule_id": {449 "type": "string",450 "description": "Tax rule id."451 },452 "hsn_code_id": {453 "type": [454 "string",455 "null"456 ],457 "description": "HSN code id."458 }459 }460 },461 "hs_code": {462 "type": [463 "string",464 "null"465 ],466 "description": "Harmonized System (HS) code for the product."467 },468 "total_quantity": {469 "type": "integer",470 "description": "Total quantity available for the product."471 },472 "expiration_date": {473 "type": "string",474 "description": "Expiration or validity end date for the product."475 },476 "track_inventory": {477 "type": "boolean",478 "description": "Indicates if inventory tracking is enabled for the product."479 },480 "country_of_origin": {481 "type": "string",482 "description": "Country where the product was manufactured or originated."483 },484 "stage": {485 "type": "string",486 "description": "Current stage of the product lifecycle (e.g., verified)."487 },488 "set": {489 "type": "object",490 "description": "Configuration of the set, if the product is sold as one.",491 "properties": {492 "quantity": {493 "type": "integer",494 "description": "Total number of items in the set."495 },496 "size_distribution": {497 "type": "object",498 "description": "Size distribution details within the set.",499 "properties": {500 "sizes": {501 "type": "array",502 "description": "List of sizes and their respective quantities.",503 "items": {504 "type": "object",505 "properties": {506 "size": {507 "type": "string",508 "description": "Label of the size (e.g., S, M, L)."509 },510 "pieces": {511 "type": "integer",512 "description": "Quantity of pieces for the corresponding size."513 }514 }515 }516 }517 }518 }519 }520 },521 "seller_identifier": {522 "type": "string",523 "description": "Unique identifier used by the seller for the product."524 },525 "trace_id": {526 "type": "string",527 "description": "internal trace_id for Fynd Platform services"528 },529 "tags": {530 "type": "array",531 "description": "Tags or labels assigned to the product for categorization or search purposes.",532 "items": {533 "type": "string"534 }535 },536 "modified_by": {537 "type": "object",538 "description": "Details of the user who modified the product inventory.",539 "properties": {540 "user_id": {541 "type": "string",542 "description": "User ID of the modifier."543 }544 }545 },546 "created_by": {547 "type": "object",548 "description": "Details of the user who added/created the product inventory.",549 "properties": {550 "user_id": {551 "type": "string",552 "description": "User ID of the creator."553 }554 }555 }556 }557 }558 }559 }560 }561 }562}
Payload Example
1{2 "company_id": 3932,3 "contains": [4 "articles"5 ],6 "event": {7 "category": "company",8 "created_timestamp": 1712143546633,9 "id": "JTxFS9aTWX0Jzkzgher4YEpDoRWtok4kUdIwPHtufiQ=",10 "name": "article",11 "trace_id": [12 "silverbolt.ea855272-f1ac-11ee-b06f-aeef32a192b9"13 ],14 "type": "update",15 "version": "1"16 },17 "payload": {18 "articles": [19 {20 "_custom_json": {},21 "brand": {22 "id": 41423 },24 "company": {25 "id": 393226 },27 "country_of_origin": "India",28 "date_meta": {29 "inventory_updated_on": "2024-04-03 11:25:46.620269",30 "modified_on": "2024-04-03 11:25:46.620269"31 },32 "dimension": {33 "height": 5,34 "length": 33,35 "unit": "cm",36 "width": 2537 },38 "expiration_date": "9998-01-30 23:59:00",39 "fynd_item_code": "MFT-28408-P-01-BLACK",40 "id": "64a8bb0c3834e4c1b96f72f2",41 "identifier": {42 "ean": "8905310163563"43 },44 "is_active": true,45 "is_set": false,46 "item_id": 8696234,47 "manufacturer": {48 "address": "B-8, ANDHERI EAST, MUMBAI -400093, , MAHARASHTRA, MUMBAI SUBURBAN",49 "name": "Credo Brands Marketing Limited"50 },51 "price": {52 "currency": "INR",53 "effective": 4099,54 "marked": 4099,55 "transfer": 056 },57 "quantities": {58 "damaged": {59 "count": 0,60 "updated_at": "2024-04-03 11:25:46.620269"61 },62 "not_available": {63 "count": 0,64 "updated_at": "2024-04-03 11:25:46.620269"65 },66 "sellable": {67 "count": 2,68 "updated_at": "2024-04-03 11:25:46.620269"69 }70 },71 "return_config": {72 "returnable": true,73 "time": 30,74 "unit": "days"75 },76 "seller_identifier": "8905310163563",77 "size": "30",78 "stage": "verified",79 "store": {80 "id": 1810481 },82 "tags": [],83 "tax_identifier": {84 "tax_rule_id": "6277838c5e4c6fdbc8be402d",85 "hsn_code_id": "6277838c5e4c6fdbc8be402d"86 },87 "hs_code": "124",88 "total_quantity": 2,89 "trace_id": "660d3cb866632959e7348904",90 "track_inventory": true,91 "uid": "18104_8905310163563",92 "weight": {93 "shipping": 600,94 "unit": "gram"95 }96 }97 ]98 }99}
Payload
Hide
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
Show
payload
object
Required
Show
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 "articles"70 ],71 "properties": {72 "articles": {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 "identifier",85 "seller_identifier",86 "price",87 "total_quantity",88 "dimension",89 "weight",90 "manufacturer",91 "country_of_origin"92 ],93 "properties": {94 "id": {95 "type": "string",96 "description": "Unique identifier for the article."97 },98 "uid": {99 "type": "string",100 "description": "Combination of item code and store ID to uniquely identify the article."101 },102 "size": {103 "type": "string",104 "description": "Product size (e.g., S, M, L, XL)."105 },106 "brand": {107 "type": "object",108 "description": "Details about the product's brand.",109 "properties": {110 "id": {111 "type": "integer",112 "description": "Unique identifier for the brand."113 }114 },115 "required": [116 "id"117 ]118 },119 "price": {120 "type": "object",121 "description": "Pricing details of the product, including various price types.",122 "properties": {123 "marked": {124 "type": "number",125 "description": "Marked price or original listed price of the product."126 },127 "currency": {128 "type": "string",129 "description": "Currency used for the product's pricing (e.g., USD, EUR)."130 },131 "transfer": {132 "type": "number",133 "description": "Transfer price of the product."134 },135 "effective": {136 "type": "number",137 "description": "Final price after applying discounts."138 },139 "updated_at": {140 "type": "string",141 "format": "date-time",142 "description": "Date and time when the pricing information was last updated."143 },144 "cost": {145 "type": "number",146 "description": "The original price incurred to produce or acquire a product before any markup."147 }148 },149 "required": [150 "transfer",151 "effective",152 "marked",153 "currency"154 ]155 },156 "store": {157 "type": "object",158 "description": "Information about the store selling the product.",159 "properties": {160 "id": {161 "type": "integer",162 "description": "Unique identifier for the store."163 }164 },165 "required": [166 "id"167 ]168 },169 "is_set": {170 "type": "boolean",171 "description": "Indicates if the product is sold as part of a set."172 },173 "weight": {174 "type": "object",175 "description": "Weight details of the product.",176 "properties": {177 "unit": {178 "type": "string",179 "description": "Unit of weight measurement (e.g., kg, lbs)."180 },181 "shipping": {182 "type": "number",183 "description": "Shipping weight of the product."184 },185 "is_default": {186 "type": "boolean",187 "description": "Indicates if this is the default weight configuration."188 }189 },190 "required": [191 "unit",192 "shipping"193 ]194 },195 "company": {196 "type": "object",197 "description": "Information about the company producing or selling the product.",198 "properties": {199 "id": {200 "type": "integer",201 "description": "Unique identifier for the company."202 }203 },204 "required": [205 "id"206 ]207 },208 "item_id": {209 "type": "integer",210 "description": "Unique identifier for the item."211 },212 "date_meta": {213 "type": "object",214 "description": "Timestamps for important events in the product's lifecycle.",215 "properties": {216 "created_on": {217 "type": "string",218 "format": "date-time",219 "description": "Date and time when the product was first created."220 },221 "modified_on": {222 "type": "string",223 "format": "date-time",224 "description": "Last modification timestamp of the product inventory details."225 },226 "added_on_store": {227 "type": "string",228 "format": "date-time",229 "description": "Date and time when the product was added to the store."230 },231 "inventory_updated_on": {232 "type": "string",233 "format": "date-time",234 "description": "Last inventory update timestamp."235 }236 },237 "required": [238 "modified_on"239 ]240 },241 "dimension": {242 "type": "object",243 "description": "Dimension details of the product.",244 "properties": {245 "unit": {246 "type": "string",247 "description": "Unit of dimension measurement (e.g., cm, inches)."248 },249 "width": {250 "type": "number",251 "description": "Width of the product."252 },253 "height": {254 "type": "number",255 "description": "Height of the product."256 },257 "length": {258 "type": "number",259 "description": "Length of the product."260 },261 "is_default": {262 "type": "boolean",263 "description": "Indicates if these are the default dimensions."264 }265 },266 "required": [267 "unit",268 "height",269 "width",270 "length"271 ]272 },273 "is_active": {274 "type": "boolean",275 "description": "Indicates if the product is currently active (available for sale)."276 },277 "identifier": {278 "type": "object",279 "additionalProperties": true,280 "description": "Product-specific identifier details."281 },282 "quantities": {283 "type": "object",284 "description": "Information about product quantities, including available and unavailable stock.",285 "properties": {286 "damaged": {287 "type": "object",288 "description": "Details of damaged stock.",289 "properties": {290 "count": {291 "type": "integer",292 "description": "Number of damaged units."293 },294 "updated_at": {295 "type": "string",296 "description": "Timestamp of the last damaged stock update."297 }298 },299 "required": [300 "count",301 "updated_at"302 ]303 },304 "sellable": {305 "type": "object",306 "description": "Sellable stock information.",307 "properties": {308 "count": {309 "type": "integer",310 "description": "Number of sellable units available."311 },312 "updated_at": {313 "type": "string",314 "description": "Timestamp of the last sellable stock update."315 }316 },317 "required": [318 "count",319 "updated_at"320 ]321 },322 "not_available": {323 "type": "object",324 "description": "Information about unavailable stock.",325 "properties": {326 "count": {327 "type": "integer",328 "description": "Number of unavailable units."329 },330 "updated_at": {331 "type": "string",332 "description": "Timestamp of the last unavailable stock update."333 }334 },335 "required": [336 "count",337 "updated_at"338 ]339 },340 "order_committed": {341 "type": "object",342 "description": "Details of committed orders.",343 "properties": {344 "count": {345 "type": "integer",346 "description": "Number of units committed to orders."347 },348 "updated_at": {349 "type": "string",350 "description": "Timestamp of the last order committed update."351 }352 }353 }354 },355 "required": [356 "sellable"357 ]358 },359 "_custom_json": {360 "type": "object",361 "description": "Custom JSON data associated with the product."362 },363 "trader": {364 "type": "array",365 "description": "List of traders associated with the product.",366 "items": {367 "type": "object",368 "properties": {369 "name": {370 "type": "string",371 "description": "Trader's name."372 },373 "type": {374 "type": "string",375 "enum": [376 "Manufacturer",377 "Importer",378 "Packer",379 "Marketer"380 ],381 "description": "Indicates the trader type."382 },383 "address": {384 "type": "array",385 "description": "List of addresses associated with the trader.",386 "items": {387 "type": "string"388 }389 }390 }391 }392 },393 "manufacturer": {394 "type": "object",395 "description": "Information about the product's manufacturer.",396 "properties": {397 "name": {398 "type": "string",399 "description": "Manufacturer's name."400 },401 "address": {402 "type": "string",403 "description": "Manufacturer's physical address."404 },405 "is_default": {406 "type": "boolean",407 "description": "Indicates if this is the default manufacturer for the product."408 }409 },410 "required": [411 "name",412 "address"413 ]414 },415 "return_config": {416 "type": "object",417 "description": "Return policy configuration for the product.",418 "properties": {419 "unit": {420 "type": "string",421 "enum": [422 "days",423 "hours"424 ],425 "description": "Time unit for the return period (either days or hours)."426 },427 "time": {428 "type": "integer",429 "description": "Duration within which the product can be returned."430 },431 "returnable": {432 "type": "boolean",433 "description": "Indicates if the product is returnable."434 }435 },436 "required": [437 "returnable"438 ]439 },440 "fynd_item_code": {441 "type": "string",442 "description": "Fynd's unique internal code for the product."443 },444 "tax_identifier": {445 "type": "object",446 "description": "Tax-related identification for the product.",447 "properties": {448 "tax_rule_id": {449 "type": "string",450 "description": "Tax rule id"451 },452 "hsn_code_id": {453 "type": [454 "string",455 "null"456 ],457 "description": "HSN code id"458 }459 }460 },461 "hs_code": {462 "type": [463 "string",464 "null"465 ],466 "description": "Harmonized System (HS) code for the product."467 },468 "total_quantity": {469 "type": "integer",470 "description": "Total quantity available for the product."471 },472 "expiration_date": {473 "type": "string",474 "description": "Expiration or validity end date for the product."475 },476 "track_inventory": {477 "type": "boolean",478 "description": "Indicates if inventory tracking is enabled for the product."479 },480 "country_of_origin": {481 "type": "string",482 "description": "Country where the product was manufactured or originated."483 },484 "stage": {485 "type": "string",486 "description": "Current stage of the product lifecycle (e.g., verified)."487 },488 "set": {489 "type": "object",490 "description": "Configuration of the set, if the product is sold as one.",491 "properties": {492 "quantity": {493 "type": "integer",494 "description": "Total number of items in the set."495 },496 "size_distribution": {497 "type": "object",498 "description": "Size distribution details within the set.",499 "properties": {500 "sizes": {501 "type": "array",502 "description": "List of sizes and their respective quantities.",503 "items": {504 "type": "object",505 "properties": {506 "size": {507 "type": "string",508 "description": "Label of the size (e.g., S, M, L)."509 },510 "pieces": {511 "type": "integer",512 "description": "Quantity of pieces for the corresponding size."513 }514 }515 }516 }517 }518 }519 }520 },521 "seller_identifier": {522 "type": "string",523 "description": "Unique identifier used by the seller for the product."524 },525 "trace_id": {526 "type": "string",527 "description": "internal trace_id for Fynd Platform services"528 },529 "tags": {530 "type": "array",531 "description": "Tags or labels assigned to the product for categorization or search purposes.",532 "items": {533 "type": "string"534 }535 },536 "modified_by": {537 "type": "object",538 "description": "Details of the user who modified the product inventory.",539 "properties": {540 "user_id": {541 "type": "string",542 "description": "User ID of the modifier."543 }544 }545 },546 "created_by": {547 "type": "object",548 "description": "Details of the user who added/created the product inventory.",549 "properties": {550 "user_id": {551 "type": "string",552 "description": "User ID of the creator."553 }554 }555 }556 }557 }558 }559 }560 }561 }562}
Payload Example
1{2 "company_id": 61,3 "contains": [4 "articles"5 ],6 "event": {7 "category": "company",8 "created_timestamp": 1711552926254,9 "id": "TnDwx8zqahrSj4ZoX7pGG0wqnchYTJt9BduujJ+RM2M=",10 "name": "article",11 "trace_id": [12 "silverbolt.c5576594-ec4d-11ee-ba7a-36c24ca45877"13 ],14 "type": "delete",15 "version": "1"16 },17 "payload": {18 "articles": [19 {20 "_custom_json": {},21 "brand": {22 "id": 355923 },24 "company": {25 "id": 6126 },27 "country_of_origin": "India",28 "date_meta": {29 "added_on_store": "2024-03-27 15:20:48.796000",30 "created_on": "2024-03-27 15:20:48.787000",31 "inventory_updated_on": "2024-03-27 15:20:48.787000",32 "modified_on": "2024-03-27 15:21:26.432000"33 },34 "dimension": {35 "height": 5,36 "length": 5,37 "unit": "cm",38 "width": 539 },40 "expiration_date": "9998-01-30 23:59:00",41 "fynd_item_code": "DSJHJJKSVD",42 "id": "6604399e1d962a270d7bf31b",43 "identifier": {44 "ean": "SDVKJNSVD"45 },46 "is_active": true,47 "is_set": false,48 "item_id": 10198724,49 "manufacturer": {50 "address": "FYND, KONDIVITA, MAHARASHTRA, MUMBAI",51 "name": "FUCHSIA VINE DESIGNS PRIVATE LIMITED"52 },53 "price": {54 "currency": "INR",55 "effective": 50000,56 "marked": 100000,57 "transfer": 058 },59 "quantities": {60 "sellable": {61 "count": 10000,62 "updated_at": "2024-03-27 15:20:48.787000"63 }64 },65 "return_config": {66 "returnable": false,67 "time": 0,68 "unit": "days"69 },70 "seller_identifier": "SDVKJNSVD",71 "size": "OS",72 "stage": "verified",73 "store": {74 "id": 1541175 },76 "tags": [],77 "tax_identifier": {78 "tax_rule_id": "65fd783dc528d7515782df49",79 "hsn_code_id": "65fd783dc528d7515782df49"80 },81 "hs_code": "124",82 "total_quantity": 10000,83 "trace_id": "inventory.9727cd26-ec4d-11ee-bd11-aa1ad4821f40",84 "track_inventory": true,85 "uid": "15411_SDVKJNSVD",86 "weight": {87 "shipping": 5,88 "unit": "gram"89 }90 }91 ]92 }93}