Application

Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.

Filter configuration

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

Events

application/filter/create/v1

# this event is triggered when filter is created

application/filter/update/v1

# this event is triggered when filter is updated

application/filter/delete/v1

# this event is triggered when filter is deleted

Filter Configuration/filter/create/v1

this event is triggered when filter is created

Payload

Hide

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

This array will have all the keys present at root level of 'payload' object

event

object

Required

Show

payload

object

Required

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "filter"
78      ],
79      "properties": {
80        "filter": {
81          "type": "object",
82          "description": "",
83          "required": [
84            "app_id",
85            "id",
86            "key",
87            "is_active",
88            "priority",
89            "is_default",
90            "allow_single",
91            "type",
92            "name",
93            "value_config"
94          ],
95          "properties": {
96            "id": {
97              "type": "string",
98              "description": "UUID of the filter config."
99            },
100            "key": {
101              "type": "string",
102              "description": "Slug of the product attribute."
103            },
104            "logo": {
105              "type": "string",
106              "description": "Logo to show for the filter in the configuration."
107            },
108            "name": {
109              "type": "string",
110              "description": "Display Name of the filter."
111            },
112            "attribute_name": {
113              "type": "string",
114              "description": "Name of the product attribute."
115            },
116            "type": {
117              "type": "string",
118              "description": "Type of the filter such as Range Slider, Custom Text, MultiValued, Custom Bucket.",
119              "enum": [
120                "range",
121                "intervals",
122                "multivalued",
123                "singlevalued"
124              ]
125            },
126            "app_id": {
127              "type": "string",
128              "description": "Unique ID of the application."
129            },
130            "priority": {
131              "type": "integer",
132              "description": "Position of the filters."
133            },
134            "is_active": {
135              "type": "boolean",
136              "description": "Active status of the filter. Turn off the filter from here."
137            },
138            "is_default": {
139              "type": "boolean",
140              "description": "Default filter values from the system."
141            },
142            "allow_single": {
143              "type": "boolean",
144              "description": "You can disable this to hide filters for a single listed "
145            },
146            "value_config": {
147              "type": "object",
148              "description": "Contains the value mapping for the custom filter.",
149              "required": [],
150              "properties": {
151                "map": {
152                  "type": "object",
153                  "additionalProperties": true,
154                  "description": "Maps the filter value to a display format based on buckets."
155                },
156                "sort": {
157                  "type": "string",
158                  "description": "Sort the filter values based on the selected criteria."
159                },
160                "condition": {
161                  "type": "string",
162                  "description": "Criteria to apply when multivalues are selected in a filter ['AND', 'OR']."
163                },
164                "value": {
165                  "type": "string",
166                  "description": "Value configuration for the filter."
167                },
168                "map_values": {
169                  "type": "array",
170                  "description": "Array of mapped values for the filter.",
171                  "items": {
172                    "type": "object"
173                  }
174                },
175                "bucket_points": {
176                  "type": "array",
177                  "description": "In case of range filter, the bucket point will represent the values of each bucket [{start, end}, {start, end}].",
178                  "items": {
179                    "type": "object",
180                    "required": [
181                      "start",
182                      "end"
183                    ],
184                    "properties": {
185                      "start": {
186                        "type": "integer",
187                        "description": "Start point of the bucket."
188                      },
189                      "end": {
190                        "type": "integer",
191                        "description": "End point of the bucket."
192                      },
193                      "display": {
194                        "type": "string",
195                        "description": "Display text for the bucket."
196                      }
197                    }
198                  }
199                }
200              }
201            }
202          }
203        }
204      }
205    }
206  }
207}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3db902e4-f2bc-11ee-b2ca-4a5bb17c04ae"
5    ],
6    "name": "filter",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712260079837,
10    "id": "KwMA/8ONiZMADtk729zTLix3Y/godP6B97+QZg1Ce24=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31",
17    "*"
18  ],
19  "contains": [
20    "filter"
21  ],
22  "payload": {
23    "filter": {
24      "is_default": false,
25      "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/test/general/free/original/samplePNG.png",
26      "key": "lera765468244320241947615",
27      "allow_single": true,
28      "is_active": true,
29      "value_config": {
30        "value": "",
31        "sort": "count",
32        "map": {},
33        "condition": "OR",
34        "bucket_points": []
35      },
36      "app_id": "660edfcaaaaa57fb0b439b31",
37      "priority": 1,
38      "name": "Lera765468244320241947615",
39      "type": "multivalued",
40      "id": "660f03dea62b335af099a5af",
41      "default_key": "lera765468244320241947615"
42    }
43  }
44}

Filter Configuration/filter/update/v1

this event is triggered when filter is updated

Payload

Hide

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

This array will have all the keys present at root level of 'payload' object

event

object

Required

Show

payload

object

Required

Show

filter

object

Required

Show

string

Required

UUID of the filter config.

key

string

Required

Slug of the product attribute.

logo

string

Logo to show for the filter in the configuration.

name

string

Required

Display Name of the filter.

type

string

Required

Type of the filter such as Range Slider, Custom Text, MultiValued, Custom Bucket.

Enum

app_id

string

Required

Unique ID of the application.

priority

integer

Required

Position of the filters.

is_active

boolean

Required

Active status of the filter. Turn off the filter from here.

is_default

boolean

Required

Default filter values from the system.

allow_single

boolean

Required

You can disable this to hide filters for a single listed

filter_types

array of string

List of supported filter types.

Enum

attr_name

string

Name of the attribute to which the filter applies.

priceRanges

array of object

Range values for price filters.

Show

addMoreCount

integer

Additional count value for the filter.

lastRangeBucket

object

Details about the last bucket range for the filter.

Show

priceRangesValue

string

Value configuration for price ranges.

value_config

object

Required

Contains the value mapping for the custom filter.

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "filter"
78      ],
79      "properties": {
80        "filter": {
81          "type": "object",
82          "description": "",
83          "required": [
84            "app_id",
85            "id",
86            "key",
87            "is_active",
88            "priority",
89            "is_default",
90            "allow_single",
91            "type",
92            "name",
93            "value_config"
94          ],
95          "properties": {
96            "id": {
97              "type": "string",
98              "description": "UUID of the filter config."
99            },
100            "key": {
101              "type": "string",
102              "description": "Slug of the product attribute."
103            },
104            "logo": {
105              "type": "string",
106              "description": "Logo to show for the filter in the configuration."
107            },
108            "name": {
109              "type": "string",
110              "description": "Display Name of the filter."
111            },
112            "type": {
113              "description": "Type of the filter such as Range Slider, Custom Text, MultiValued, Custom Bucket.",
114              "enum": [
115                "range",
116                "intervals",
117                "multivalued",
118                "singlevalued"
119              ],
120              "type": "string"
121            },
122            "app_id": {
123              "type": "string",
124              "description": "Unique ID of the application."
125            },
126            "priority": {
127              "type": "integer",
128              "description": "Position of the filters."
129            },
130            "is_active": {
131              "type": "boolean",
132              "description": "Active status of the filter. Turn off the filter from here."
133            },
134            "is_default": {
135              "type": "boolean",
136              "description": "Default filter values from the system."
137            },
138            "allow_single": {
139              "type": "boolean",
140              "description": "You can disable this to hide filters for a single listed"
141            },
142            "filter_types": {
143              "type": "array",
144              "items": {
145                "type": "string",
146                "enum": [
147                  "intervals",
148                  "multivalued",
149                  "range",
150                  "singlevalued"
151                ]
152              },
153              "description": "List of supported filter types."
154            },
155            "attr_name": {
156              "type": "string",
157              "description": "Name of the attribute to which the filter applies."
158            },
159            "priceRanges": {
160              "type": "array",
161              "description": "Range values for price filters.",
162              "items": {
163                "type": "object",
164                "properties": {
165                  "text": {
166                    "type": "string",
167                    "description": "Display text for the price range."
168                  },
169                  "value": {
170                    "type": "string",
171                    "description": "Internal value representation for the price range."
172                  }
173                }
174              }
175            },
176            "addMoreCount": {
177              "type": "integer",
178              "description": "Additional count value for the filter."
179            },
180            "lastRangeBucket": {
181              "type": "object",
182              "description": "Details about the last bucket range for the filter.",
183              "properties": {
184                "value": {
185                  "type": "number",
186                  "description": "Value of the last range bucket."
187                },
188                "display": {
189                  "type": "string",
190                  "description": "Display text for the last range bucket."
191                }
192              }
193            },
194            "priceRangesValue": {
195              "type": "string",
196              "description": "Value configuration for price ranges."
197            },
198            "value_config": {
199              "type": "object",
200              "description": "Contains the value mapping for the custom filter.",
201              "required": [],
202              "properties": {
203                "map": {
204                  "type": "object",
205                  "additionalProperties": true,
206                  "description": "Maps the filter value to a display format based on buckets."
207                },
208                "sort": {
209                  "type": "string",
210                  "description": "Sort the filter values based on the selected criteria."
211                },
212                "value": {
213                  "type": "string",
214                  "description": "Value configuration for the filter."
215                },
216                "condition": {
217                  "type": "string",
218                  "description": "Criteria to apply when multivalues are selected in a filter ['AND', 'OR']."
219                },
220                "map_values": {
221                  "type": "array",
222                  "description": "Array of mapped values for the filter.",
223                  "items": {
224                    "type": "object"
225                  }
226                },
227                "bucket_points": {
228                  "type": "array",
229                  "description": "In case of range filter, the bucket point will represent the values of each bucket [{start, end}, {start, end}].",
230                  "items": {
231                    "type": "object",
232                    "required": [],
233                    "properties": {
234                      "end": {
235                        "type": "number",
236                        "description": "End point of the bucket."
237                      },
238                      "start": {
239                        "type": "number",
240                        "description": "Start point of the bucket."
241                      },
242                      "display": {
243                        "type": "string",
244                        "description": "Display text for the bucket."
245                      }
246                    }
247                  }
248                },
249                "priority": {
250                  "type": "array",
251                  "description": "Priority of the filter values.",
252                  "items": {
253                    "type": "string"
254                  }
255                }
256              }
257            }
258          }
259        }
260      }
261    }
262  }
263}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3df9b7d0-f2bc-11ee-9e0b-3ad0e80209a5"
5    ],
6    "name": "filter",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712260080261,
10    "id": "QIKNnlUyZ7m8mmyOG7Bjs0gX7Zh5DyfsFMDEmtrq36I=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31",
17    "*"
18  ],
19  "contains": [
20    "filter"
21  ],
22  "payload": {
23    "filter": {
24      "value_config": {
25        "condition": "OR",
26        "sort": "count",
27        "value": "",
28        "map": {},
29        "bucket_points": []
30      },
31      "name": "Lera765468244320241947615",
32      "logo": "/addsale/test/general/free/original/samplePNG.png",
33      "id": "660f03ef232e18b066ffcfce",
34      "allow_single": true,
35      "is_active": false,
36      "priority": 1,
37      "is_default": false,
38      "app_id": "660edfcaaaaa57fb0b439b31",
39      "key": "lera765468244320241947615",
40      "type": "multivalued",
41      "default_key": "lera765468244320241947615"
42    }
43  }
44}

Filter Configuration/filter/delete/v1

this event is triggered when filter is deleted

Payload

Hide

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

This array will have all the keys present at root level of 'payload' object

event

object

Required

Show

payload

object

Required

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "filter"
78      ],
79      "properties": {
80        "filter": {
81          "type": "object",
82          "description": "",
83          "required": [
84            "app_id",
85            "id",
86            "key",
87            "is_active",
88            "priority",
89            "is_default",
90            "allow_single",
91            "type",
92            "name",
93            "value_config"
94          ],
95          "properties": {
96            "id": {
97              "type": "string",
98              "description": "UUID of the filter config."
99            },
100            "key": {
101              "type": "string",
102              "description": "Slug of the product attribute."
103            },
104            "logo": {
105              "type": "string",
106              "description": "Logo to show for the filter in the configuration."
107            },
108            "name": {
109              "type": "string",
110              "description": "Display Name of the filter."
111            },
112            "type": {
113              "description": "Type of the filter such as Range Slider, Custom Text, MultiValued, Custom Bucket.",
114              "enum": [
115                "range",
116                "intervals",
117                "multivalued",
118                "singlevalued"
119              ],
120              "type": "string"
121            },
122            "app_id": {
123              "type": "string",
124              "description": "Unique ID of the application."
125            },
126            "priority": {
127              "type": "integer",
128              "description": "Position of the filters."
129            },
130            "is_active": {
131              "type": "boolean",
132              "description": "Active status of the filter. Turn off the filter from here."
133            },
134            "is_default": {
135              "type": "boolean",
136              "description": "Default filter values from the system."
137            },
138            "allow_single": {
139              "type": "boolean",
140              "description": "You can disable this to hide filters for a single listed "
141            },
142            "value_config": {
143              "type": "object",
144              "required": [],
145              "description": "Contains the value mapping for the custom filter.",
146              "properties": {
147                "map": {
148                  "type": "object",
149                  "additionalProperties": true,
150                  "description": "Maps the filter value to a display format based on buckets."
151                },
152                "sort": {
153                  "type": "string",
154                  "description": "Sort the filter values based on the selected criteria."
155                },
156                "value": {
157                  "type": "string",
158                  "description": "Value configuration for the filter."
159                },
160                "condition": {
161                  "type": "string",
162                  "description": "Criteria to apply when multivalues are selected in a filter ['AND', 'OR']."
163                },
164                "map_values": {
165                  "type": "array",
166                  "description": "Array of mapped values for the filter.",
167                  "items": {
168                    "type": "object"
169                  }
170                },
171                "bucket_points": {
172                  "type": "array",
173                  "description": "In case of range filter, the bucket point will represent the values of each bucket [{start, end}, {start, end}].",
174                  "items": {
175                    "type": "object",
176                    "required": [],
177                    "properties": {
178                      "end": {
179                        "type": "number",
180                        "description": "End point of the bucket."
181                      },
182                      "start": {
183                        "type": "number",
184                        "description": "Start point of the bucket."
185                      },
186                      "display": {
187                        "type": "string",
188                        "description": "Display text for the bucket."
189                      }
190                    }
191                  }
192                }
193              }
194            }
195          }
196        }
197      }
198    }
199  }
200}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3ee17fd4-f2bc-11ee-9e0b-3ad0e80209a5"
5    ],
6    "name": "filter",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712260081780,
10    "id": "4vQFTEsbV60x7tXDHveQWP8IiSWjXXkn/oXtfi2Nz88=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31",
17    "*"
18  ],
19  "contains": [
20    "filter"
21  ],
22  "payload": {
23    "filter": {
24      "is_default": false,
25      "logo": "/addsale/test/general/free/original/samplePNG.png",
26      "key": "lera765468244320241947615",
27      "allow_single": true,
28      "is_active": true,
29      "value_config": {
30        "condition": "OR",
31        "bucket_points": [],
32        "map": {},
33        "value": "",
34        "sort": "count"
35      },
36      "app_id": "660edfcaaaaa57fb0b439b31",
37      "priority": 2,
38      "name": "Tiffany400533844320241948224",
39      "type": "multivalued",
40      "id": "660f03ef232e18b066ffcfce"
41    }
42  }
43}

« faq/create/v1

legal/update/v1 »