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.

Location

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

Events
company/location/create/v2
# this event is triggered when location is created
company/location/update/v2
# this event is triggered when location is updated

Location/location/create/v2

this event is triggered when location 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
location
object
Location Details.
Properties
product_return_config
object
Product return configuration for the location.
Properties
on_same_store
boolean
Whether return can be initiated at the same store.
contact_numbers
array of object
Contact numbers associated with the location.
Array of Properties
number
string
Contact number of the store.
country_code
integer
Country code for the contact number.
documents
array of
Documents associated with the location.
company
integer
Company associated with the location.
address
object
Address of the location.
Properties
address1
string
First line of the location address.
address2
string
Additional lines of the location address.
landmark
string
Landmark of the location address.
address_meta
object
Contains metadata about the address, like state and pincode details, for additional validation and identification.
state
string
State or Province of the location address.
country_code
string
Country code of the location address.
city
string
City of the location address.
latitude
number
Latitude of the location address.
pincode
string
Postal code of the location address.
longitude
number
Longitude of the location address.
country
string
Country of the location address.
manager
object
Manager of the location.
Properties
mobile_no
object
Mobile phone number of the location manager.
Properties
number
string
Phone number of the location manager.
country_code
integer
Country code for the mobile phone number of the location manager.
name
string
Name of the location manager.
email
string
Email address of the location manager.
avg_order_processing_time
object
Average order processing time for the location.
Properties
duration_type
string
Type of duration for the average order processing time.
duration
integer
Duration of the average order processing time.
gst_credentials
object
GST credentials for the location.
Properties
e_waybill
object
E-Waybill credentials for the location.
Properties
enabled
boolean
Flag indicating if E-Waybill is enabled for the location.
e_invoice
object
E-Invoice credentials for the location.
Properties
enabled
boolean
Flag indicating if E-Invoice is enabled for the location.
auto_assign_courier_partner
boolean
Flag indicating if auto-assignment of courier partner is enabled for the location.
auto_invoice
boolean
Flag indicating if auto invoice generation is enabled for the location.
created_on
string
The date and time when the company was created
modified_on
string
The date and time when the company was last modified
timing
array of Undefined Type
Operational timings for the location.
name
string
The original name of the location.
uid
integer
Unique identifier for the location.
stage
string
Stage of the location.
Enum
display_name
string
Display name of the location on the platform for easier identification.
credit_note
boolean
Flag indicating if credit note generation is enabled for the location.
code
string
Store Code for the location.
bulk_shipment
boolean
Flag indicating if bulk shipment is enabled for the location.
multi_piece_shipment
boolean
Flag indicating if multi-piece shipment is enabled for the location.
tags
array of
Tags associated with the location.
store_type
string
Type of the store.
Enum
warnings
object
Warnings associated with the location.
Properties
msg
string
Warnings associated with the location.
gst
string
GST verification details
store_address
string
Address-related warnings associated with the location.
order_acceptance_timing
array of object
Order acceptance timing for the location.
Array of Properties
open
boolean
weekday
string
closing
object
Properties
hour
integer
minute
integer
opening
object
Properties
hour
integer
minute
integer
default_order_acceptance_timing
boolean
Flag indicating if the default order acceptance timing is enabled for the location.
notification_emails
array of string
Email addresses for notifications related to the location.
_custom_json
object
Custom JSON data specific to the store, allowing the seller to include additional information or metadata as needed.
holiday
array of object
Array of Properties
date
object
Required
The start and end dates of the holiday.
Properties
end_date
string
| date-time
Required
The end date and time of the holiday in ISO 8601 format.
start_date
string
| date-time
Required
The start date and time of the holiday in ISO 8601 format.
title
string
Required
The name or title of the holiday.
holiday_type
string
Required
The type of holiday, either national or custom.
Enum
qc_based_return_inventory_sync
boolean
Flag for returned items to be automatically added to either sellable or damaged stock based on the good/bad QC mark for each article.
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      "properties": {
69        "location": {
70          "type": "object",
71          "properties": {
72            "product_return_config": {
73              "type": "object",
74              "properties": {
75                "on_same_store": {
76                  "type": "boolean",
77                  "description": "Whether return can be initiated at the same store."
78                }
79              },
80              "description": "Product return configuration for the location."
81            },
82            "contact_numbers": {
83              "type": "array",
84              "items": {
85                "type": "object",
86                "properties": {
87                  "number": {
88                    "type": "string",
89                    "description": "Contact number of the store."
90                  },
91                  "country_code": {
92                    "type": "integer",
93                    "description": "Country code for the contact number."
94                  }
95                }
96              },
97              "description": "Contact numbers associated with the location."
98            },
99            "documents": {
100              "type": "array",
101              "description": "Documents associated with the location."
102            },
103            "company": {
104              "type": "integer",
105              "description": "Company associated with the location."
106            },
107            "address": {
108              "type": "object",
109              "properties": {
110                "address1": {
111                  "type": "string",
112                  "description": "First line of the location address."
113                },
114                "address2": {
115                  "type": "string",
116                  "description": "Additional lines of the location address."
117                },
118                "landmark": {
119                  "type": "string",
120                  "description": "Landmark of the location address."
121                },
122                "address_meta": {
123                  "type": "object",
124                  "additionalProperties": true,
125                  "description": "Contains metadata about the address, like state and pincode details, for additional validation and identification."
126                },
127                "state": {
128                  "type": "string",
129                  "description": "State or Province of the location address."
130                },
131                "country_code": {
132                  "type": "string",
133                  "description": "Country code of the location address."
134                },
135                "city": {
136                  "type": "string",
137                  "description": "City of the location address."
138                },
139                "latitude": {
140                  "type": "number",
141                  "description": "Latitude of the location address."
142                },
143                "pincode": {
144                  "type": "string",
145                  "description": "Postal code of the location address."
146                },
147                "longitude": {
148                  "type": "number",
149                  "description": "Longitude of the location address."
150                },
151                "country": {
152                  "type": "string",
153                  "description": "Country of the location address."
154                }
155              },
156              "description": "Address of the location."
157            },
158            "manager": {
159              "type": "object",
160              "properties": {
161                "mobile_no": {
162                  "type": "object",
163                  "properties": {
164                    "number": {
165                      "type": "string",
166                      "description": "Phone number of the location manager."
167                    },
168                    "country_code": {
169                      "type": "integer",
170                      "description": "Country code for the mobile phone number of the location manager."
171                    }
172                  },
173                  "description": "Mobile phone number of the location manager."
174                },
175                "name": {
176                  "type": "string",
177                  "description": "Name of the location manager."
178                },
179                "email": {
180                  "type": "string",
181                  "description": "Email address of the location manager."
182                }
183              },
184              "description": "Manager of the location."
185            },
186            "avg_order_processing_time": {
187              "type": "object",
188              "properties": {
189                "duration_type": {
190                  "type": "string",
191                  "description": "Type of duration for the average order processing time."
192                },
193                "duration": {
194                  "type": "integer",
195                  "description": "Duration of the average order processing time."
196                }
197              },
198              "description": "Average order processing time for the location."
199            },
200            "gst_credentials": {
201              "type": "object",
202              "properties": {
203                "e_waybill": {
204                  "type": "object",
205                  "properties": {
206                    "enabled": {
207                      "type": "boolean",
208                      "description": "Flag indicating if E-Waybill is enabled for the location."
209                    }
210                  },
211                  "description": "E-Waybill credentials for the location."
212                },
213                "e_invoice": {
214                  "type": "object",
215                  "properties": {
216                    "enabled": {
217                      "type": "boolean",
218                      "description": "Flag indicating if E-Invoice is enabled for the location."
219                    }
220                  },
221                  "description": "E-Invoice credentials for the location."
222                }
223              },
224              "description": "GST credentials for the location."
225            },
226            "auto_assign_courier_partner": {
227              "type": "boolean",
228              "description": "Flag indicating if auto-assignment of courier partner is enabled for the location."
229            },
230            "auto_invoice": {
231              "type": "boolean",
232              "description": "Flag indicating if auto invoice generation is enabled for the location."
233            },
234            "created_on": {
235              "type": "string",
236              "description": "The date and time when the company was created"
237            },
238            "modified_on": {
239              "type": "string",
240              "description": "The date and time when the company was last modified"
241            },
242            "timing": {
243              "type": "array",
244              "items": [
245                {
246                  "type": "object",
247                  "properties": {
248                    "open": {
249                      "type": "boolean"
250                    },
251                    "weekday": {
252                      "type": "string"
253                    },
254                    "closing": {
255                      "type": "object",
256                      "properties": {
257                        "hour": {
258                          "type": "integer"
259                        },
260                        "minute": {
261                          "type": "integer"
262                        }
263                      }
264                    },
265                    "opening": {
266                      "type": "object",
267                      "properties": {
268                        "hour": {
269                          "type": "integer"
270                        },
271                        "minute": {
272                          "type": "integer"
273                        }
274                      }
275                    }
276                  }
277                }
278              ],
279              "description": "Operational timings for the location."
280            },
281            "name": {
282              "type": "string",
283              "description": "The original name of the location."
284            },
285            "uid": {
286              "type": "integer",
287              "description": "Unique identifier for the location."
288            },
289            "stage": {
290              "type": "string",
291              "description": "Stage of the location.",
292              "enum": [
293                "verified",
294                "complete",
295                "pending"
296              ]
297            },
298            "display_name": {
299              "type": "string",
300              "description": "Display name of the location on the platform for easier identification."
301            },
302            "credit_note": {
303              "type": "boolean",
304              "description": "Flag indicating if credit note generation is enabled for the location."
305            },
306            "code": {
307              "type": "string",
308              "description": "Store Code for the location."
309            },
310            "bulk_shipment": {
311              "type": "boolean",
312              "description": "Flag indicating if bulk shipment is enabled for the location."
313            },
314            "multi_piece_shipment": {
315              "type": "boolean",
316              "description": "Flag indicating if multi-piece shipment is enabled for the location."
317            },
318            "tags": {
319              "type": "array",
320              "description": "Tags associated with the location."
321            },
322            "store_type": {
323              "type": "string",
324              "description": "Type of the store.",
325              "enum": [
326                "high_street",
327                "mall",
328                "warehouse"
329              ]
330            },
331            "warnings": {
332              "type": "object",
333              "properties": {
334                "msg": {
335                  "type": "string",
336                  "description": "Warnings associated with the location."
337                },
338                "gst": {
339                  "type": "string",
340                  "description": "GST verification details",
341                  "example": "GST not verified."
342                },
343                "store_address": {
344                  "type": "string",
345                  "description": "Address-related warnings associated with the location."
346                }
347              },
348              "description": "Warnings associated with the location."
349            },
350            "order_acceptance_timing": {
351              "type": "array",
352              "items": {
353                "type": "object",
354                "properties": {
355                  "open": {
356                    "type": "boolean"
357                  },
358                  "weekday": {
359                    "type": "string"
360                  },
361                  "closing": {
362                    "type": "object",
363                    "properties": {
364                      "hour": {
365                        "type": "integer"
366                      },
367                      "minute": {
368                        "type": "integer"
369                      }
370                    }
371                  },
372                  "opening": {
373                    "type": "object",
374                    "properties": {
375                      "hour": {
376                        "type": "integer"
377                      },
378                      "minute": {
379                        "type": "integer"
380                      }
381                    }
382                  }
383                }
384              },
385              "description": "Order acceptance timing for the location."
386            },
387            "default_order_acceptance_timing": {
388              "type": "boolean",
389              "description": "Flag indicating if the default order acceptance timing is enabled for the location."
390            },
391            "notification_emails": {
392              "type": "array",
393              "items": {
394                "type": "string"
395              },
396              "description": "Email addresses for notifications related to the location."
397            },
398            "_custom_json": {
399              "type": "object",
400              "description": "Custom JSON data specific to the store, allowing the seller to include additional information or metadata as needed."
401            },
402            "holiday": {
403              "type": "array",
404              "items": {
405                "type": "object",
406                "description": "Defines the details of a holiday, including its title, type, and dates.",
407                "properties": {
408                  "date": {
409                    "description": "The start and end dates of the holiday.",
410                    "type": "object",
411                    "properties": {
412                      "end_date": {
413                        "type": "string",
414                        "format": "date-time",
415                        "description": "The end date and time of the holiday in ISO 8601 format."
416                      },
417                      "start_date": {
418                        "type": "string",
419                        "format": "date-time",
420                        "description": "The start date and time of the holiday in ISO 8601 format."
421                      }
422                    },
423                    "required": [
424                      "end_date",
425                      "start_date"
426                    ]
427                  },
428                  "title": {
429                    "type": "string",
430                    "description": "The name or title of the holiday."
431                  },
432                  "holiday_type": {
433                    "type": "string",
434                    "enum": [
435                      "national",
436                      "custom"
437                    ],
438                    "description": "The type of holiday, either national or custom."
439                  }
440                },
441                "required": [
442                  "date",
443                  "holiday_type",
444                  "title"
445                ]
446              }
447            },
448            "qc_based_return_inventory_sync": {
449              "type": "boolean",
450              "description": "Flag for returned items to be automatically added to either sellable or damaged stock based on the good/bad QC mark for each article."
451            }
452          },
453          "description": "Location Details."
454        }
455      }
456    }
457  }
458}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "viking-utils.90aa0b6e-f308-11ee-a983-46abbc8259d6"
5    ],
6    "name": "location",
7    "type": "create",
8    "version": "2",
9    "created_timestamp": 1712292860741,
10    "id": "yi3B3NvHmHP0ac+g4YpCdyU1uPExMbGrK7AF3lzS5ws=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26167,
15  "contains": [
16    "location"
17  ],
18  "payload": {
19    "location": {
20      "avg_order_processing_time": {
21        "duration_type": "days",
22        "duration": 1
23      },
24      "contact_numbers": [
25        {
26          "country_code": 971,
27          "number": "8888888888"
28        }
29      ],
30      "display_name": "Brunt Test Company - 1712292860463",
31      "tags": [],
32      "manager": {
33        "mobile_no": {
34          "country_code": 971,
35          "number": "8888888888"
36        },
37        "name": "sandbox user",
38        "email": "test@example.com"
39      },
40      "stage": "complete",
41      "default_order_acceptance_timing": true,
42      "store_type": "high_street",
43      "name": "Brunt Test Company - 1712292860463",
44      "bulk_shipment": false,
45      "multi_piece_shipment": false,
46      "order_acceptance_timing": [
47        {
48          "closing": {
49            "minute": 30,
50            "hour": 21
51          },
52          "weekday": "monday",
53          "open": true,
54          "opening": {
55            "minute": 0,
56            "hour": 11
57          }
58        },
59        {
60          "closing": {
61            "minute": 30,
62            "hour": 21
63          },
64          "weekday": "tuesday",
65          "open": true,
66          "opening": {
67            "minute": 0,
68            "hour": 11
69          }
70        },
71        {
72          "closing": {
73            "minute": 30,
74            "hour": 21
75          },
76          "weekday": "wednesday",
77          "open": true,
78          "opening": {
79            "minute": 0,
80            "hour": 11
81          }
82        },
83        {
84          "closing": {
85            "minute": 30,
86            "hour": 21
87          },
88          "weekday": "thursday",
89          "open": true,
90          "opening": {
91            "minute": 0,
92            "hour": 11
93          }
94        },
95        {
96          "closing": {
97            "minute": 30,
98            "hour": 21
99          },
100          "weekday": "friday",
101          "open": true,
102          "opening": {
103            "minute": 0,
104            "hour": 11
105          }
106        },
107        {
108          "closing": {
109            "minute": 30,
110            "hour": 21
111          },
112          "weekday": "saturday",
113          "open": true,
114          "opening": {
115            "minute": 0,
116            "hour": 11
117          }
118        },
119        {
120          "closing": {
121            "minute": 30,
122            "hour": 21
123          },
124          "weekday": "sunday",
125          "open": true,
126          "opening": {
127            "minute": 0,
128            "hour": 11
129          }
130        }
131      ],
132      "auto_invoice": false,
133      "company": 26167,
134      "gst_credentials": {
135        "e_waybill": {
136          "enabled": false
137        },
138        "e_invoice": {
139          "enabled": false
140        }
141      },
142      "warnings": {},
143      "uid": 55905,
144      "product_return_config": {
145        "on_same_store": true
146      },
147      "credit_note": false,
148      "address": {
149        "address1": "POLARIS",
150        "latitude": 19.0653252,
151        "longitude": 72.8423802,
152        "country_code": "AE",
153        "country": "UNITED ARAB EMIRATES",
154        "sector": "AL AAHAD AREA",
155        "city": "SHARJAH"
156      },
157      "documents": [],
158      "notification_emails": [
159        "test@example.com"
160      ],
161      "auto_assign_courier_partner": true,
162      "timing": [
163        {
164          "closing": {
165            "minute": 30,
166            "hour": 21
167          },
168          "weekday": "monday",
169          "open": true,
170          "opening": {
171            "minute": 0,
172            "hour": 11
173          }
174        },
175        {
176          "closing": {
177            "minute": 30,
178            "hour": 21
179          },
180          "weekday": "tuesday",
181          "open": true,
182          "opening": {
183            "minute": 0,
184            "hour": 11
185          }
186        },
187        {
188          "closing": {
189            "minute": 30,
190            "hour": 21
191          },
192          "weekday": "wednesday",
193          "open": true,
194          "opening": {
195            "minute": 0,
196            "hour": 11
197          }
198        },
199        {
200          "closing": {
201            "minute": 30,
202            "hour": 21
203          },
204          "weekday": "thursday",
205          "open": true,
206          "opening": {
207            "minute": 0,
208            "hour": 11
209          }
210        },
211        {
212          "closing": {
213            "minute": 30,
214            "hour": 21
215          },
216          "weekday": "friday",
217          "open": true,
218          "opening": {
219            "minute": 0,
220            "hour": 11
221          }
222        },
223        {
224          "closing": {
225            "minute": 30,
226            "hour": 21
227          },
228          "weekday": "saturday",
229          "open": true,
230          "opening": {
231            "minute": 0,
232            "hour": 11
233          }
234        },
235        {
236          "closing": {
237            "minute": 30,
238            "hour": 21
239          },
240          "weekday": "sunday",
241          "open": true,
242          "opening": {
243            "minute": 0,
244            "hour": 11
245          }
246        }
247      ],
248      "code": "HS-d4ab1"
249    }
250  }
251}

Location/location/update/v2

this event is triggered when location 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
location
object
Location Details.
Properties
product_return_config
object
Product return configuration for the location.
Properties
on_same_store
boolean
Whether return can be initiated at the same store.
warnings
object
Warnings associated with the location.
Properties
msg
string
Warnings associated with the location.
gst
string
GST verification details
store_address
string
Address-related warnings associated with the location.
manager
object
Manager of the location.
Properties
mobile_no
object
Mobile phone number of the location manager.
Properties
country_code
integer
Country code for the mobile phone number of the location manager.
number
string
Phone number of the location manager.
email
string
Email address of the location manager.
name
string
Name of the location manager.
uid
integer
Unique identifier for the location.
order_acceptance_timing
array of object
Order acceptance timing for the location.
Array of Properties
closing
object
Closing time of the store for a specific day.
Properties
minute
integer
Closing minute of the store's operational hours.
hour
integer
Closing hour of the store's operational hours.
opening
object
Opening time of the store for a specific day.
Properties
minute
integer
Opening minute of the store's operational hours.
hour
integer
Opening hour of the store's operational hours.
open
boolean
Flag indicating if the store is open on a specific day.
weekday
string
Specific day of the week.
bulk_shipment
boolean
Flag indicating if bulk shipment is enabled for the location.
multi_piece_shipment
boolean
Flag indicating if multi-piece shipment is enabled for the location.
auto_invoice
boolean
Flag indicating if auto invoice generation is enabled for the location.
created_on
string
The date and time when the company was created
modified_on
string
The date and time when the company was last modified
credit_note
boolean
Flag indicating if credit note generation is enabled for the location.
avg_order_processing_time
object
Average order processing time for the location.
Properties
duration_type
string
Type of duration for the average order processing time.
duration
integer
Duration of the average order processing time.
documents
array of Undefined Type
Documents associated with the location.
default_order_acceptance_timing
boolean
Flag indicating if the default order acceptance timing is enabled for the location.
auto_assign_courier_partner
boolean
Flag indicating if auto-assignment of courier partner is enabled for the location.
address
object
Address of the location.
Properties
pincode
string
Postal code of the location address.
latitude
number
Latitude of the location address.
country_code
string
Country code of the location address.
country
string
Country of the location address.
address1
string
First line of the location address.
address2
string
Additional lines of the location address.
landmark
string
Landmark of the location address.
address_meta
object
Contains metadata about the address, like state and pincode details, for additional validation and identification.
longitude
number
Longitude of the location address.
city
string
City of the location address.
state
string
State or Province of the location address.
notification_emails
array of string
Email addresses for notifications related to the location.
company
integer
Company associated with the location.
display_name
string
Display name of the location.
store_type
string
Type of the store.
Enum
stage
string
Stage of the location.
name
string
Name of the location.
code
string
Store Code for the location.
contact_numbers
array of Undefined Type
Contact numbers associated with the location.
gst_credentials
object
GST credentials for the location.
Properties
e_invoice
object
E-Invoice credentials for the location.
Properties
enabled
boolean
Flag indicating if E-Invoice is enabled for the location.
e_waybill
object
E-Waybill credentials for the location.
Properties
enabled
boolean
Flag indicating if E-Waybill is enabled for the location.
timing
array of Undefined Type
Operational timings for the location.
tags
array of string
Tags associated with the location.
verified_on
string
Timestamp for when the location was verified.
verified_by
object
User who verified the location.
Properties
user_id
string
User ID of the user who verified the location.
_custom_json
object
Custom JSON data specific to the store, allowing the seller to include additional information or metadata as needed.
holiday
array of object
Array of Properties
date
object
Required
The start and end dates of the holiday.
Properties
end_date
string
| date-time
Required
The end date and time of the holiday in ISO 8601 format.
start_date
string
| date-time
Required
The start date and time of the holiday in ISO 8601 format.
title
string
Required
The name or title of the holiday.
holiday_type
string
Required
The type of holiday, either national or custom.
Enum
qc_based_return_inventory_sync
boolean
Flag for returned items to be automatically added to either sellable or damaged stock based on the good/bad QC mark for each article.
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      "properties": {
69        "location": {
70          "type": "object",
71          "properties": {
72            "product_return_config": {
73              "type": "object",
74              "properties": {
75                "on_same_store": {
76                  "type": "boolean",
77                  "description": "Whether return can be initiated at the same store."
78                }
79              },
80              "description": "Product return configuration for the location."
81            },
82            "warnings": {
83              "type": "object",
84              "properties": {
85                "msg": {
86                  "type": "string",
87                  "description": "Warnings associated with the location."
88                },
89                "gst": {
90                  "type": "string",
91                  "description": "GST verification details",
92                  "example": "GST not verified."
93                },
94                "store_address": {
95                  "type": "string",
96                  "description": "Address-related warnings associated with the location."
97                }
98              },
99              "description": "Warnings associated with the location."
100            },
101            "manager": {
102              "type": "object",
103              "properties": {
104                "mobile_no": {
105                  "type": "object",
106                  "properties": {
107                    "country_code": {
108                      "type": "integer",
109                      "description": "Country code for the mobile phone number of the location manager."
110                    },
111                    "number": {
112                      "type": "string",
113                      "description": "Phone number of the location manager."
114                    }
115                  },
116                  "description": "Mobile phone number of the location manager."
117                },
118                "email": {
119                  "type": "string",
120                  "description": "Email address of the location manager."
121                },
122                "name": {
123                  "type": "string",
124                  "description": "Name of the location manager."
125                }
126              },
127              "description": "Manager of the location."
128            },
129            "uid": {
130              "type": "integer",
131              "description": "Unique identifier for the location."
132            },
133            "order_acceptance_timing": {
134              "type": "array",
135              "items": {
136                "type": "object",
137                "properties": {
138                  "closing": {
139                    "type": "object",
140                    "properties": {
141                      "minute": {
142                        "type": "integer",
143                        "description": "Closing minute of the store's operational hours."
144                      },
145                      "hour": {
146                        "type": "integer",
147                        "description": "Closing hour of the store's operational hours."
148                      }
149                    },
150                    "description": "Closing time of the store for a specific day."
151                  },
152                  "opening": {
153                    "type": "object",
154                    "properties": {
155                      "minute": {
156                        "type": "integer",
157                        "description": "Opening minute of the store's operational hours."
158                      },
159                      "hour": {
160                        "type": "integer",
161                        "description": "Opening hour of the store's operational hours."
162                      }
163                    },
164                    "description": "Opening time of the store for a specific day."
165                  },
166                  "open": {
167                    "type": "boolean",
168                    "description": "Flag indicating if the store is open on a specific day."
169                  },
170                  "weekday": {
171                    "type": "string",
172                    "description": "Specific day of the week."
173                  }
174                },
175                "description": "Describes the store's operational hours for each day of the week."
176              },
177              "description": "Order acceptance timing for the location."
178            },
179            "bulk_shipment": {
180              "type": "boolean",
181              "description": "Flag indicating if bulk shipment is enabled for the location."
182            },
183            "multi_piece_shipment": {
184              "type": "boolean",
185              "description": "Flag indicating if multi-piece shipment is enabled for the location."
186            },
187            "auto_invoice": {
188              "type": "boolean",
189              "description": "Flag indicating if auto invoice generation is enabled for the location."
190            },
191            "created_on": {
192              "type": "string",
193              "description": "The date and time when the company was created"
194            },
195            "modified_on": {
196              "type": "string",
197              "description": "The date and time when the company was last modified"
198            },
199            "credit_note": {
200              "type": "boolean",
201              "description": "Flag indicating if credit note generation is enabled for the location."
202            },
203            "avg_order_processing_time": {
204              "type": "object",
205              "properties": {
206                "duration_type": {
207                  "type": "string",
208                  "description": "Type of duration for the average order processing time."
209                },
210                "duration": {
211                  "type": "integer",
212                  "description": "Duration of the average order processing time."
213                }
214              },
215              "description": "Average order processing time for the location."
216            },
217            "documents": {
218              "type": "array",
219              "items": {},
220              "description": "Documents associated with the location."
221            },
222            "default_order_acceptance_timing": {
223              "type": "boolean",
224              "description": "Flag indicating if the default order acceptance timing is enabled for the location."
225            },
226            "auto_assign_courier_partner": {
227              "type": "boolean",
228              "description": "Flag indicating if auto-assignment of courier partner is enabled for the location."
229            },
230            "address": {
231              "type": "object",
232              "properties": {
233                "pincode": {
234                  "type": "string",
235                  "description": "Postal code of the location address."
236                },
237                "latitude": {
238                  "type": "number",
239                  "description": "Latitude of the location address."
240                },
241                "country_code": {
242                  "type": "string",
243                  "description": "Country code of the location address."
244                },
245                "country": {
246                  "type": "string",
247                  "description": "Country of the location address."
248                },
249                "address1": {
250                  "type": "string",
251                  "description": "First line of the location address."
252                },
253                "address2": {
254                  "type": "string",
255                  "description": "Additional lines of the location address."
256                },
257                "landmark": {
258                  "type": "string",
259                  "description": "Landmark of the location address."
260                },
261                "address_meta": {
262                  "type": "object",
263                  "additionalProperties": true,
264                  "description": "Contains metadata about the address, like state and pincode details, for additional validation and identification."
265                },
266                "longitude": {
267                  "type": "number",
268                  "description": "Longitude of the location address."
269                },
270                "city": {
271                  "type": "string",
272                  "description": "City of the location address."
273                },
274                "state": {
275                  "type": "string",
276                  "description": "State or Province of the location address."
277                }
278              },
279              "description": "Address of the location."
280            },
281            "notification_emails": {
282              "type": "array",
283              "items": {
284                "type": "string"
285              },
286              "description": "Email addresses for notifications related to the location."
287            },
288            "company": {
289              "type": "integer",
290              "description": "Company associated with the location."
291            },
292            "display_name": {
293              "type": "string",
294              "description": "Display name of the location."
295            },
296            "store_type": {
297              "type": "string",
298              "description": "Type of the store.",
299              "enum": [
300                "high_street",
301                "mall",
302                "warehouse"
303              ]
304            },
305            "stage": {
306              "type": "string",
307              "description": "Stage of the location."
308            },
309            "name": {
310              "type": "string",
311              "description": "Name of the location."
312            },
313            "code": {
314              "type": "string",
315              "description": "Store Code for the location."
316            },
317            "contact_numbers": {
318              "type": "array",
319              "items": [
320                {
321                  "type": "object",
322                  "properties": {
323                    "country_code": {
324                      "type": "integer"
325                    },
326                    "number": {
327                      "type": "string"
328                    }
329                  }
330                }
331              ],
332              "description": "Contact numbers associated with the location."
333            },
334            "gst_credentials": {
335              "type": "object",
336              "properties": {
337                "e_invoice": {
338                  "type": "object",
339                  "properties": {
340                    "enabled": {
341                      "type": "boolean",
342                      "description": "Flag indicating if E-Invoice is enabled for the location."
343                    }
344                  },
345                  "description": "E-Invoice credentials for the location."
346                },
347                "e_waybill": {
348                  "type": "object",
349                  "properties": {
350                    "enabled": {
351                      "type": "boolean",
352                      "description": "Flag indicating if E-Waybill is enabled for the location."
353                    }
354                  },
355                  "description": "E-Waybill credentials for the location."
356                }
357              },
358              "description": "GST credentials for the location."
359            },
360            "timing": {
361              "type": "array",
362              "items": [
363                {
364                  "type": "object",
365                  "properties": {
366                    "closing": {
367                      "type": "object",
368                      "properties": {
369                        "minute": {
370                          "type": "integer"
371                        },
372                        "hour": {
373                          "type": "integer"
374                        }
375                      }
376                    },
377                    "opening": {
378                      "type": "object",
379                      "properties": {
380                        "minute": {
381                          "type": "integer"
382                        },
383                        "hour": {
384                          "type": "integer"
385                        }
386                      }
387                    },
388                    "open": {
389                      "type": "boolean"
390                    },
391                    "weekday": {
392                      "type": "string"
393                    }
394                  }
395                }
396              ],
397              "description": "Operational timings for the location."
398            },
399            "tags": {
400              "type": "array",
401              "items": {
402                "type": "string"
403              },
404              "description": "Tags associated with the location."
405            },
406            "verified_on": {
407              "type": "string",
408              "description": "Timestamp for when the location was verified."
409            },
410            "verified_by": {
411              "type": "object",
412              "properties": {
413                "user_id": {
414                  "type": "string",
415                  "description": "User ID of the user who verified the location."
416                }
417              },
418              "description": "User who verified the location."
419            },
420            "_custom_json": {
421              "type": "object",
422              "description": "Custom JSON data specific to the store, allowing the seller to include additional information or metadata as needed."
423            },
424            "holiday": {
425              "type": "array",
426              "items": {
427                "type": "object",
428                "description": "Defines the details of a holiday, including its title, type, and dates.",
429                "properties": {
430                  "date": {
431                    "description": "The start and end dates of the holiday.",
432                    "type": "object",
433                    "properties": {
434                      "end_date": {
435                        "type": "string",
436                        "format": "date-time",
437                        "description": "The end date and time of the holiday in ISO 8601 format."
438                      },
439                      "start_date": {
440                        "type": "string",
441                        "format": "date-time",
442                        "description": "The start date and time of the holiday in ISO 8601 format."
443                      }
444                    },
445                    "required": [
446                      "end_date",
447                      "start_date"
448                    ]
449                  },
450                  "title": {
451                    "type": "string",
452                    "description": "The name or title of the holiday."
453                  },
454                  "holiday_type": {
455                    "type": "string",
456                    "enum": [
457                      "national",
458                      "custom"
459                    ],
460                    "description": "The type of holiday, either national or custom."
461                  }
462                },
463                "required": [
464                  "date",
465                  "holiday_type",
466                  "title"
467                ]
468              }
469            },
470            "qc_based_return_inventory_sync": {
471              "type": "boolean",
472              "description": "Flag for returned items to be automatically added to either sellable or damaged stock based on the good/bad QC mark for each article."
473            }
474          },
475          "description": "Location Details."
476        }
477      }
478    }
479  }
480}
Payload Example
1{
2  "company_id": 680,
3  "contains": [
4    "location"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1712296806094,
9    "id": "TmmvBJ5721ruRBSryU9pJnW9I/I76uDnFcA5Kwv73vk=",
10    "name": "location",
11    "trace_id": [
12      "WheelJack.c04725e2-f311-11ee-8496-f67d79aa4477"
13    ],
14    "type": "update",
15    "version": "2"
16  },
17  "payload": {
18    "location": {
19      "address": {
20        "address1": "dummy address",
21        "city": "West Delhi",
22        "country": "India",
23        "country_code": "IN",
24        "latitude": 19.0653252,
25        "longitude": 72.8423802,
26        "pincode": 110041,
27        "state": "Delhi"
28      },
29      "auto_assign_courier_partner": false,
30      "auto_invoice": true,
31      "avg_order_processing_time": {
32        "duration": 48,
33        "duration_type": "hours"
34      },
35      "bulk_shipment": true,
36      "multi_piece_shipment": false,
37      "code": "CAPL68003",
38      "company": 680,
39      "contact_numbers": [
40        {
41          "country_code": 91,
42          "number": "8888888888"
43        }
44      ],
45      "credit_note": true,
46      "default_order_acceptance_timing": true,
47      "display_name": "Mundka1",
48      "documents": [
49        {
50          "legal_name": "CAMPUS ACTIVEWEAR LIMITED",
51          "type": "gst",
52          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/680/stores/all/legal/documents/free/original/67hihLcgh-GST.pdf",
53          "value": "07AAHCA3072C1Z3",
54          "verified": true
55        }
56      ],
57      "gst_credentials": {
58        "e_invoice": {
59          "enabled": false
60        },
61        "e_waybill": {
62          "enabled": false
63        }
64      },
65      "holiday": [],
66      "manager": {
67        "email": "test@example.com",
68        "mobile_no": {
69          "country_code": 91,
70          "number": "8888888888"
71        },
72        "name": "AJAY"
73      },
74      "name": "Mundka1",
75      "notification_emails": [
76        "test@example.com"
77      ],
78      "order_acceptance_timing": [
79        {
80          "closing": {
81            "hour": 22,
82            "minute": 0
83          },
84          "open": true,
85          "opening": {
86            "hour": 11,
87            "minute": 0
88          },
89          "weekday": "monday"
90        },
91        {
92          "closing": {
93            "hour": 22,
94            "minute": 0
95          },
96          "open": true,
97          "opening": {
98            "hour": 11,
99            "minute": 0
100          },
101          "weekday": "tuesday"
102        },
103        {
104          "closing": {
105            "hour": 22,
106            "minute": 0
107          },
108          "open": true,
109          "opening": {
110            "hour": 11,
111            "minute": 0
112          },
113          "weekday": "wednesday"
114        },
115        {
116          "closing": {
117            "hour": 22,
118            "minute": 0
119          },
120          "open": true,
121          "opening": {
122            "hour": 11,
123            "minute": 0
124          },
125          "weekday": "thursday"
126        },
127        {
128          "closing": {
129            "hour": 22,
130            "minute": 0
131          },
132          "open": true,
133          "opening": {
134            "hour": 11,
135            "minute": 0
136          },
137          "weekday": "friday"
138        },
139        {
140          "closing": {
141            "hour": 22,
142            "minute": 0
143          },
144          "open": true,
145          "opening": {
146            "hour": 11,
147            "minute": 0
148          },
149          "weekday": "saturday"
150        },
151        {
152          "closing": {
153            "hour": 22,
154            "minute": 0
155          },
156          "open": false,
157          "opening": {
158            "hour": 11,
159            "minute": 0
160          },
161          "weekday": "sunday"
162        }
163      ],
164      "product_return_config": {
165        "on_same_store": true
166      },
167      "stage": "verified",
168      "store_type": "warehouse",
169      "tags": [],
170      "timing": [
171        {
172          "closing": {
173            "hour": 22,
174            "minute": 0
175          },
176          "open": true,
177          "opening": {
178            "hour": 11,
179            "minute": 0
180          },
181          "weekday": "monday"
182        },
183        {
184          "closing": {
185            "hour": 22,
186            "minute": 0
187          },
188          "open": true,
189          "opening": {
190            "hour": 11,
191            "minute": 0
192          },
193          "weekday": "tuesday"
194        },
195        {
196          "closing": {
197            "hour": 22,
198            "minute": 0
199          },
200          "open": true,
201          "opening": {
202            "hour": 11,
203            "minute": 0
204          },
205          "weekday": "wednesday"
206        },
207        {
208          "closing": {
209            "hour": 22,
210            "minute": 0
211          },
212          "open": true,
213          "opening": {
214            "hour": 11,
215            "minute": 0
216          },
217          "weekday": "thursday"
218        },
219        {
220          "closing": {
221            "hour": 22,
222            "minute": 0
223          },
224          "open": true,
225          "opening": {
226            "hour": 11,
227            "minute": 0
228          },
229          "weekday": "friday"
230        },
231        {
232          "closing": {
233            "hour": 22,
234            "minute": 0
235          },
236          "open": true,
237          "opening": {
238            "hour": 11,
239            "minute": 0
240          },
241          "weekday": "saturday"
242        },
243        {
244          "closing": {
245            "hour": 22,
246            "minute": 0
247          },
248          "open": false,
249          "opening": {
250            "hour": 11,
251            "minute": 0
252          },
253          "weekday": "sunday"
254        }
255      ],
256      "uid": 22619,
257      "verified_by": {
258        "user_id": "0"
259      },
260      "verified_on": "2024-04-05T06:00:05.938631",
261      "warnings": {
262        "store_address": "Address seems to be inappropriate this might affect the delivery."
263      }
264    }
265  }
266}

Previous
« customobjects/create/v1
Next
location-price/create/v1 »