Webhooks
Overview
Webhook Configuration
Filters and Reducer
Best Practices
Kafka
Amazon EventBridge
Amazon SQS
Google Pub/Sub
Temporal
Change Log
article/create/v1
article/update/v1
article/delete/v1
brand/create/v1
brand/update/v1
company/create/v2
company/update/v2
company/delete/v2
courier-partner/account-status/v1
customfield_definition/create/v1
customfield_definition/update/v1
customfield_definition/delete/v1
customfields/inventory-update/v1
customfields/inventory-delete/v1
customfields/product-update/v1
customfields/product-delete/v1
customfields/product-size-update/v1
customfields/product-size-delete/v1
customfields/selling-location-update/v1
customobject_definition/create/v1
customobject_definition/update/v1
customobject_definition/delete/v1
customobjects/create/v1
customobjects/update/v1
customobjects/delete/v1
location/create/v2
location/update/v2
location-price/create/v1
location-price/update/v1
location-price/delete/v1
location-quantity/create/v1
location-quantity/update/v1
logistics-configuration/update/v1
product/create/v3
product/update/v3
product/delete/v3
product-size/create/v2
product-size/delete/v2
product-size/update/v2
support-ticket/create/v1
support-ticket/update/v1
address/create/v1
address/update/v1
address/delete/v1
article/create/v1
article/update/v1
article/delete/v1
available_pages/create/v1
available_pages/update/v1
available_pages/delete/v1
cart/create/v1
cart/update/v1
cart-price-adjustment/create/v1
cart-price-adjustment/update/v1
cart-price-adjustment/remove/v1
collection/create/v2
collection/update/v2
collection/delete/v2
configuration/create/v1
configuration/update/v1
coupon/create/v1
coupon/update/v1
coupon/redeem/v1
courier-partner/assign/v1
courier-partner/ndr/v1
courier-partner/cancel/v1
customer_credit_note_configuration/create/v1
customer_credit_note_configuration/update/v1
customfield_definition/create/v1
customfield_definition/update/v1
customfield_definition/delete/v1
customfields/bag-update/v1
customfields/coupon-update/v1
customfields/product-update/v1
customfields/promotion-update/v1
customobject_definition/create/v1
customobject_definition/update/v1
customobject_definition/delete/v1
customobjects/create/v1
customobjects/update/v1
customobjects/delete/v1
details_groups/create/v1
details_groups/update/v1
details_groups/delete/v1
discount/create/v1
discount/update/v1
discount/start/v1
discount/end/v1
domain/create/v1
domain/delete/v1
faq/create/v1
faq/update/v1
faq/delete/v1
filter/create/v1
filter/update/v1
filter/delete/v1
legal/update/v1
location-price/create/v1
location-price/update/v1
location-price/delete/v1
location-quantity/create/v1
location-quantity/update/v1
merchandising/create/v1
merchandising/update/v1
merchandising/delete/v1
offer/create/v1
offer/update/v1
offer/redeem/v1
order/placed/v1
order/pending/v1
order/payment_failed/v1
payment/complete/v1
payment/pending/v1
payment/failed/v1
product/create/v2
product/update/v2
product/delete/v2
product-price/create/v1
product-price/update/v1
product-price/delete/v1
promotion/create/v1
promotion/update/v1
promotion_usage/update/v1
refund/refund_initiated/v1
refund/refund_pending/v1
refund/refund_done/v1
refund/refund_failed/v1
return_config/update/v1
return_config_categories/update/v1
return_config_categories/delete/v1
rma_rule/create/v2
rma_rule/update/v2
rma_rule/create/v1
rma_rule/update/v1
seo/update/v1
shipment/create/v1
shipment/update/v1
shipment/data_update/v1
sort/create/v1
sort/update/v1
sort/delete/v1
tags/create/v1
tags/update/v1
tags/delete/v1
theme/create/v1
theme/update/v1
theme/delete/v1
user/create/v1
user/update/v1
user/delete/v1
variant/create/v1
variant/update/v1
variant/delete/v1
zone/create/v1
zone/update/v1
category/create/v1
category/update/v1
department/create/v1
department/update/v1
extension/install/v1
extension/uninstall/v1
extension-subscription/create/v1
extension-subscription/update/v1
add_to_cart/engagement/v1
delivery_promise/click/v1
location_details/click/v1
order_checkedout/conversion/v1
order_checkout/conversion/v1
order_complete/conversion/v1
product_listing/conversion/v1
product_price/click/v1
product_search/search/v1
product_view/click/v1
product_wishlist_add/engagement/v1
product_wishlist_remove/engagement/v1
remove_from_cart/engagement/v1
user_login/identity/v1
user_logout/identity/v1

Company

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

Product

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

Events
company/product/create/v3
# this event is triggered when product is created
company/product/update/v3
# this event is triggered when product is updated
company/product/delete/v3
# this event is triggered when product is deleted

Product/product/create/v3

this event is triggered when product is created

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
product
object
Required
Information about a product.
Properties
currency
string
Currency of the product.
product_group_tag
array of string
Tag associated with the product group.
name
string
Required
Name of the product.
tags
array of string
List of tags associated with the product.
slug
string
Required
Unique slug for the product.
variant_media
object
A dictionary of media files associated with each variant of the product.
teaser_tag
object
Teaser tag for the product.
trader
array of object
Trader associated with the product.
Array of Properties
address
array of string
Required
type
string
Required
Type of trader (e.g., Manufacturer, Importer, Packer)
name
string
Required
Name of the trader
description
string
Description of the product.
return_config
object
Required
Return policy information for the product.
Properties
returnable
boolean
Required
Flag indicating if the product is returnable or not.
time
integer
The time within which the product can be returned, in the specified time unit.
unit
string
The unit of time used to measure the time within which the product can be returned.
allow_partial_return
boolean
Flag indicating if partial return of bundle child product is allowed or not.
departments
array of integer
Required
List of department IDs associated with the product.
product_publish
object
Required
Information about the product publication status.
Properties
product_online_date
string
Required
Unix timestamp indicating the date and time when the product was published online.
is_set
boolean
Required
Flag to indicate if the product is published online or not.
is_dependent
boolean
Required
Flag to indicate if the product is dependent on other products or not.
highlights
array of string
A list of highlights or special features associated with the product.
size_guide
string
URL to the size guide for the product.
no_of_boxes
integer
Required
Number of boxes containing the product.
company_id
integer
Required
ID of the company associated with the product.
variants
object
A dictionary of product variants, where the keys are variant names and the values are variant details.
category_slug
string
Slug of the category associated with the product.
media
array of object
List of media information associated with the product.
Array of Properties
type
string
url
string
uid
integer
Required
The unique identifier of the product.
template_tag
string
Required
The tag used for the product template.
short_description
string
A short description of the product, limited to 50 characters.
category_uid
integer
Required
The unique identifier of the category that the product belongs to.
item_code
string
Required
Item code for the product.
multi_size
boolean
Required
Flag to indicate if the product has multiple sizes or not.
is_set
boolean
Required
Flag to indicate if the product is a set or not.
net_quantity
object
Net quantity details for the product.
Properties
unit
string
Specifies the unit of measurement for the net quantity.
value
number
The numerical value representing the net quantity of the product
brand_uid
integer
Required
Unique ID of the brand associated with the product.
is_active
boolean
Required
A boolean indicating whether the product is currently active or not.
is_image_less_product
boolean
Required
Flag to indicate if the product has no image or not.
attributes
object
Attributes of the product.
custom_order
object
Required
Custom order information for the product.
Properties
manufacturing_time_unit
string
Required
The unit of time used to measure the time required to manufacture the product.
is_custom_order
boolean
Required
Flag indicating if the product is a custom order or not.
manufacturing_time
integer
Required
The time required to manufacture the product, in the specified time unit.
tax_identifier
object
Required
Tax identifier for the product.
Properties
hsn_code
string
The HSN (Harmonized System of Nomenclature) code associated with the product.
hsn_code_id
string
ID of the HSN code associated with the product.
reporting_hsn
string
Reporting HSN for the product.
tax_rule_id
string
ID of the tax rule associated with the product.
hs_code
string|null
The HS Code (Harmonized System of Nomenclature) code associated with the product.
country_of_origin
string
Required
Country of origin for the product.
item_type
string
Required
Type of the product.
_custom_json
object
A dictionary of custom JSON data associated with the product.
bundle_details
array of object
An array of bundle child sku details. This will have child skus along with net quantity used in bundle formation.
Array of Properties
is_base
boolean
A flag that determines if child product is base product of bundle.
seller_identifier
string
Seller Identifier of the bundle child product.
net_quantity
number
Net quantity of the bundle child product.
use_individual_product_packaging
boolean
Flag indicating if individual product packaging should be used instead of bundle packaging.
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        "product"
70      ],
71      "properties": {
72        "product": {
73          "type": "object",
74          "required": [
75            "name",
76            "return_config",
77            "product_publish",
78            "is_dependent",
79            "no_of_boxes",
80            "company_id",
81            "uid",
82            "template_tag",
83            "category_uid",
84            "item_code",
85            "multi_size",
86            "is_set",
87            "brand_uid",
88            "is_active",
89            "is_image_less_product",
90            "custom_order",
91            "tax_identifier",
92            "country_of_origin",
93            "item_type",
94            "departments",
95            "slug"
96          ],
97          "properties": {
98            "currency": {
99              "type": "string",
100              "description": "Currency of the product."
101            },
102            "product_group_tag": {
103              "type": "array",
104              "description": "Tag associated with the product group.",
105              "items": {
106                "type": "string"
107              }
108            },
109            "name": {
110              "type": "string",
111              "description": "Name of the product."
112            },
113            "tags": {
114              "type": "array",
115              "description": "List of tags associated with the product.",
116              "items": {
117                "type": "string"
118              }
119            },
120            "slug": {
121              "type": "string",
122              "description": "Unique slug for the product."
123            },
124            "variant_media": {
125              "type": "object",
126              "additionalProperties": true,
127              "description": "A dictionary of media files associated with each variant of the product."
128            },
129            "teaser_tag": {
130              "type": "object",
131              "description": "Teaser tag for the product."
132            },
133            "trader": {
134              "type": "array",
135              "items": {
136                "type": "object",
137                "required": [
138                  "address",
139                  "type",
140                  "name"
141                ],
142                "properties": {
143                  "address": {
144                    "type": "array",
145                    "items": {
146                      "type": "string"
147                    }
148                  },
149                  "type": {
150                    "type": "string",
151                    "description": "Type of trader (e.g., Manufacturer, Importer, Packer)"
152                  },
153                  "name": {
154                    "type": "string",
155                    "description": "Name of the trader"
156                  }
157                }
158              },
159              "description": "Trader associated with the product."
160            },
161            "description": {
162              "type": "string",
163              "description": "Description of the product."
164            },
165            "return_config": {
166              "type": "object",
167              "required": [
168                "returnable"
169              ],
170              "properties": {
171                "returnable": {
172                  "type": "boolean",
173                  "description": "Flag indicating if the product is returnable or not."
174                },
175                "time": {
176                  "type": "integer",
177                  "description": "The time within which the product can be returned, in the specified time unit."
178                },
179                "unit": {
180                  "type": "string",
181                  "description": "The unit of time used to measure the time within which the product can be returned."
182                },
183                "allow_partial_return": {
184                  "type": "boolean",
185                  "description": "Flag indicating if partial return of bundle child product is allowed or not."
186                }
187              },
188              "description": "Return policy information for the product."
189            },
190            "departments": {
191              "type": "array",
192              "items": {
193                "type": "integer",
194                "description": "Department IDs associated with the product"
195              },
196              "description": "List of department IDs associated with the product."
197            },
198            "product_publish": {
199              "type": "object",
200              "required": [
201                "product_online_date",
202                "is_set"
203              ],
204              "properties": {
205                "product_online_date": {
206                  "type": "string",
207                  "description": "Unix timestamp indicating the date and time when the product was published online."
208                },
209                "is_set": {
210                  "type": "boolean",
211                  "description": "Flag to indicate if the product is published online or not."
212                }
213              },
214              "description": "Information about the product publication status."
215            },
216            "is_dependent": {
217              "type": "boolean",
218              "description": "Flag to indicate if the product is dependent on other products or not."
219            },
220            "highlights": {
221              "type": "array",
222              "items": {
223                "type": "string"
224              },
225              "description": "A list of highlights or special features associated with the product."
226            },
227            "size_guide": {
228              "type": "string",
229              "description": "URL to the size guide for the product."
230            },
231            "no_of_boxes": {
232              "type": "integer",
233              "description": "Number of boxes containing the product."
234            },
235            "company_id": {
236              "type": "integer",
237              "description": "ID of the company associated with the product."
238            },
239            "variants": {
240              "type": "object",
241              "additionalProperties": true,
242              "description": "A dictionary of product variants, where the keys are variant names and the values are variant details."
243            },
244            "category_slug": {
245              "type": "string",
246              "description": "Slug of the category associated with the product."
247            },
248            "media": {
249              "type": "array",
250              "items": {
251                "type": "object",
252                "properties": {
253                  "type": {
254                    "type": "string"
255                  },
256                  "url": {
257                    "type": "string"
258                  }
259                }
260              },
261              "description": "List of media information associated with the product."
262            },
263            "uid": {
264              "type": "integer",
265              "description": "The unique identifier of the product."
266            },
267            "template_tag": {
268              "type": "string",
269              "description": "The tag used for the product template."
270            },
271            "short_description": {
272              "type": "string",
273              "description": "A short description of the product, limited to 50 characters."
274            },
275            "category_uid": {
276              "type": "integer",
277              "description": "The unique identifier of the category that the product belongs to."
278            },
279            "item_code": {
280              "type": "string",
281              "description": "Item code for the product."
282            },
283            "multi_size": {
284              "type": "boolean",
285              "description": "Flag to indicate if the product has multiple sizes or not."
286            },
287            "is_set": {
288              "type": "boolean",
289              "description": "Flag to indicate if the product is a set or not."
290            },
291            "net_quantity": {
292              "description": "Net quantity details for the product.",
293              "type": "object",
294              "properties": {
295                "unit": {
296                  "type": "string",
297                  "description": "Specifies the unit of measurement for the net quantity."
298                },
299                "value": {
300                  "type": "number",
301                  "description": "The numerical value representing the net quantity of the product"
302                }
303              }
304            },
305            "brand_uid": {
306              "type": "integer",
307              "description": "Unique ID of the brand associated with the product."
308            },
309            "is_active": {
310              "type": "boolean",
311              "description": "A boolean indicating whether the product is currently active or not."
312            },
313            "is_image_less_product": {
314              "type": "boolean",
315              "description": "Flag to indicate if the product has no image or not."
316            },
317            "attributes": {
318              "type": "object",
319              "additionalProperties": true,
320              "description": "Attributes of the product."
321            },
322            "custom_order": {
323              "type": "object",
324              "required": [
325                "manufacturing_time_unit",
326                "is_custom_order",
327                "manufacturing_time"
328              ],
329              "properties": {
330                "manufacturing_time_unit": {
331                  "type": "string",
332                  "description": "The unit of time used to measure the time required to manufacture the product."
333                },
334                "is_custom_order": {
335                  "type": "boolean",
336                  "description": "Flag indicating if the product is a custom order or not."
337                },
338                "manufacturing_time": {
339                  "type": "integer",
340                  "description": "The time required to manufacture the product, in the specified time unit."
341                }
342              },
343              "description": "Custom order information for the product."
344            },
345            "tax_identifier": {
346              "type": "object",
347              "properties": {
348                "hsn_code": {
349                  "type": "string",
350                  "description": "The HSN (Harmonized System of Nomenclature) code associated with the product."
351                },
352                "hsn_code_id": {
353                  "type": "string",
354                  "description": "ID of the HSN code associated with the product."
355                },
356                "reporting_hsn": {
357                  "type": "string",
358                  "description": "Reporting HSN for the product."
359                },
360                "tax_rule_id": {
361                  "type": "string",
362                  "description": "ID of the tax rule associated with the product."
363                }
364              },
365              "description": "Tax identifier for the product."
366            },
367            "hs_code": {
368              "type": [
369                "string",
370                "null"
371              ],
372              "description": "The HS Code (Harmonized System of Nomenclature) code associated with the product."
373            },
374            "country_of_origin": {
375              "type": "string",
376              "description": "Country of origin for the product."
377            },
378            "item_type": {
379              "type": "string",
380              "description": "Type of the product."
381            },
382            "_custom_json": {
383              "type": "object",
384              "description": "A dictionary of custom JSON data associated with the product."
385            },
386            "bundle_details": {
387              "type": "array",
388              "description": "An array of bundle child sku details. This will have child skus along with net quantity used in bundle formation.",
389              "items": {
390                "type": "object",
391                "properties": {
392                  "is_base": {
393                    "type": "boolean",
394                    "description": "A flag that determines if child product is base product of bundle."
395                  },
396                  "seller_identifier": {
397                    "type": "string",
398                    "description": "Seller Identifier of the bundle child product."
399                  },
400                  "net_quantity": {
401                    "type": "number",
402                    "description": "Net quantity of the bundle child product."
403                  }
404                }
405              }
406            },
407            "use_individual_product_packaging": {
408              "type": "boolean",
409              "description": "Flag indicating if individual product packaging should be used instead of bundle packaging."
410            }
411          },
412          "description": "Information about a product."
413        }
414      }
415    }
416  }
417}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.e5d3d4ae-f23a-11ee-8e32-1670e4e67cd9"
5    ],
6    "name": "product",
7    "type": "create",
8    "version": "3",
9    "created_timestamp": 1712204527295,
10    "id": "IzF6aoBVaTMBlGX+k1wGXf0ZVwfcSY5I9BYU8X0VGEA=",
11    "category": "company"
12  },
13  "company_id": 7053,
14  "contains": [
15    "product"
16  ],
17  "payload": {
18    "product": {
19      "media": [
20        {
21          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/Lgc3jeZ-H-Hanging_Light.jpeg",
22          "type": "image"
23        }
24      ],
25      "trader": [
26        {
27          "address": [
28            "TEST"
29          ],
30          "type": "Manufacturer",
31          "name": "TEST"
32        }
33      ],
34      "item_code": "HANGI_001NG",
35      "is_active": true,
36      "name": "Hanging_Light",
37      "currency": "INR",
38      "short_description": "",
39      "custom_order": {
40        "is_custom_order": false,
41        "manufacturing_time_unit": "days",
42        "manufacturing_time": 0
43      },
44      "company_id": 7053,
45      "template_tag": "led-lights",
46      "size_guide": "",
47      "attributes": {},
48      "description": "",
49      "_custom_json": {},
50      "no_of_boxes": 1,
51      "teaser_tag": {},
52      "product_publish": {
53        "product_online_date": "2024-04-04T04:22:05.148000+00:00",
54        "is_set": false
55      },
56      "uid": 10242364,
57      "is_dependent": false,
58      "item_type": "standard",
59      "variants": {},
60      "return_config": {
61        "returnable": false,
62        "unit": "days",
63        "time": 0
64      },
65      "slug": "hanginglight",
66      "departments": [
67        32
68      ],
69      "tags": [],
70      "product_group_tag": [],
71      "is_set": false,
72      "country_of_origin": "India",
73      "is_image_less_product": false,
74      "category_slug": "Hanging--Light",
75      "highlights": [],
76      "multi_size": false,
77      "category_uid": 3750,
78      "brand_uid": 5989,
79      "variant_media": {},
80      "tax_identifier": {
81        "hsn_code_id": "64e8aa91d87af8902bc12c0b",
82        "hsn_code": "94051900",
83        "reporting_hsn": "94051900H1",
84        "tax_rule_id": "64e8aa91d87af8902bc12c0b"
85      },
86      "hs_code": "94051900",
87      "net_quantity": {}
88    }
89  }
90}

Product/product/update/v3

this event is triggered when product is updated

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
product
object
Required
Information about a product.
Properties
currency
string
Currency of the product.
product_group_tag
array of string
Tag associated with the product group.
name
string
Required
Name of the product.
tags
array of string
List of tags associated with the product.
slug
string
Required
Unique slug for the product.
variant_media
object
A dictionary of media files associated with each variant of the product.
teaser_tag
object
Teaser tag for the product.
trader
array of object
Trader associated with the product.
Array of Properties
address
array of string
Required
type
string
Required
Type of trader (e.g., Manufacturer, Importer, Packer)
name
string
Required
Name of the trader
description
string
Description of the product.
return_config
object
Required
Return policy information for the product.
Properties
returnable
boolean
Required
Flag indicating if the product is returnable or not.
time
integer
The time within which the product can be returned, in the specified time unit.
unit
string
The unit of time used to measure the time within which the product can be returned.
allow_partial_return
boolean
Flag indicating if partial return of bundle child product is allowed or not.
departments
array of integer
Required
List of department IDs associated with the product.
product_publish
object
Information about the product publication status.
Properties
product_online_date
string
Required
Unix timestamp indicating the date and time when the product was published online.
is_set
boolean
Required
Flag to indicate if the product is published online or not.
is_dependent
boolean
Required
Flag to indicate if the product is dependent on other products or not.
highlights
array of string
A list of highlights or special features associated with the product.
change_request_id
string
ID of the change request associated with the product update.
size_guide
string
URL to the size guide for the product.
no_of_boxes
integer
Required
Number of boxes containing the product.
company_id
integer
Required
ID of the company associated with the product.
variants
object
A dictionary of product variants, where the keys are variant names and the values are variant details.
category_slug
string
Slug of the category associated with the product.
media
array of object
List of media information associated with the product.
Array of Properties
type
string
url
string
uid
integer
Required
The unique identifier of the product.
template_tag
string
Required
The tag used for the product template.
short_description
string
A short description of the product, limited to 50 characters.
category_uid
integer
Required
The unique identifier of the category that the product belongs to.
item_code
string
Required
Item code for the product.
multi_size
boolean
Required
Flag to indicate if the product has multiple sizes or not.
is_set
boolean
Required
Flag to indicate if the product is a set or not.
net_quantity
object
Net quantity details for the product.
Properties
unit
string
Specifies the unit of measurement for the net quantity.
value
number
The numerical value representing the net quantity of the product
brand_uid
integer
Required
Unique ID of the brand associated with the product.
is_active
boolean
Required
A boolean indicating whether the product is currently active or not.
is_image_less_product
boolean
Required
Flag to indicate if the product has no image or not.
attributes
object
Attributes of the product.
custom_order
object
Required
Custom order information for the product.
Properties
manufacturing_time_unit
string
Required
The unit of time used to measure the time required to manufacture the product.
is_custom_order
boolean
Required
Flag indicating if the product is a custom order or not.
manufacturing_time
integer
Required
The time required to manufacture the product, in the specified time unit.
tax_identifier
object
Required
Tax identifier for the product.
Properties
hsn_code
string
The HSN (Harmonized System of Nomenclature) code associated with the product.
hsn_code_id
string
ID of the HSN code associated with the product.
reporting_hsn
string
Reporting HSN for the product.
tax_rule_id
string
ID of the tax rule associated with the product.
hs_code
string|null
The HS Code (Harmonized System of Nomenclature) code associated with the product.
country_of_origin
string
Required
Country of origin for the product.
item_type
string
Required
Type of the product.
_custom_json
object
A dictionary of custom JSON data associated with the product.
bundle_details
array of object
An array of bundle child sku details. This will have child skus along with net quantity used in bundle formation.
Array of Properties
is_base
boolean
A flag that determines if child product is base product of bundle.
seller_identifier
string
Seller Identifier of the bundle child product.
net_quantity
number
Net quantity of the bundle child product.
use_individual_product_packaging
boolean
Flag indicating if individual product packaging should be used instead of bundle packaging.
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        "product"
70      ],
71      "properties": {
72        "product": {
73          "type": "object",
74          "required": [
75            "name",
76            "return_config",
77            "is_dependent",
78            "no_of_boxes",
79            "company_id",
80            "uid",
81            "template_tag",
82            "category_uid",
83            "item_code",
84            "multi_size",
85            "is_set",
86            "brand_uid",
87            "is_active",
88            "is_image_less_product",
89            "custom_order",
90            "tax_identifier",
91            "country_of_origin",
92            "item_type",
93            "departments",
94            "slug"
95          ],
96          "properties": {
97            "currency": {
98              "type": "string",
99              "description": "Currency of the product."
100            },
101            "product_group_tag": {
102              "type": "array",
103              "description": "Tag associated with the product group.",
104              "items": {
105                "type": "string"
106              }
107            },
108            "name": {
109              "type": "string",
110              "description": "Name of the product."
111            },
112            "tags": {
113              "type": "array",
114              "description": "List of tags associated with the product.",
115              "items": {
116                "type": "string"
117              }
118            },
119            "slug": {
120              "type": "string",
121              "description": "Unique slug for the product."
122            },
123            "variant_media": {
124              "type": "object",
125              "additionalProperties": true,
126              "description": "A dictionary of media files associated with each variant of the product."
127            },
128            "teaser_tag": {
129              "type": "object",
130              "description": "Teaser tag for the product."
131            },
132            "trader": {
133              "type": "array",
134              "items": {
135                "type": "object",
136                "required": [
137                  "address",
138                  "type",
139                  "name"
140                ],
141                "properties": {
142                  "address": {
143                    "type": "array",
144                    "items": {
145                      "type": "string"
146                    }
147                  },
148                  "type": {
149                    "type": "string",
150                    "description": "Type of trader (e.g., Manufacturer, Importer, Packer)"
151                  },
152                  "name": {
153                    "type": "string",
154                    "description": "Name of the trader"
155                  }
156                },
157                "description": "Details of traders associated with the product"
158              },
159              "description": "Trader associated with the product."
160            },
161            "description": {
162              "type": "string",
163              "description": "Description of the product."
164            },
165            "return_config": {
166              "type": "object",
167              "required": [
168                "returnable"
169              ],
170              "properties": {
171                "returnable": {
172                  "type": "boolean",
173                  "description": "Flag indicating if the product is returnable or not."
174                },
175                "time": {
176                  "type": "integer",
177                  "description": "The time within which the product can be returned, in the specified time unit."
178                },
179                "unit": {
180                  "type": "string",
181                  "description": "The unit of time used to measure the time within which the product can be returned."
182                },
183                "allow_partial_return": {
184                  "type": "boolean",
185                  "description": "Flag indicating if partial return of bundle child product is allowed or not."
186                }
187              },
188              "description": "Return policy information for the product."
189            },
190            "departments": {
191              "type": "array",
192              "items": {
193                "type": "integer",
194                "description": "Departments associated with the product"
195              },
196              "description": "List of department IDs associated with the product."
197            },
198            "product_publish": {
199              "type": "object",
200              "required": [
201                "product_online_date",
202                "is_set"
203              ],
204              "properties": {
205                "product_online_date": {
206                  "type": "string",
207                  "description": "Unix timestamp indicating the date and time when the product was published online."
208                },
209                "is_set": {
210                  "type": "boolean",
211                  "description": "Flag to indicate if the product is published online or not."
212                }
213              },
214              "description": "Information about the product publication status."
215            },
216            "is_dependent": {
217              "type": "boolean",
218              "description": "Flag to indicate if the product is dependent on other products or not."
219            },
220            "highlights": {
221              "type": "array",
222              "items": {
223                "type": "string",
224                "description": "Highlights or features of the product"
225              },
226              "description": "A list of highlights or special features associated with the product."
227            },
228            "change_request_id": {
229              "type": "string",
230              "description": "ID of the change request associated with the product update."
231            },
232            "size_guide": {
233              "type": "string",
234              "description": "URL to the size guide for the product."
235            },
236            "no_of_boxes": {
237              "type": "integer",
238              "description": "Number of boxes containing the product."
239            },
240            "company_id": {
241              "type": "integer",
242              "description": "ID of the company associated with the product."
243            },
244            "variants": {
245              "type": "object",
246              "additionalProperties": true,
247              "description": "A dictionary of product variants, where the keys are variant names and the values are variant details."
248            },
249            "category_slug": {
250              "type": "string",
251              "description": "Slug of the category associated with the product."
252            },
253            "media": {
254              "type": "array",
255              "items": {
256                "type": "object",
257                "properties": {
258                  "type": {
259                    "type": "string"
260                  },
261                  "url": {
262                    "type": "string"
263                  }
264                },
265                "description": "Media URLs associated with the product"
266              },
267              "description": "List of media information associated with the product."
268            },
269            "uid": {
270              "type": "integer",
271              "description": "The unique identifier of the product."
272            },
273            "template_tag": {
274              "type": "string",
275              "description": "The tag used for the product template."
276            },
277            "short_description": {
278              "type": "string",
279              "description": "A short description of the product, limited to 50 characters."
280            },
281            "category_uid": {
282              "type": "integer",
283              "description": "The unique identifier of the category that the product belongs to."
284            },
285            "item_code": {
286              "type": "string",
287              "description": "Item code for the product."
288            },
289            "multi_size": {
290              "type": "boolean",
291              "description": "Flag to indicate if the product has multiple sizes or not."
292            },
293            "is_set": {
294              "type": "boolean",
295              "description": "Flag to indicate if the product is a set or not."
296            },
297            "net_quantity": {
298              "description": "Net quantity details for the product.",
299              "type": "object",
300              "properties": {
301                "unit": {
302                  "type": "string",
303                  "description": "Specifies the unit of measurement for the net quantity."
304                },
305                "value": {
306                  "type": "number",
307                  "description": "The numerical value representing the net quantity of the product"
308                }
309              }
310            },
311            "brand_uid": {
312              "type": "integer",
313              "description": "Unique ID of the brand associated with the product."
314            },
315            "is_active": {
316              "type": "boolean",
317              "description": "A boolean indicating whether the product is currently active or not."
318            },
319            "is_image_less_product": {
320              "type": "boolean",
321              "description": "Flag to indicate if the product has no image or not."
322            },
323            "attributes": {
324              "type": "object",
325              "additionalProperties": true,
326              "description": "Attributes of the product."
327            },
328            "custom_order": {
329              "type": "object",
330              "required": [
331                "manufacturing_time_unit",
332                "is_custom_order",
333                "manufacturing_time"
334              ],
335              "properties": {
336                "manufacturing_time_unit": {
337                  "type": "string",
338                  "description": "The unit of time used to measure the time required to manufacture the product."
339                },
340                "is_custom_order": {
341                  "type": "boolean",
342                  "description": "Flag indicating if the product is a custom order or not."
343                },
344                "manufacturing_time": {
345                  "type": "integer",
346                  "description": "The time required to manufacture the product, in the specified time unit."
347                }
348              },
349              "description": "Custom order information for the product."
350            },
351            "tax_identifier": {
352              "type": "object",
353              "properties": {
354                "hsn_code": {
355                  "type": "string",
356                  "description": "The HSN (Harmonized System of Nomenclature) code associated with the product."
357                },
358                "hsn_code_id": {
359                  "type": "string",
360                  "description": "ID of the HSN code associated with the product."
361                },
362                "reporting_hsn": {
363                  "type": "string",
364                  "description": "Reporting HSN for the product."
365                },
366                "tax_rule_id": {
367                  "type": "string",
368                  "description": "ID of the tax rule associated with the product."
369                }
370              },
371              "description": "Tax identifier for the product."
372            },
373            "hs_code": {
374              "type": [
375                "string",
376                "null"
377              ],
378              "description": "The HS Code (Harmonized System of Nomenclature) code associated with the product."
379            },
380            "country_of_origin": {
381              "type": "string",
382              "description": "Country of origin for the product."
383            },
384            "item_type": {
385              "type": "string",
386              "description": "Type of the product."
387            },
388            "_custom_json": {
389              "type": "object",
390              "description": "A dictionary of custom JSON data associated with the product."
391            },
392            "bundle_details": {
393              "type": "array",
394              "description": "An array of bundle child sku details. This will have child skus along with net quantity used in bundle formation.",
395              "items": {
396                "type": "object",
397                "properties": {
398                  "is_base": {
399                    "type": "boolean",
400                    "description": "A flag that determines if child product is base product of bundle."
401                  },
402                  "seller_identifier": {
403                    "type": "string",
404                    "description": "Seller Identifier of the bundle child product."
405                  },
406                  "net_quantity": {
407                    "type": "number",
408                    "description": "Net quantity of the bundle child product."
409                  }
410                }
411              }
412            },
413            "use_individual_product_packaging": {
414              "type": "boolean",
415              "description": "Flag indicating if individual product packaging should be used instead of bundle packaging."
416            }
417          },
418          "description": "Information about a product."
419        }
420      }
421    }
422  }
423}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.50d4dff6-f1ef-11ee-b8ab-6e67a317dc8d"
5    ],
6    "name": "product",
7    "type": "update",
8    "version": "3",
9    "created_timestamp": 1712172065067,
10    "id": "HIGFyd5dMpB8lxOHoMYx5JOfq/pafoqsCo0/UFzDOMw=",
11    "category": "company"
12  },
13  "company_id": 6065,
14  "contains": [
15    "product"
16  ],
17  "payload": {
18    "product": {
19      "brand_uid": 7450,
20      "category_slug": "sling-bags",
21      "name": "What a Click Bestie",
22      "attributes": {
23        "color": "Pastel Pink",
24        "primary_color": "Pink",
25        "net-quantity": "1 N",
26        "marketer-address": "New Delhi",
27        "primary_material": "Plastic",
28        "marketer-name": "Pretty Please",
29        "essential": "No",
30        "gender": [
31          "Women"
32        ]
33      },
34      "media": [
35        {
36          "type": "image",
37          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/RDfLeAu98-What-a-Click-Bestie.jpeg"
38        },
39        {
40          "type": "image",
41          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/oZac3z5Rc-What-a-Click-Bestie.jpeg"
42        },
43        {
44          "type": "image",
45          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/nPP6FhSfs-What-a-Click-Bestie.jpeg"
46        }
47      ],
48      "custom_order": {
49        "manufacturing_time_unit": "days",
50        "is_custom_order": false,
51        "manufacturing_time": 0
52      },
53      "size_guide": "",
54      "highlights": [],
55      "is_image_less_product": false,
56      "return_config": {
57        "unit": "days",
58        "returnable": false,
59        "time": 0
60      },
61      "item_type": "standard",
62      "slug": "what-a-click-bestie-9739009",
63      "no_of_boxes": 1,
64      "is_active": true,
65      "uid": 9739009,
66      "net_quantity": {},
67      "is_set": false,
68      "trader": [
69        {
70          "name": "Pretty Please",
71          "type": "Manufacturer",
72          "address": [
73            "New Delhi"
74          ]
75        }
76      ],
77      "template_tag": "bags",
78      "variants": {
79        "primary_color": [
80          "PA-13",
81          "PA-12"
82        ]
83      },
84      "departments": [
85        21
86      ],
87      "product_publish": {
88        "product_online_date": "2023-11-04T21:42:29.788000+00:00",
89        "is_set": false
90      },
91      "tags": [],
92      "company_id": 6065,
93      "tax_identifier": {
94        "hsn_code": "42021290",
95        "hsn_code_id": "6277846d5e4c6fdbc8be5472",
96        "reporting_hsn": "42021290H1",
97        "tax_rule_id": "6277846d5e4c6fdbc8be5472"
98      },
99      "hs_code": "42021290",
100      "currency": "INR",
101      "category_uid": 352,
102      "short_description": "",
103      "description": "This Bag exude effortless elegance, adding a touch of sophistication to your party look.",
104      "item_code": "PA-14",
105      "multi_size": true,
106      "is_dependent": false,
107      "country_of_origin": "India"
108    }
109  }
110}

Product/product/delete/v3

this event is triggered when product is deleted

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
product
object
Required
Information about a product.
Properties
uid
integer
Required
The unique identifier of the product.
company_id
integer
Required
ID of the company associated with the product.
archived_by
object
Information about the user who archived the product.
Properties
user_id
string
Unique identifier of the user who archived the product.
brand_uid
integer
Required
Unique ID of the brand associated with the product.
item_code
string
Required
Item code for the product.
archived_on
string
timestamp indicating the date and time when the product was archived.
trader
array of object
Trader associated with the product.
Array of Properties
address
array of string
name
string
Name of the trader
type
string
Type of trader (e.g., Manufacturer, Importer, Packer)
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        "product"
70      ],
71      "properties": {
72        "product": {
73          "type": "object",
74          "required": [
75            "uid",
76            "company_id",
77            "brand_uid",
78            "item_code"
79          ],
80          "properties": {
81            "uid": {
82              "type": "integer",
83              "description": "The unique identifier of the product."
84            },
85            "company_id": {
86              "type": "integer",
87              "description": "ID of the company associated with the product."
88            },
89            "archived_by": {
90              "type": "object",
91              "properties": {
92                "user_id": {
93                  "type": "string",
94                  "description": "Unique identifier of the user who archived the product."
95                }
96              },
97              "description": "Information about the user who archived the product."
98            },
99            "brand_uid": {
100              "type": "integer",
101              "description": "Unique ID of the brand associated with the product."
102            },
103            "item_code": {
104              "type": "string",
105              "description": "Item code for the product."
106            },
107            "archived_on": {
108              "type": "string",
109              "description": "timestamp indicating the date and time when the product was archived."
110            },
111            "trader": {
112              "type": "array",
113              "items": {
114                "type": "object",
115                "properties": {
116                  "address": {
117                    "type": "array",
118                    "items": {
119                      "type": "string"
120                    }
121                  },
122                  "name": {
123                    "type": "string",
124                    "description": "Name of the trader"
125                  },
126                  "type": {
127                    "type": "string",
128                    "description": "Type of trader (e.g., Manufacturer, Importer, Packer)"
129                  }
130                },
131                "description": "Details of traders associated with the product"
132              },
133              "description": "Trader associated with the product."
134            }
135          },
136          "description": "Information about a product."
137        }
138      }
139    }
140  }
141}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.cd586c62-f1ce-11ee-aa9a-d6778ce1e347"
5    ],
6    "name": "product",
7    "type": "delete",
8    "version": "3",
9    "created_timestamp": 1712158100574,
10    "id": "dL4VUszr7UM8bPlXQSPqdwrgTY4yKjEF9p/kH0Vc2m0=",
11    "category": "company"
12  },
13  "company_id": 3523,
14  "contains": [
15    "product"
16  ],
17  "payload": {
18    "product": {
19      "uid": 10124296,
20      "company_id": 3523,
21      "archived_on": "2024-04-03T15:28:20.571977Z",
22      "brand_uid": 5294,
23      "archived_by": {
24        "user_id": "f4bf0e6837690a325f35609a"
25      },
26      "item_code": "MJN-KSCN-915-LIGHT BLUE",
27      "trader": [
28        {
29          "address": [
30            "Address"
31          ],
32          "name": "Address",
33          "type": "Importer"
34        }
35      ]
36    }
37  }
38}

Previous
« logistics-configuration/update/v1
Next
product-size/create/v2 »