Application
Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.
Events
application/article/create/v1
# this event is triggered when article is created
application/article/update/v1
# this event is triggered when article is updated
application/article/delete/v1
# this event is triggered when article is deleted
Payload
Hide
application_id
array of string
Required
sales channel ID for which this event is triggered
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 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": "array",13 "items": {14 "type": "string"15 },16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "articles"78 ],79 "properties": {80 "articles": {81 "type": "array",82 "items": {83 "type": "object",84 "required": [85 "id",86 "uid",87 "size",88 "brand",89 "price",90 "store",91 "is_set",92 "weight",93 "company",94 "item_id",95 "date_meta",96 "dimension",97 "is_active",98 "identifier",99 "quantities",100 "manufacturer",101 "return_config",102 "fynd_item_code",103 "tax_identifier",104 "total_quantity",105 "track_inventory",106 "country_of_origin",107 "seller_identifier"108 ],109 "properties": {110 "id": {111 "type": "string",112 "description": "Unique identifier for the article."113 },114 "uid": {115 "type": "string",116 "description": "Combination of item code and store ID to uniquely identify the article."117 },118 "size": {119 "type": "string",120 "description": "Product size (e.g., S, M, L, XL)."121 },122 "brand": {123 "type": "object",124 "description": "Details about the product's brand.",125 "properties": {126 "id": {127 "type": "integer",128 "description": "Unique identifier for the brand."129 }130 }131 },132 "price": {133 "type": "object",134 "description": "Pricing details of the product, including various price types.",135 "properties": {136 "transfer": {137 "type": "number",138 "description": "Transfer price of the product."139 },140 "effective": {141 "type": "number",142 "description": "Final price after applying discounts."143 },144 "currency": {145 "type": "string",146 "description": "Currency used for the product's pricing (e.g., USD, EUR)."147 },148 "marked": {149 "type": "number",150 "description": "Marked price or original listed price of the product."151 },152 "updated_at": {153 "type": "string",154 "format": "date-time",155 "description": "Date and time when the pricing information was last updated."156 }157 },158 "required": [159 "transfer",160 "effective",161 "currency",162 "marked"163 ]164 },165 "store": {166 "type": "object",167 "description": "Information about the store selling the product.",168 "properties": {169 "id": {170 "type": "integer",171 "description": "Unique identifier for the store."172 }173 }174 },175 "is_set": {176 "type": "boolean",177 "description": "Indicates if the product is sold as part of a set."178 },179 "set": {180 "type": "object",181 "description": "Configuration of the set, if the product is sold as one.",182 "properties": {183 "quantity": {184 "type": "integer",185 "description": "Total number of items in the set."186 },187 "size_distribution": {188 "type": "object",189 "description": "Size distribution details within the set.",190 "properties": {191 "sizes": {192 "type": "array",193 "description": "List of sizes and their respective quantities.",194 "items": {195 "type": "object",196 "properties": {197 "size": {198 "type": "string",199 "description": "Label of the size (e.g., S, M, L)."200 },201 "pieces": {202 "type": "integer",203 "description": "Quantity of pieces for the corresponding size."204 }205 }206 }207 }208 }209 }210 }211 },212 "weight": {213 "type": "object",214 "description": "Weight details of the product.",215 "properties": {216 "unit": {217 "type": "string",218 "description": "Unit of weight measurement (e.g., kg, lbs)."219 },220 "shipping": {221 "type": "number",222 "description": "Shipping weight of the product."223 },224 "is_default": {225 "type": "boolean",226 "description": "Indicates if this is the default weight configuration."227 }228 }229 },230 "company": {231 "type": "object",232 "description": "Information about the company producing or selling the product.",233 "properties": {234 "id": {235 "type": "integer",236 "description": "Unique identifier for the company."237 }238 }239 },240 "item_id": {241 "type": "integer",242 "description": "Unique identifier for the item."243 },244 "date_meta": {245 "type": "object",246 "description": "Timestamps for important events in the product's lifecycle.",247 "properties": {248 "created_on": {249 "type": "string",250 "format": "date-time",251 "description": "Date and time when the product was first created."252 },253 "modified_on": {254 "type": "string",255 "format": "date-time",256 "description": "Last modification timestamp of the product inventory details."257 },258 "added_on_store": {259 "type": "string",260 "format": "date-time",261 "description": "Date and time when the product was added to the store."262 },263 "inventory_updated_on": {264 "type": "string",265 "format": "date-time",266 "description": "Last inventory update timestamp."267 }268 }269 },270 "quantities": {271 "type": "object",272 "description": "Information about product quantities, including available and unavailable stock.",273 "properties": {274 "sellable": {275 "type": "object",276 "description": "Sellable stock information.",277 "properties": {278 "count": {279 "type": "integer",280 "description": "Number of sellable units available."281 },282 "updated_at": {283 "type": "string",284 "description": "Timestamp of the last sellable stock update."285 }286 }287 },288 "damaged": {289 "type": "object",290 "description": "Details of damaged stock.",291 "properties": {292 "count": {293 "type": "integer",294 "description": "Number of damaged units."295 },296 "updated_at": {297 "type": "string",298 "description": "Timestamp of the last damaged stock update."299 }300 }301 },302 "not_available": {303 "type": "object",304 "description": "Information about unavailable stock.",305 "properties": {306 "count": {307 "type": "integer",308 "description": "Number of unavailable units."309 },310 "updated_at": {311 "type": "string",312 "description": "Timestamp of the last unavailable stock update."313 }314 }315 },316 "order_committed": {317 "type": "object",318 "description": "Details of committed orders.",319 "properties": {320 "count": {321 "type": "integer",322 "description": "Number of units committed to orders."323 },324 "updated_at": {325 "type": "string",326 "description": "Timestamp of the last order committed update."327 }328 }329 }330 }331 },332 "manufacturer": {333 "type": "object",334 "description": "Information about the product's manufacturer.",335 "properties": {336 "name": {337 "type": "string",338 "description": "Manufacturer's name."339 },340 "address": {341 "type": "string",342 "description": "Manufacturer's physical address."343 },344 "is_default": {345 "type": "boolean",346 "description": "Indicates if this is the default manufacturer for the product."347 }348 }349 },350 "dimension": {351 "type": "object",352 "description": "Dimension details of the product.",353 "properties": {354 "unit": {355 "type": "string",356 "description": "Unit of dimension measurement (e.g., cm, inches)."357 },358 "height": {359 "type": "number",360 "description": "Height of the product."361 },362 "width": {363 "type": "number",364 "description": "Width of the product."365 },366 "length": {367 "type": "number",368 "description": "Length of the product."369 },370 "is_default": {371 "type": "boolean",372 "description": "Indicates if these are the default dimensions."373 }374 }375 },376 "is_active": {377 "type": "boolean",378 "description": "Indicates if the product is currently active (available for sale)."379 },380 "identifier": {381 "type": "object",382 "additionalProperties": true,383 "description": "Product-specific identifier details."384 },385 "return_config": {386 "type": "object",387 "description": "Return policy configuration for the product.",388 "properties": {389 "unit": {390 "type": "string",391 "enum": [392 "days",393 "hours"394 ],395 "description": "Time unit for the return period (either days or hours)."396 },397 "time": {398 "type": "integer",399 "description": "Duration within which the product can be returned."400 },401 "returnable": {402 "type": "boolean",403 "description": "Indicates if the product is returnable."404 }405 },406 "required": [407 "returnable"408 ]409 },410 "fynd_item_code": {411 "type": "string",412 "description": "Fynd's unique internal code for the product."413 },414 "expiration_date": {415 "type": "string",416 "description": "Expiration or validity end date for the product."417 },418 "trace_id": {419 "type": [420 "string",421 "null"422 ],423 "description": "Trace ID used for event tracking or debugging."424 },425 "tax_identifier": {426 "type": "object",427 "description": "Tax-related identification for the product.",428 "properties": {429 "hsn_code_id": {430 "type": [431 "string",432 "null"433 ],434 "description": "HSN (Harmonized System of Nomenclature) code identifier."435 },436 "tax_rule_id": {437 "type": "string",438 "description": "Tax rule id attached to the product"439 }440 }441 },442 "total_quantity": {443 "type": "integer",444 "description": "Total quantity available for the product."445 },446 "track_inventory": {447 "type": "boolean",448 "description": "Indicates if inventory tracking is enabled for the product."449 },450 "country_of_origin": {451 "type": "string",452 "description": "Country where the product was manufactured or originated."453 },454 "seller_identifier": {455 "type": "string",456 "description": "Unique identifier used by the seller for the product."457 },458 "discount_meta": {459 "type": "object",460 "description": "Details of any discounts, including start/end times and countdown timers.",461 "properties": {462 "start": {463 "type": "string",464 "format": "date-time",465 "description": "Start date and time of the discount period."466 },467 "end": {468 "type": "string",469 "format": "date-time",470 "description": "End date and time of the discount period."471 },472 "timer": {473 "type": "boolean",474 "description": "Indicates if a countdown timer is active for the discount."475 }476 }477 },478 "stage": {479 "type": "string",480 "description": "Current stage of the product lifecycle (e.g., verified)."481 },482 "trader": {483 "type": "array",484 "description": "List of traders associated with the product.",485 "items": {486 "type": "object",487 "properties": {488 "name": {489 "type": "string",490 "description": "Trader's name."491 },492 "type": {493 "type": "string",494 "enum": [495 "Manufacturer",496 "Importer",497 "Packer",498 "Marketer"499 ],500 "description": "Indicates the trader type."501 },502 "address": {503 "type": "array",504 "description": "List of addresses associated with the trader.",505 "items": {506 "type": "string"507 }508 }509 }510 }511 },512 "_custom_json": {513 "type": "object",514 "description": "Custom JSON data associated with the product."515 },516 "tags": {517 "type": "array",518 "description": "Tags or labels assigned to the product for categorization or search purposes.",519 "items": {520 "type": "string"521 }522 },523 "_id": {524 "type": "string",525 "description": "Unique identifier for the article."526 }527 }528 }529 }530 }531 }532 }533}
Payload Example
1{2 "application_id": [3 "62f3534be05785303e429c98",4 "*"5 ],6 "company_id": 3932,7 "contains": [8 "articles"9 ],10 "event": {11 "category": "application",12 "created_timestamp": 1712212445994,13 "id": "JFCqL1nuxxiS9SIoC3dIULvsAXKOZUwDHUuU46bPpPo=",14 "name": "article",15 "trace_id": [16 "wildrider.55bd6700-f24d-11ee-8169-82436bb202a2"17 ],18 "type": "create",19 "version": "1"20 },21 "payload": {22 "articles": [23 {24 "brand": {25 "id": 41426 },27 "company": {28 "id": 393229 },30 "country_of_origin": "India",31 "date_meta": {32 "added_on_store": "2024-04-04 06:34:05.304981+00:00",33 "created_on": "2024-04-04 06:34:05.297180",34 "inventory_updated_on": "2024-04-04 06:34:05.297180",35 "modified_on": "2024-04-04 06:34:05.297180"36 },37 "dimension": {38 "height": 5,39 "length": 33,40 "unit": "cm",41 "width": 2542 },43 "expiration_date": "9998-01-30 23:59:00",44 "fynd_item_code": "MFT-28702-Q-86-TINTED",45 "id": "",46 "identifier": {47 "ean": "8905310277611"48 },49 "is_active": true,50 "is_set": false,51 "item_id": 8684980,52 "manufacturer": {53 "address": "test",54 "name": "Credo Brands Marketing Limited"55 },56 "price": {57 "currency": "INR",58 "effective": 4199,59 "marked": 4199,60 "transfer": 061 },62 "quantities": {63 "damaged": {},64 "not_available": {},65 "sellable": {66 "count": 1,67 "updated_at": "2024-04-04 06:34:05.297180"68 }69 },70 "return_config": {71 "returnable": true,72 "time": 30,73 "unit": "days"74 },75 "seller_identifier": "8905310277611",76 "size": "36",77 "stage": "verified",78 "store": {79 "id": 2363080 },81 "tax_identifier": {82 "hsn_code_id": "6277838c5e4c6fdbc8be402d",83 "tax_rule_id": "6277838c5e4c6fdbc8be402d"84 },85 "total_quantity": 1,86 "trace_id": "inventory.554e43c0-f24d-11ee-8928-aebf396206f1",87 "track_inventory": true,88 "uid": "23630_8905310277611",89 "trader": [90 {91 "type": "Manufacturer",92 "name": "random",93 "address": [94 "random"95 ]96 }97 ],98 "tags": [99 "tag1",100 "tag2"101 ],102 "weight": {103 "shipping": 600,104 "unit": "gram"105 }106 }107 ]108 }109}
Payload
Hide
application_id
array of string
Required
sales channel ID for which this event is triggered
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 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": "array",13 "items": {14 "type": "string"15 },16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "articles"78 ],79 "properties": {80 "articles": {81 "type": "array",82 "items": {83 "type": "object",84 "properties": {85 "id": {86 "type": "string",87 "description": "Unique identifier for the article."88 },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 },107 "price": {108 "type": "object",109 "description": "Pricing details of the product, including various price types.",110 "properties": {111 "transfer": {112 "type": "number",113 "description": "Transfer price of the product."114 },115 "effective": {116 "type": "number",117 "description": "Final price after applying discounts."118 },119 "currency": {120 "type": "string",121 "description": "Currency used for the product's pricing (e.g., USD, EUR)."122 },123 "marked": {124 "type": "number",125 "description": "Marked price or original listed price of the product."126 },127 "updated_at": {128 "type": "string",129 "format": "date-time",130 "description": "Date and time when the pricing information was last updated."131 }132 },133 "required": [134 "transfer",135 "effective",136 "currency",137 "marked"138 ]139 },140 "store": {141 "type": "object",142 "description": "Information about the store selling the product.",143 "properties": {144 "id": {145 "type": "integer",146 "description": "Unique identifier for the store."147 }148 }149 },150 "is_set": {151 "type": "boolean",152 "description": "Indicates if the product is sold as part of a set."153 },154 "set": {155 "type": "object",156 "description": "Configuration of the set, if the product is sold as one.",157 "properties": {158 "quantity": {159 "type": "integer",160 "description": "Total number of items in the set."161 },162 "size_distribution": {163 "type": "object",164 "description": "Size distribution details within the set.",165 "properties": {166 "sizes": {167 "type": "array",168 "description": "List of sizes and their respective quantities.",169 "items": {170 "type": "object",171 "properties": {172 "size": {173 "type": "string",174 "description": "Label of the size (e.g., S, M, L)."175 },176 "pieces": {177 "type": "integer",178 "description": "Quantity of pieces for the corresponding size."179 }180 }181 }182 }183 }184 }185 }186 },187 "weight": {188 "type": "object",189 "description": "Weight details of the product.",190 "properties": {191 "unit": {192 "type": "string",193 "description": "Unit of weight measurement (e.g., kg, lbs)."194 },195 "shipping": {196 "type": "number",197 "description": "Shipping weight of the product."198 },199 "is_default": {200 "type": "boolean",201 "description": "Indicates if this is the default weight configuration."202 }203 }204 },205 "company": {206 "type": "object",207 "description": "Information about the company producing or selling the product.",208 "properties": {209 "id": {210 "type": "integer",211 "description": "Unique identifier for the company."212 }213 }214 },215 "item_id": {216 "type": "integer",217 "description": "Unique identifier for the item."218 },219 "date_meta": {220 "type": "object",221 "description": "Timestamps for important events in the product's lifecycle.",222 "properties": {223 "created_on": {224 "type": "string",225 "format": "date-time",226 "description": "Date and time when the product was first created."227 },228 "modified_on": {229 "type": "string",230 "format": "date-time",231 "description": "Last modification timestamp of the product inventory details."232 },233 "added_on_store": {234 "type": "string",235 "format": "date-time",236 "description": "Date and time when the product was added to the store."237 },238 "inventory_updated_on": {239 "type": "string",240 "format": "date-time",241 "description": "Last inventory update timestamp."242 }243 }244 },245 "quantities": {246 "type": "object",247 "description": "Information about product quantities, including available and unavailable stock.",248 "properties": {249 "sellable": {250 "type": "object",251 "description": "Sellable stock information.",252 "properties": {253 "count": {254 "type": "integer",255 "description": "Number of sellable units available."256 },257 "updated_at": {258 "type": "string",259 "description": "Timestamp of the last sellable stock update."260 }261 }262 },263 "damaged": {264 "type": "object",265 "description": "Details of damaged stock.",266 "properties": {267 "count": {268 "type": "integer",269 "description": "Number of damaged units."270 },271 "updated_at": {272 "type": "string",273 "description": "Timestamp of the last damaged stock update."274 }275 }276 },277 "not_available": {278 "type": "object",279 "description": "Information about unavailable stock.",280 "properties": {281 "count": {282 "type": "integer",283 "description": "Number of unavailable units."284 },285 "updated_at": {286 "type": "string",287 "description": "Timestamp of the last unavailable stock update."288 }289 }290 },291 "order_committed": {292 "type": "object",293 "description": "Details of committed orders.",294 "properties": {295 "count": {296 "type": "integer",297 "description": "Number of units committed to orders."298 },299 "updated_at": {300 "type": "string",301 "description": "Timestamp of the last order committed update."302 }303 }304 }305 }306 },307 "manufacturer": {308 "type": "object",309 "description": "Information about the product's manufacturer.",310 "properties": {311 "name": {312 "type": "string",313 "description": "Manufacturer's name."314 },315 "address": {316 "type": "string",317 "description": "Manufacturer's physical address."318 },319 "is_default": {320 "type": "boolean",321 "description": "Indicates if this is the default manufacturer for the product."322 }323 }324 },325 "dimension": {326 "type": "object",327 "description": "Dimension details of the product.",328 "properties": {329 "unit": {330 "type": "string",331 "description": "Unit of dimension measurement (e.g., cm, inches)."332 },333 "height": {334 "type": "number",335 "description": "Height of the product."336 },337 "width": {338 "type": "number",339 "description": "Width of the product."340 },341 "length": {342 "type": "number",343 "description": "Length of the product."344 },345 "is_default": {346 "type": "boolean",347 "description": "Indicates if these are the default dimensions."348 }349 }350 },351 "is_active": {352 "type": "boolean",353 "description": "Indicates if the product is currently active (available for sale)."354 },355 "identifier": {356 "type": "object",357 "additionalProperties": true,358 "description": "Product-specific identifier details."359 },360 "return_config": {361 "type": "object",362 "description": "Return policy configuration for the product.",363 "properties": {364 "unit": {365 "type": "string",366 "enum": [367 "days",368 "hours"369 ],370 "description": "Time unit for the return period (either days or hours)."371 },372 "time": {373 "type": "integer",374 "description": "Duration within which the product can be returned."375 },376 "returnable": {377 "type": "boolean",378 "description": "Indicates if the product is returnable."379 }380 },381 "required": [382 "returnable"383 ]384 },385 "fynd_item_code": {386 "type": "string",387 "description": "Fynd's unique internal code for the product."388 },389 "expiration_date": {390 "type": "string",391 "description": "Expiration or validity end date for the product."392 },393 "trace_id": {394 "type": [395 "string",396 "null"397 ],398 "description": "Trace ID used for event tracking or debugging."399 },400 "tax_identifier": {401 "type": "object",402 "description": "Tax-related identification for the product.",403 "properties": {404 "hsn_code_id": {405 "type": [406 "string",407 "null"408 ],409 "description": "HSN (Harmonized System of Nomenclature) code identifier."410 },411 "tax_rule_id": {412 "type": "string",413 "description": "Tax rule id attached to the product"414 }415 }416 },417 "total_quantity": {418 "type": "integer",419 "description": "Total quantity available for the product."420 },421 "track_inventory": {422 "type": "boolean",423 "description": "Indicates if inventory tracking is enabled for the product."424 },425 "country_of_origin": {426 "type": "string",427 "description": "Country where the product was manufactured or originated."428 },429 "seller_identifier": {430 "type": "string",431 "description": "Unique identifier used by the seller for the product."432 },433 "discount_meta": {434 "type": "object",435 "description": "Details of any discounts, including start/end times and countdown timers.",436 "properties": {437 "start": {438 "type": "string",439 "format": "date-time",440 "description": "Start date and time of the discount period."441 },442 "end": {443 "type": "string",444 "format": "date-time",445 "description": "End date and time of the discount period."446 },447 "timer": {448 "type": "boolean",449 "description": "Indicates if a countdown timer is active for the discount."450 }451 }452 },453 "stage": {454 "type": "string",455 "description": "Current stage of the product lifecycle (e.g., verified)."456 },457 "trader": {458 "type": "array",459 "description": "List of traders associated with the product.",460 "items": {461 "type": "object",462 "properties": {463 "name": {464 "type": "string",465 "description": "Trader's name."466 },467 "type": {468 "type": "string",469 "enum": [470 "Manufacturer",471 "Importer",472 "Packer",473 "Marketer"474 ],475 "description": "Indicates the trader type."476 },477 "address": {478 "type": "array",479 "description": "List of addresses associated with the trader.",480 "items": {481 "type": "string"482 }483 }484 }485 }486 },487 "_custom_json": {488 "type": "object",489 "properties": {490 "child_details": {491 "type": "array",492 "description": "Details about child products if the article is a parent product.",493 "items": {494 "type": "object"495 }496 }497 },498 "description": "Custom JSON data associated with the product."499 },500 "tags": {501 "type": "array",502 "description": "Tags or labels assigned to the product for categorization or search purposes.",503 "items": {504 "type": "string"505 }506 },507 "_id": {508 "type": "string",509 "description": "Unique identifier for the article."510 }511 }512 }513 }514 }515 }516 }517}
Payload Example
1{2 "application_id": [3 "625e5411d6a31365b571800a",4 "*"5 ],6 "company_id": 2411,7 "contains": [8 "articles"9 ],10 "event": {11 "category": "application",12 "created_timestamp": 1712143541216,13 "id": "eCbEMUrjwV8UnqXRzSbRcCBj8hKZCc3rvqPxIXTZ2rE=",14 "name": "article",15 "trace_id": [16 "wildrider.e74aa68e-f1ac-11ee-aa5c-ca65ee4ea81f"17 ],18 "type": "update",19 "version": "1"20 },21 "payload": {22 "articles": [23 {24 "brand": {25 "id": 7526 },27 "company": {28 "id": 241129 },30 "country_of_origin": "India",31 "date_meta": {32 "added_on_store": "test",33 "created_on": "test",34 "inventory_updated_on": "2024-04-03 11:25:38.723172",35 "modified_on": "2024-04-03 11:25:38.723172"36 },37 "dimension": {38 "height": 10,39 "length": 10,40 "unit": "cm",41 "width": 1042 },43 "expiration_date": "9998-01-30 23:59:00",44 "fynd_item_code": "MCOP00015_SKYBLUE",45 "trader": [46 {47 "type": "Manufacturer",48 "name": "random",49 "address": [50 "random"51 ]52 }53 ],54 "tags": [55 "tag1",56 "tag2"57 ],58 "id": "65a5464cd8f9933845050737",59 "identifier": {60 "sku_code": "MCOP00015_SKYBLUE_40"61 },62 "is_active": true,63 "is_set": false,64 "item_id": 8609293,65 "manufacturer": {66 "address": "test,tesst Delhite",67 "name": "Cantabil Retail India Limited"68 },69 "price": {70 "currency": "INR",71 "effective": 7999,72 "marked": 7999,73 "transfer": 074 },75 "quantities": {76 "damaged": {77 "count": 0,78 "updated_at": "2024-04-03 11:25:38.723172"79 },80 "not_available": {81 "count": 0,82 "updated_at": "2024-04-03 11:25:38.723172"83 },84 "sellable": {85 "count": 0,86 "updated_at": "2024-04-03 11:25:38.723172"87 }88 },89 "return_config": {90 "returnable": true,91 "time": 7,92 "unit": "days"93 },94 "seller_identifier": "MCOP00015_SKYBLUE_40",95 "size": "40/1.02M",96 "stage": "verified",97 "store": {98 "id": 1585699 },100 "tax_identifier": {101 "hsn_code_id": "6277838c5e4c6fdbc8be4027",102 "tax_rule_id": "6277838c5e4c6fdbc8be402d"103 },104 "total_quantity": 0,105 "trace_id": "test",106 "track_inventory": true,107 "uid": "15856_MCOP00015_SKYBLUE_40",108 "weight": {109 "shipping": 250,110 "unit": "gram"111 }112 }113 ]114 }115}
Payload
Hide
application_id
array of string
Required
sales channel ID for which this event is triggered
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 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": "array",13 "items": {14 "type": "string"15 },16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "articles"78 ],79 "properties": {80 "articles": {81 "type": "array",82 "items": {83 "type": "object",84 "properties": {85 "id": {86 "type": "string",87 "description": "Unique identifier for the article."88 },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 },107 "price": {108 "type": "object",109 "description": "Pricing details of the product, including various price types.",110 "properties": {111 "transfer": {112 "type": "number",113 "description": "Transfer price of the product."114 },115 "effective": {116 "type": "number",117 "description": "Final price after applying discounts."118 },119 "currency": {120 "type": "string",121 "description": "Currency used for the product's pricing (e.g., USD, EUR)."122 },123 "marked": {124 "type": "number",125 "description": "Marked price or original listed price of the product."126 },127 "updated_at": {128 "type": "string",129 "format": "date-time",130 "description": "Date and time when the pricing information was last updated."131 }132 },133 "required": [134 "transfer",135 "effective",136 "currency",137 "marked"138 ]139 },140 "store": {141 "type": "object",142 "description": "Information about the store selling the product.",143 "properties": {144 "id": {145 "type": "integer",146 "description": "Unique identifier for the store."147 }148 }149 },150 "is_set": {151 "type": "boolean",152 "description": "Indicates if the product is sold as part of a set."153 },154 "set": {155 "type": "object",156 "description": "Configuration of the set, if the product is sold as one.",157 "properties": {158 "quantity": {159 "type": "integer",160 "description": "Total number of items in the set."161 },162 "size_distribution": {163 "type": "object",164 "description": "Size distribution details within the set.",165 "properties": {166 "sizes": {167 "type": "array",168 "description": "List of sizes and their respective quantities.",169 "items": {170 "type": "object",171 "properties": {172 "size": {173 "type": "string",174 "description": "Label of the size (e.g., S, M, L)."175 },176 "pieces": {177 "type": "integer",178 "description": "Quantity of pieces for the corresponding size."179 }180 }181 }182 }183 }184 }185 }186 },187 "weight": {188 "type": "object",189 "description": "Weight details of the product.",190 "properties": {191 "unit": {192 "type": "string",193 "description": "Unit of weight measurement (e.g., kg, lbs)."194 },195 "shipping": {196 "type": "number",197 "description": "Shipping weight of the product."198 },199 "is_default": {200 "type": "boolean",201 "description": "Indicates if this is the default weight configuration."202 }203 }204 },205 "company": {206 "type": "object",207 "description": "Information about the company producing or selling the product.",208 "properties": {209 "id": {210 "type": "integer",211 "description": "Unique identifier for the company."212 }213 }214 },215 "item_id": {216 "type": "integer",217 "description": "Unique identifier for the item."218 },219 "date_meta": {220 "type": "object",221 "description": "Timestamps for important events in the product's lifecycle.",222 "properties": {223 "created_on": {224 "type": "string",225 "format": "date-time",226 "description": "Date and time when the product was first created."227 },228 "modified_on": {229 "type": "string",230 "format": "date-time",231 "description": "Last modification timestamp of the product inventory details."232 },233 "added_on_store": {234 "type": "string",235 "format": "date-time",236 "description": "Date and time when the product was added to the store."237 },238 "inventory_updated_on": {239 "type": "string",240 "format": "date-time",241 "description": "Last inventory update timestamp."242 }243 }244 },245 "quantities": {246 "type": "object",247 "description": "Information about product quantities, including available and unavailable stock.",248 "properties": {249 "sellable": {250 "type": "object",251 "description": "Sellable stock information.",252 "properties": {253 "count": {254 "type": "integer",255 "description": "Number of sellable units available."256 },257 "updated_at": {258 "type": "string",259 "description": "Timestamp of the last sellable stock update."260 }261 }262 },263 "damaged": {264 "type": "object",265 "description": "Details of damaged stock.",266 "properties": {267 "count": {268 "type": "integer",269 "description": "Number of damaged units."270 },271 "updated_at": {272 "type": "string",273 "description": "Timestamp of the last damaged stock update."274 }275 }276 },277 "not_available": {278 "type": "object",279 "description": "Information about unavailable stock.",280 "properties": {281 "count": {282 "type": "integer",283 "description": "Number of unavailable units."284 },285 "updated_at": {286 "type": "string",287 "description": "Timestamp of the last unavailable stock update."288 }289 }290 },291 "order_committed": {292 "type": "object",293 "description": "Details of committed orders.",294 "properties": {295 "count": {296 "type": "integer",297 "description": "Number of units committed to orders."298 },299 "updated_at": {300 "type": "string",301 "description": "Timestamp of the last order committed update."302 }303 }304 }305 }306 },307 "manufacturer": {308 "type": "object",309 "description": "Information about the product's manufacturer.",310 "properties": {311 "name": {312 "type": "string",313 "description": "Manufacturer's name."314 },315 "address": {316 "type": "string",317 "description": "Manufacturer's physical address."318 },319 "is_default": {320 "type": "boolean",321 "description": "Indicates if this is the default manufacturer for the product."322 }323 }324 },325 "dimension": {326 "type": "object",327 "description": "Dimension details of the product.",328 "properties": {329 "unit": {330 "type": "string",331 "description": "Unit of dimension measurement (e.g., cm, inches)."332 },333 "height": {334 "type": "number",335 "description": "Height of the product."336 },337 "width": {338 "type": "number",339 "description": "Width of the product."340 },341 "length": {342 "type": "number",343 "description": "Length of the product."344 },345 "is_default": {346 "type": "boolean",347 "description": "Indicates if these are the default dimensions."348 }349 }350 },351 "is_active": {352 "type": "boolean",353 "description": "Indicates if the product is currently active (available for sale)."354 },355 "identifier": {356 "type": "object",357 "additionalProperties": true,358 "description": "Product-specific identifier details."359 },360 "return_config": {361 "type": "object",362 "description": "Return policy configuration for the product.",363 "properties": {364 "unit": {365 "type": "string",366 "enum": [367 "days",368 "hours"369 ],370 "description": "Time unit for the return period (either days or hours)."371 },372 "time": {373 "type": "integer",374 "description": "Duration within which the product can be returned."375 },376 "returnable": {377 "type": "boolean",378 "description": "Indicates if the product is returnable."379 }380 },381 "required": [382 "returnable"383 ]384 },385 "fynd_item_code": {386 "type": "string",387 "description": "Fynd's unique internal code for the product."388 },389 "expiration_date": {390 "type": "string",391 "description": "Expiration or validity end date for the product."392 },393 "trace_id": {394 "type": [395 "string",396 "null"397 ],398 "description": "Trace ID used for event tracking or debugging."399 },400 "tax_identifier": {401 "type": "object",402 "description": "Tax-related identification for the product.",403 "properties": {404 "hsn_code_id": {405 "type": [406 "string",407 "null"408 ],409 "description": "HSN (Harmonized System of Nomenclature) code identifier."410 },411 "tax_rule_id": {412 "type": "string",413 "description": "Tax rule id attached to the product"414 }415 }416 },417 "total_quantity": {418 "type": "integer",419 "description": "Total quantity available for the product."420 },421 "track_inventory": {422 "type": "boolean",423 "description": "Indicates if inventory tracking is enabled for the product."424 },425 "country_of_origin": {426 "type": "string",427 "description": "Country where the product was manufactured or originated."428 },429 "seller_identifier": {430 "type": "string",431 "description": "Unique identifier used by the seller for the product."432 },433 "discount_meta": {434 "type": "object",435 "description": "Details of any discounts, including start/end times and countdown timers.",436 "properties": {437 "start": {438 "type": "string",439 "format": "date-time",440 "description": "Start date and time of the discount period."441 },442 "end": {443 "type": "string",444 "format": "date-time",445 "description": "End date and time of the discount period."446 },447 "timer": {448 "type": "boolean",449 "description": "Indicates if a countdown timer is active for the discount."450 }451 }452 },453 "stage": {454 "type": "string",455 "description": "Current stage of the product lifecycle (e.g., verified)."456 },457 "trader": {458 "type": "array",459 "description": "List of traders associated with the product.",460 "items": {461 "type": "object",462 "properties": {463 "name": {464 "type": "string",465 "description": "Trader's name."466 },467 "type": {468 "type": "string",469 "enum": [470 "Manufacturer",471 "Importer",472 "Packer",473 "Marketer"474 ],475 "description": "Indicates the trader type."476 },477 "address": {478 "type": "array",479 "description": "List of addresses associated with the trader.",480 "items": {481 "type": "string"482 }483 }484 }485 }486 },487 "_custom_json": {488 "type": "object",489 "description": "Custom JSON data associated with the product."490 },491 "tags": {492 "type": "array",493 "description": "Tags or labels assigned to the product for categorization or search purposes.",494 "items": {495 "type": "string"496 }497 },498 "_id": {499 "type": "string",500 "description": "Unique identifier for the article."501 }502 }503 }504 }505 }506 }507 }508}
Payload Example
1{2 "event": {3 "trace_id": [4 "wildrider.be76f10c-edd0-11ee-9d9e-024a9286e161"5 ],6 "name": "article",7 "type": "delete",8 "version": "1",9 "created_timestamp": 1711719129951,10 "id": "qlNoqByKLeAOXIc1b1VDFX9rKHePYE7r5ryWbnylDI8=",11 "category": "application"12 },13 "company_id": 46,14 "application_id": [15 "5eafc9121cfbb666d7959353",16 "*"17 ],18 "contains": [19 "articles"20 ],21 "payload": {22 "articles": [23 {24 "id": "6606c2d8a67feaa626b48927",25 "uid": "19592_000000410243861090",26 "fynd_item_code": "M1110008A@N6I",27 "trader": [28 {29 "type": "Manufacturer",30 "name": "random",31 "address": [32 "random"33 ]34 }35 ],36 "country_of_origin": "India",37 "tags": [38 "tag1",39 "tag2"40 ],41 "seller_identifier": "000000410243861090",42 "size": "3XL",43 "item_id": 7737047,44 "total_quantity": 0,45 "track_inventory": true,46 "is_set": false,47 "is_active": true,48 "stage": "verified",49 "company": {50 "id": 4651 },52 "brand": {53 "id": 23554 },55 "store": {56 "id": 1959257 },58 "weight": {59 "unit": "gram",60 "shipping": 50061 },62 "price": {63 "transfer": 0,64 "effective": 4999,65 "currency": "INR",66 "marked": 499967 },68 "dimension": {69 "unit": "cm",70 "height": 5,71 "width": 5,72 "length": 573 },74 "return_config": {75 "unit": "days",76 "time": 30,77 "returnable": true78 },79 "date_meta": {80 "created_on": "2023-10-20 21:22:29.798000",81 "modified_on": "2024-02-06 06:57:30.271000",82 "added_on_store": "2023-10-20 21:22:29.806000",83 "inventory_updated_on": "2024-02-06 06:57:30.271000"84 },85 "quantities": {86 "sellable": {87 "count": 0,88 "updated_at": "2024-02-06 06:57:30.271000"89 },90 "damaged": {91 "count": 0,92 "updated_at": "2024-02-06 06:57:30.271000"93 },94 "not_available": {95 "count": 0,96 "updated_at": "2024-02-06 06:57:30.271000"97 }98 },99 "manufacturer": {100 "name": "Reliance Brands Limited",101 "address": "test"102 },103 "identifier": {104 "alu": "000000410243861090"105 },106 "tax_identifier": {107 "hsn_code_id": "627783825e4c6fdbc8be3f30",108 "tax_rule_id": "6277838c5e4c6fdbc8be402d"109 },110 "expiration_date": "9998-01-30 23:59:00",111 "trace_id": "inventory.a7f4481e-c4b6-11ee-937b-2aa9537f17d0"112 }113 ]114 }115}