Company

Events categorised under company level will be triggered when any action performed on company. e.g. If new brand is created.

Article

This event will be generated where there is any action done on article

Events

company/article/create/v1

# this event is triggered when article is created

company/article/delete/v1

# this event is triggered when article is deleted

company/article/update/v1

# this event is triggered when article is updated

company/article/create/v1

this event is triggered when article is created

Payload

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

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

articles

array of object

Required

Array of Properties

string

Unique identifier for the article.

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

integer

Required

Unique identifier for the brand.

price

object

Required

Pricing details of the product, including various price types.

Properties

marked

number

Required

Marked price or original listed price of the product.

currency

string

Required

Currency used for the product's pricing (e.g., USD, EUR).

transfer

number

Required

Transfer price of the product.

effective

number

Required

Final price after applying discounts.

updated_at

string

| date-time

Date and time when the pricing information was last updated.

store

object

Required

Information about the store selling the product.

Properties

integer

Required

Unique identifier for the store.

is_set

boolean

Indicates if the product is sold as part of a set.

weight

object

Required

Weight details of the product.

Properties

unit

string

Required

Unit of weight measurement (e.g., kg, lbs).

shipping

number

Required

Shipping weight of the product.

is_default

boolean

Indicates if this is the default weight configuration.

company

object

Required

Information about the company producing or selling the product.

Properties

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.

dimension

object

Required

Dimension details of the product.

Properties

unit

string

Required

Unit of dimension measurement (e.g., cm, inches).

width

number

Required

Width of the product.

height

number

Required

Height of the product.

length

number

Required

Length of the product.

is_default

boolean

Indicates if these are the default dimensions.

is_active

boolean

Indicates if the product is currently active (available for sale).

identifier

object

Required

Product-specific identifier details.

quantities

object

Information about product quantities, including available and unavailable stock.

Properties

damaged

object

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

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

Details of committed orders.

Properties

count

integer

Number of units committed to orders.

updated_at

string

Timestamp of the last order committed update.

_custom_json

object

Custom JSON data associated with the product.

trader

array of object

List of traders associated with the product.

Array of Properties

name

string

Trader's name.

type

string

Indicates the trader type.

Enum

address

array of string

List of addresses associated with the trader.

manufacturer

object

Required

Information about the product's manufacturer.

Properties

name

string

Required

Manufacturer's name.

address

string

Required

Manufacturer's physical address.

is_default

boolean

Indicates if this is the default manufacturer for the product.

return_config

object

Return policy configuration for the product.

Properties

unit

string

Time unit for the return period (either days or hours).

Enum

time

integer

Duration within which the product can be returned.

returnable

boolean

Required

Indicates if the product is returnable.

fynd_item_code

string

Required

Fynd's unique internal code for the product.

tax_identifier

object

Tax-related identification for the product.

Properties

hsn_code_id

string

HSN (Harmonized System of Nomenclature) code identifier.

total_quantity

integer

Required

Total quantity available for the product.

expiration_date

string

Expiration or validity end date for the product.

track_inventory

boolean

Indicates if inventory tracking is enabled for the product.

country_of_origin

string

Required

Country where the product was manufactured or originated.

stage

string

Current stage of the product lifecycle (e.g., verified).

set

object

Configuration of the set, if the product is sold as one.

Properties

quantity

integer

Total number of items in the set.

size_distribution

object

Size distribution details within the set.

Properties

sizes

array of object

List of sizes and their respective quantities.

Array of Properties

size

string

Label of the size (e.g., S, M, L).

pieces

integer

Quantity of pieces for the corresponding size.

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        "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                },
145                "required": [
146                  "transfer",
147                  "effective",
148                  "marked",
149                  "currency"
150                ]
151              },
152              "store": {
153                "type": "object",
154                "description": "Information about the store selling the product.",
155                "properties": {
156                  "id": {
157                    "type": "integer",
158                    "description": "Unique identifier for the store."
159                  }
160                },
161                "required": [
162                  "id"
163                ]
164              },
165              "is_set": {
166                "type": "boolean",
167                "description": "Indicates if the product is sold as part of a set."
168              },
169              "weight": {
170                "type": "object",
171                "description": "Weight details of the product.",
172                "properties": {
173                  "unit": {
174                    "type": "string",
175                    "description": "Unit of weight measurement (e.g., kg, lbs)."
176                  },
177                  "shipping": {
178                    "type": "number",
179                    "description": "Shipping weight of the product."
180                  },
181                  "is_default": {
182                    "type": "boolean",
183                    "description": "Indicates if this is the default weight configuration."
184                  }
185                },
186                "required": [
187                  "unit",
188                  "shipping"
189                ]
190              },
191              "company": {
192                "type": "object",
193                "description": "Information about the company producing or selling the product.",
194                "properties": {
195                  "id": {
196                    "type": "integer",
197                    "description": "Unique identifier for the company."
198                  }
199                },
200                "required": [
201                  "id"
202                ]
203              },
204              "item_id": {
205                "type": "integer",
206                "description": "Unique identifier for the item."
207              },
208              "date_meta": {
209                "type": "object",
210                "description": "Timestamps for important events in the product's lifecycle.",
211                "properties": {
212                  "created_on": {
213                    "type": "string",
214                    "format": "date-time",
215                    "description": "Date and time when the product was first created."
216                  },
217                  "modified_on": {
218                    "type": "string",
219                    "format": "date-time",
220                    "description": "Last modification timestamp of the product inventory details."
221                  },
222                  "added_on_store": {
223                    "type": "string",
224                    "format": "date-time",
225                    "description": "Date and time when the product was added to the store."
226                  },
227                  "inventory_updated_on": {
228                    "type": "string",
229                    "format": "date-time",
230                    "description": "Last inventory update timestamp."
231                  }
232                },
233                "required": [
234                  "modified_on"
235                ]
236              },
237              "dimension": {
238                "type": "object",
239                "description": "Dimension details of the product.",
240                "properties": {
241                  "unit": {
242                    "type": "string",
243                    "description": "Unit of dimension measurement (e.g., cm, inches)."
244                  },
245                  "width": {
246                    "type": "number",
247                    "description": "Width of the product."
248                  },
249                  "height": {
250                    "type": "number",
251                    "description": "Height of the product."
252                  },
253                  "length": {
254                    "type": "number",
255                    "description": "Length of the product."
256                  },
257                  "is_default": {
258                    "type": "boolean",
259                    "description": "Indicates if these are the default dimensions."
260                  }
261                },
262                "required": [
263                  "unit",
264                  "height",
265                  "width",
266                  "length"
267                ]
268              },
269              "is_active": {
270                "type": "boolean",
271                "description": "Indicates if the product is currently active (available for sale)."
272              },
273              "identifier": {
274                "type": "object",
275                "description": "Product-specific identifier details."
276              },
277              "quantities": {
278                "type": "object",
279                "description": "Information about product quantities, including available and unavailable stock.",
280                "properties": {
281                  "damaged": {
282                    "type": "object",
283                    "description": "Details of damaged stock.",
284                    "properties": {
285                      "count": {
286                        "type": "integer",
287                        "description": "Number of damaged units."
288                      },
289                      "updated_at": {
290                        "type": "string",
291                        "description": "Timestamp of the last damaged stock update."
292                      }
293                    },
294                    "required": [
295                      "count",
296                      "updated_at"
297                    ]
298                  },
299                  "sellable": {
300                    "type": "object",
301                    "description": "Sellable stock information.",
302                    "properties": {
303                      "count": {
304                        "type": "integer",
305                        "description": "Number of sellable units available."
306                      },
307                      "updated_at": {
308                        "type": "string",
309                        "description": "Timestamp of the last sellable stock update."
310                      }
311                    },
312                    "required": [
313                      "count",
314                      "updated_at"
315                    ]
316                  },
317                  "not_available": {
318                    "type": "object",
319                    "description": "Information about unavailable stock.",
320                    "properties": {
321                      "count": {
322                        "type": "integer",
323                        "description": "Number of unavailable units."
324                      },
325                      "updated_at": {
326                        "type": "string",
327                        "description": "Timestamp of the last unavailable stock update."
328                      }
329                    },
330                    "required": [
331                      "count",
332                      "updated_at"
333                    ]
334                  },
335                  "order_committed": {
336                    "type": "object",
337                    "description": "Details of committed orders.",
338                    "properties": {
339                      "count": {
340                        "type": "integer",
341                        "description": "Number of units committed to orders."
342                      },
343                      "updated_at": {
344                        "type": "string",
345                        "description": "Timestamp of the last order committed update."
346                      }
347                    }
348                  }
349                },
350                "required": [
351                  "sellable"
352                ]
353              },
354              "_custom_json": {
355                "type": "object",
356                "description": "Custom JSON data associated with the product."
357              },
358              "trader": {
359                "type": "array",
360                "description": "List of traders associated with the product.",
361                "items": {
362                  "type": "object",
363                  "properties": {
364                    "name": {
365                      "type": "string",
366                      "description": "Trader's name."
367                    },
368                    "type": {
369                      "type": "string",
370                      "enum": [
371                        "Manufacturer",
372                        "Importer",
373                        "Packer",
374                        "Marketer"
375                      ],
376                      "description": "Indicates the trader type."
377                    },
378                    "address": {
379                      "type": "array",
380                      "description": "List of addresses associated with the trader.",
381                      "items": {
382                        "type": "string"
383                      }
384                    }
385                  }
386                }
387              },
388              "manufacturer": {
389                "type": "object",
390                "description": "Information about the product's manufacturer.",
391                "properties": {
392                  "name": {
393                    "type": "string",
394                    "description": "Manufacturer's name."
395                  },
396                  "address": {
397                    "type": "string",
398                    "description": "Manufacturer's physical address."
399                  },
400                  "is_default": {
401                    "type": "boolean",
402                    "description": "Indicates if this is the default manufacturer for the product."
403                  }
404                },
405                "required": [
406                  "name",
407                  "address"
408                ]
409              },
410              "return_config": {
411                "type": "object",
412                "description": "Return policy configuration for the product.",
413                "properties": {
414                  "unit": {
415                    "type": "string",
416                    "enum": [
417                      "days",
418                      "hours"
419                    ],
420                    "description": "Time unit for the return period (either days or hours)."
421                  },
422                  "time": {
423                    "type": "integer",
424                    "description": "Duration within which the product can be returned."
425                  },
426                  "returnable": {
427                    "type": "boolean",
428                    "description": "Indicates if the product is returnable."
429                  }
430                },
431                "required": [
432                  "returnable"
433                ]
434              },
435              "fynd_item_code": {
436                "type": "string",
437                "description": "Fynd's unique internal code for the product."
438              },
439              "tax_identifier": {
440                "type": "object",
441                "description": "Tax-related identification for the product.",
442                "properties": {
443                  "hsn_code_id": {
444                    "type": "string",
445                    "description": "HSN (Harmonized System of Nomenclature) code identifier."
446                  }
447                }
448              },
449              "total_quantity": {
450                "type": "integer",
451                "description": "Total quantity available for the product."
452              },
453              "expiration_date": {
454                "type": "string",
455                "description": "Expiration or validity end date for the product."
456              },
457              "track_inventory": {
458                "type": "boolean",
459                "description": "Indicates if inventory tracking is enabled for the product."
460              },
461              "country_of_origin": {
462                "type": "string",
463                "description": "Country where the product was manufactured or originated."
464              },
465              "stage": {
466                "type": "string",
467                "description": "Current stage of the product lifecycle (e.g., verified)."
468              },
469              "set": {
470                "type": "object",
471                "description": "Configuration of the set, if the product is sold as one.",
472                "properties": {
473                  "quantity": {
474                    "type": "integer",
475                    "description": "Total number of items in the set."
476                  },
477                  "size_distribution": {
478                    "type": "object",
479                    "description": "Size distribution details within the set.",
480                    "properties": {
481                      "sizes": {
482                        "type": "array",
483                        "description": "List of sizes and their respective quantities.",
484                        "items": {
485                          "type": "object",
486                          "properties": {
487                            "size": {
488                              "type": "string",
489                              "description": "Label of the size (e.g., S, M, L)."
490                            },
491                            "pieces": {
492                              "type": "integer",
493                              "description": "Quantity of pieces for the corresponding size."
494                            }
495                          }
496                        }
497                      }
498                    }
499                  }
500                }
501              },
502              "seller_identifier": {
503                "type": "string",
504                "description": "Unique identifier used by the seller for the product."
505              }
506            }
507          }
508        }
509      }
510    }
511  }
512}

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": 414
23        },
24        "company": {
25          "id": 3932
26        },
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": 25
39        },
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": 0
58        },
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": 23630
75        },
76        "tags": [],
77        "tax_identifier": {
78          "hsn_code_id": "6277837c5e4c6fdbc8be3e93"
79        },
80        "total_quantity": 1,
81        "trace_id": "inventory.f366a506-f24e-11ee-ad2e-c227286f4511",
82        "track_inventory": true,
83        "uid": "23630_8905310270582",
84        "weight": {
85          "shipping": 250,
86          "unit": "gram"
87        }
88      }
89    ]
90  }
91}

Was this section helpful?

company/article/delete/v1

this event is triggered when article is deleted

Payload

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

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

articles

array of object

Required

Array of Properties

string

Unique identifier for the article.

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

integer

Required

Unique identifier for the brand.

price

object

Required

Pricing details of the product, including various price types.

Properties

marked

number

Required

Marked price or original listed price of the product.

currency

string

Required

Currency used for the product's pricing (e.g., USD, EUR).

transfer

number

Required

Transfer price of the product.

effective

number

Required

Final price after applying discounts.

updated_at

string

| date-time

Date and time when the pricing information was last updated.

store

object

Required

Information about the store selling the product.

Properties

integer

Required

Unique identifier for the store.

is_set

boolean

Indicates if the product is sold as part of a set.

weight

object

Required

Weight details of the product.

Properties

unit

string

Required

Unit of weight measurement (e.g., kg, lbs).

shipping

number

Required

Shipping weight of the product.

is_default

boolean

Indicates if this is the default weight configuration.

company

object

Required

Information about the company producing or selling the product.

Properties

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.

dimension

object

Required

Dimension details of the product.

Properties

unit

string

Required

Unit of dimension measurement (e.g., cm, inches).

width

number

Required

Width of the product.

height

number

Required

Height of the product.

length

number

Required

Length of the product.

is_default

boolean

Indicates if these are the default dimensions.

is_active

boolean

Indicates if the product is currently active (available for sale).

identifier

object

Required

Product-specific identifier details.

quantities

object

Information about product quantities, including available and unavailable stock.

Properties

damaged

object

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

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

Details of committed orders.

Properties

count

integer

Number of units committed to orders.

updated_at

string

Timestamp of the last order committed update.

_custom_json

object

Custom JSON data associated with the product.

trader

array of object

List of traders associated with the product.

Array of Properties

name

string

Trader's name.

type

string

Indicates the trader type.

Enum

address

array of string

List of addresses associated with the trader.

manufacturer

object

Required

Information about the product's manufacturer.

Properties

name

string

Required

Manufacturer's name.

address

string

Required

Manufacturer's physical address.

is_default

boolean

Indicates if this is the default manufacturer for the product.

return_config

object

Return policy configuration for the product.

Properties

unit

string

Time unit for the return period (either days or hours).

Enum

time

integer

Duration within which the product can be returned.

returnable

boolean

Required

Indicates if the product is returnable.

fynd_item_code

string

Required

Fynd's unique internal code for the product.

tax_identifier

object

Tax-related identification for the product.

Properties

hsn_code_id

string

HSN (Harmonized System of Nomenclature) code identifier.

total_quantity

integer

Required

Total quantity available for the product.

expiration_date

string

Expiration or validity end date for the product.

track_inventory

boolean

Indicates if inventory tracking is enabled for the product.

country_of_origin

string

Required

Country where the product was manufactured or originated.

stage

string

Current stage of the product lifecycle (e.g., verified).

set

object

Configuration of the set, if the product is sold as one.

Properties

quantity

integer

Total number of items in the set.

size_distribution

object

Size distribution details within the set.

Properties

sizes

array of object

List of sizes and their respective quantities.

Array of Properties

size

string

Label of the size (e.g., S, M, L).

pieces

integer

Quantity of pieces for the corresponding size.

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        "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                },
145                "required": [
146                  "transfer",
147                  "effective",
148                  "marked",
149                  "currency"
150                ]
151              },
152              "store": {
153                "type": "object",
154                "description": "Information about the store selling the product.",
155                "properties": {
156                  "id": {
157                    "type": "integer",
158                    "description": "Unique identifier for the store."
159                  }
160                },
161                "required": [
162                  "id"
163                ]
164              },
165              "is_set": {
166                "type": "boolean",
167                "description": "Indicates if the product is sold as part of a set."
168              },
169              "weight": {
170                "type": "object",
171                "description": "Weight details of the product.",
172                "properties": {
173                  "unit": {
174                    "type": "string",
175                    "description": "Unit of weight measurement (e.g., kg, lbs)."
176                  },
177                  "shipping": {
178                    "type": "number",
179                    "description": "Shipping weight of the product."
180                  },
181                  "is_default": {
182                    "type": "boolean",
183                    "description": "Indicates if this is the default weight configuration."
184                  }
185                },
186                "required": [
187                  "unit",
188                  "shipping"
189                ]
190              },
191              "company": {
192                "type": "object",
193                "description": "Information about the company producing or selling the product.",
194                "properties": {
195                  "id": {
196                    "type": "integer",
197                    "description": "Unique identifier for the company."
198                  }
199                },
200                "required": [
201                  "id"
202                ]
203              },
204              "item_id": {
205                "type": "integer",
206                "description": "Unique identifier for the item."
207              },
208              "date_meta": {
209                "type": "object",
210                "description": "Timestamps for important events in the product's lifecycle.",
211                "properties": {
212                  "created_on": {
213                    "type": "string",
214                    "format": "date-time",
215                    "description": "Date and time when the product was first created."
216                  },
217                  "modified_on": {
218                    "type": "string",
219                    "format": "date-time",
220                    "description": "Last modification timestamp of the product inventory details."
221                  },
222                  "added_on_store": {
223                    "type": "string",
224                    "format": "date-time",
225                    "description": "Date and time when the product was added to the store."
226                  },
227                  "inventory_updated_on": {
228                    "type": "string",
229                    "format": "date-time",
230                    "description": "Last inventory update timestamp."
231                  }
232                },
233                "required": [
234                  "modified_on"
235                ]
236              },
237              "dimension": {
238                "type": "object",
239                "description": "Dimension details of the product.",
240                "properties": {
241                  "unit": {
242                    "type": "string",
243                    "description": "Unit of dimension measurement (e.g., cm, inches)."
244                  },
245                  "width": {
246                    "type": "number",
247                    "description": "Width of the product."
248                  },
249                  "height": {
250                    "type": "number",
251                    "description": "Height of the product."
252                  },
253                  "length": {
254                    "type": "number",
255                    "description": "Length of the product."
256                  },
257                  "is_default": {
258                    "type": "boolean",
259                    "description": "Indicates if these are the default dimensions."
260                  }
261                },
262                "required": [
263                  "unit",
264                  "height",
265                  "width",
266                  "length"
267                ]
268              },
269              "is_active": {
270                "type": "boolean",
271                "description": "Indicates if the product is currently active (available for sale)."
272              },
273              "identifier": {
274                "type": "object",
275                "description": "Product-specific identifier details."
276              },
277              "quantities": {
278                "type": "object",
279                "description": "Information about product quantities, including available and unavailable stock.",
280                "properties": {
281                  "damaged": {
282                    "type": "object",
283                    "description": "Details of damaged stock.",
284                    "properties": {
285                      "count": {
286                        "type": "integer",
287                        "description": "Number of damaged units."
288                      },
289                      "updated_at": {
290                        "type": "string",
291                        "description": "Timestamp of the last damaged stock update."
292                      }
293                    },
294                    "required": [
295                      "count",
296                      "updated_at"
297                    ]
298                  },
299                  "sellable": {
300                    "type": "object",
301                    "description": "Sellable stock information.",
302                    "properties": {
303                      "count": {
304                        "type": "integer",
305                        "description": "Number of sellable units available."
306                      },
307                      "updated_at": {
308                        "type": "string",
309                        "description": "Timestamp of the last sellable stock update."
310                      }
311                    },
312                    "required": [
313                      "count",
314                      "updated_at"
315                    ]
316                  },
317                  "not_available": {
318                    "type": "object",
319                    "description": "Information about unavailable stock.",
320                    "properties": {
321                      "count": {
322                        "type": "integer",
323                        "description": "Number of unavailable units."
324                      },
325                      "updated_at": {
326                        "type": "string",
327                        "description": "Timestamp of the last unavailable stock update."
328                      }
329                    },
330                    "required": [
331                      "count",
332                      "updated_at"
333                    ]
334                  },
335                  "order_committed": {
336                    "type": "object",
337                    "description": "Details of committed orders.",
338                    "properties": {
339                      "count": {
340                        "type": "integer",
341                        "description": "Number of units committed to orders."
342                      },
343                      "updated_at": {
344                        "type": "string",
345                        "description": "Timestamp of the last order committed update."
346                      }
347                    }
348                  }
349                },
350                "required": [
351                  "sellable"
352                ]
353              },
354              "_custom_json": {
355                "type": "object",
356                "description": "Custom JSON data associated with the product."
357              },
358              "trader": {
359                "type": "array",
360                "description": "List of traders associated with the product.",
361                "items": {
362                  "type": "object",
363                  "properties": {
364                    "name": {
365                      "type": "string",
366                      "description": "Trader's name."
367                    },
368                    "type": {
369                      "type": "string",
370                      "enum": [
371                        "Manufacturer",
372                        "Importer",
373                        "Packer",
374                        "Marketer"
375                      ],
376                      "description": "Indicates the trader type."
377                    },
378                    "address": {
379                      "type": "array",
380                      "description": "List of addresses associated with the trader.",
381                      "items": {
382                        "type": "string"
383                      }
384                    }
385                  }
386                }
387              },
388              "manufacturer": {
389                "type": "object",
390                "description": "Information about the product's manufacturer.",
391                "properties": {
392                  "name": {
393                    "type": "string",
394                    "description": "Manufacturer's name."
395                  },
396                  "address": {
397                    "type": "string",
398                    "description": "Manufacturer's physical address."
399                  },
400                  "is_default": {
401                    "type": "boolean",
402                    "description": "Indicates if this is the default manufacturer for the product."
403                  }
404                },
405                "required": [
406                  "name",
407                  "address"
408                ]
409              },
410              "return_config": {
411                "type": "object",
412                "description": "Return policy configuration for the product.",
413                "properties": {
414                  "unit": {
415                    "type": "string",
416                    "enum": [
417                      "days",
418                      "hours"
419                    ],
420                    "description": "Time unit for the return period (either days or hours)."
421                  },
422                  "time": {
423                    "type": "integer",
424                    "description": "Duration within which the product can be returned."
425                  },
426                  "returnable": {
427                    "type": "boolean",
428                    "description": "Indicates if the product is returnable."
429                  }
430                },
431                "required": [
432                  "returnable"
433                ]
434              },
435              "fynd_item_code": {
436                "type": "string",
437                "description": "Fynd's unique internal code for the product."
438              },
439              "tax_identifier": {
440                "type": "object",
441                "description": "Tax-related identification for the product.",
442                "properties": {
443                  "hsn_code_id": {
444                    "type": "string",
445                    "description": "HSN (Harmonized System of Nomenclature) code identifier."
446                  }
447                }
448              },
449              "total_quantity": {
450                "type": "integer",
451                "description": "Total quantity available for the product."
452              },
453              "expiration_date": {
454                "type": "string",
455                "description": "Expiration or validity end date for the product."
456              },
457              "track_inventory": {
458                "type": "boolean",
459                "description": "Indicates if inventory tracking is enabled for the product."
460              },
461              "country_of_origin": {
462                "type": "string",
463                "description": "Country where the product was manufactured or originated."
464              },
465              "stage": {
466                "type": "string",
467                "description": "Current stage of the product lifecycle (e.g., verified)."
468              },
469              "set": {
470                "type": "object",
471                "description": "Configuration of the set, if the product is sold as one.",
472                "properties": {
473                  "quantity": {
474                    "type": "integer",
475                    "description": "Total number of items in the set."
476                  },
477                  "size_distribution": {
478                    "type": "object",
479                    "description": "Size distribution details within the set.",
480                    "properties": {
481                      "sizes": {
482                        "type": "array",
483                        "description": "List of sizes and their respective quantities.",
484                        "items": {
485                          "type": "object",
486                          "properties": {
487                            "size": {
488                              "type": "string",
489                              "description": "Label of the size (e.g., S, M, L)."
490                            },
491                            "pieces": {
492                              "type": "integer",
493                              "description": "Quantity of pieces for the corresponding size."
494                            }
495                          }
496                        }
497                      }
498                    }
499                  }
500                }
501              },
502              "seller_identifier": {
503                "type": "string",
504                "description": "Unique identifier used by the seller for the product."
505              }
506            }
507          }
508        }
509      }
510    }
511  }
512}

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": 3559
23        },
24        "company": {
25          "id": 61
26        },
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": 5
39        },
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": 0
58        },
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": 15411
75        },
76        "tags": [],
77        "tax_identifier": {
78          "hsn_code_id": "65fd783dc528d7515782df49"
79        },
80        "total_quantity": 10000,
81        "trace_id": "inventory.9727cd26-ec4d-11ee-bd11-aa1ad4821f40",
82        "track_inventory": true,
83        "uid": "15411_SDVKJNSVD",
84        "weight": {
85          "shipping": 5,
86          "unit": "gram"
87        }
88      }
89    ]
90  }
91}

Was this section helpful?

company/article/update/v1

this event is triggered when article is updated

Payload

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