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

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.

Rma rule

This event is generated whenever any action is performed on an RMA rule. RMA (Return Merchandise Authorization) rules govern the conditions under which returns are processed, including quality checks, reasons for return, and associated actions.

Events
application/rma_rule/create/v2
# This event is triggered when an RMA rule is created (V2).
application/rma_rule/update/v2
# This event is triggered when an RMA rule is updated (V2).
application/rma_rule/create/v1
# This event is triggered when an RMA rule is created (V1).
application/rma_rule/update/v1
# This event is triggered when an RMA rule is updated (V1).

RMA rule/rma_rule/create/v2

This event is triggered when an RMA rule is created (V2).

Payload
Properties
application_id
array|string
Required
Identifier(s) of the sales channel(s) associated with the event. The event is triggered for these specific sales channels.
company_id
integer
Required
Unique identifier for the company to which the event pertains.
contains
array of string
Required
Array containing all keys present at the root level of the 'payload' object. This helps in identifying the structure of the payload.
event
object
Required
Details of the event being produced, including metadata such as event category, timestamp, and traceability information.
Properties
category
string
Required
The category of the event, which defines its scope (e.g., company-wide or specific to an application).
Enum
created_timestamp
integer
Required
Timestamp indicating when the event was generated, represented in epoch milliseconds.
id
string
Required
Unique identifier for the event. This ID can be used by receivers to check if the event has already been processed.
name
string
Required
Human-readable name for the event.
trace_id
array of string
Required
Array of internal trace IDs used by Fynd Platform services to trace the event through various processes.
type
string
Required
Action associated with the event, such as creation or update of a rule.
Enum
version
string
Required
Version of the event format, useful for handling backward compatibility.
payload
object
Required
The core content of the RMA rule (V2).
Properties
actions
object
Required
Defines the actionable reasons under this rule.
Properties
reasons
array of object
Primary reasons (and nested sub-reasons) presented during the return process.
Array of Properties
id
integer
Unique identifier for the reason.
display_name
string
Human-readable name for the reason.
qc_type
array of string
List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.
Enum
question_set
array of object
Set of questions associated with this reason, used to gather additional information necessary for the return process.
Array of Properties
id
integer
Unique identifier for the question.
display_name
string
Text of the question presented to the user.
reasons
array of object (ReasonV2)
List of sub-reasons that further detail the main reason.
Array of ReasonV2
id
integer
Unique identifier for the reason.
display_name
string
Human-readable name for the reason.
qc_type
array of string
List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.
Enum
question_set
array of object
Set of questions associated with this reason, used to gather additional information necessary for the return process.
Array of Properties
id
integer
Unique identifier for the question.
display_name
string
Text of the question presented to the user.
reasons
array of object (ReasonV2)
List of sub-reasons that further detail the main reason.
Array of ReasonV2
is_active
boolean
Flag indicating whether this reason is currently active and applicable.
qc_enabled
boolean
Indicates whether quality checks are enabled for this specific reason.
remark_required
boolean
Indicates whether a remark is required when selecting this reason.
show_text_area
boolean
Indicates whether a text area should be displayed for additional input when this reason is selected.
application_id
string|null
Identifier of the application associated with this reason, if applicable.
is_active
boolean
Flag indicating whether this reason is currently active and applicable.
qc_enabled
boolean
Indicates whether quality checks are enabled for this specific reason.
remark_required
boolean
Indicates whether a remark is required when selecting this reason.
show_text_area
boolean
Indicates whether a text area should be displayed for additional input when this reason is selected.
application_id
string|null
Identifier of the application associated with this reason, if applicable.
qc_enabled
boolean
Indicates whether quality checks are required for the rule.
is_deleted
boolean
Flag indicating whether the rule has been deleted.
name
string
Descriptive title of the RMA rule.
flow_type
string
Process flow governed by this rule.
Enum
position
integer
Ordering index for priority among multiple rules.
department
array of integer
List of department IDs to which this rule applies.
l3
array of integer
List of L3 category IDs to which this rule applies.
price_effective_min
number
Minimum effective price for which this rule applies.
price_effective_max
number
Maximum effective price for which this rule applies.
price_marked_min
number
Minimum marked price for which this rule applies.
price_marked_max
number
Maximum marked price for which this rule applies.
restrict_forward_serviceability
boolean
Controls serviceability checks for products where QC is not possible during returns. If true, restricts users from proceeding past the product display page and prevents adding these items to the cart.
tags
array of string
Optional labels for categorizing or filtering rules.
rule_type
string
Indicates if the rule is custom (scoped) or global (universal).
Enum
is_active
boolean
Flag indicating if the rule is currently active.
updated_by
string
Identifier of the last user to modify this rule.
config_id
string
Unique identifier for the configuration of the rule.
description
string
Additional details or notes about the rule.
source
string
Origin system or service that authored this rule.
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": "Identifier(s) of the sales channel(s) associated with the event. The event is triggered for these specific sales channels."
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "Unique identifier for the company to which the event pertains."
21    },
22    "contains": {
23      "type": "array",
24      "description": "Array containing all keys present at the root level of the 'payload' object. This helps in identifying the structure of the payload.",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "description": "Details of the event being produced, including metadata such as event category, timestamp, and traceability information.",
32      "required": [
33        "category",
34        "created_timestamp",
35        "id",
36        "name",
37        "trace_id",
38        "type",
39        "version"
40      ],
41      "properties": {
42        "category": {
43          "type": "string",
44          "enum": [
45            "company",
46            "application",
47            "extension",
48            "click",
49            "global"
50          ],
51          "description": "The category of the event, which defines its scope (e.g., company-wide or specific to an application)."
52        },
53        "created_timestamp": {
54          "type": "integer",
55          "description": "Timestamp indicating when the event was generated, represented in epoch milliseconds."
56        },
57        "id": {
58          "type": "string",
59          "description": "Unique identifier for the event. This ID can be used by receivers to check if the event has already been processed."
60        },
61        "name": {
62          "type": "string",
63          "description": "Human-readable name for the event."
64        },
65        "trace_id": {
66          "type": "array",
67          "description": "Array of internal trace IDs used by Fynd Platform services to trace the event through various processes.",
68          "items": {
69            "type": "string"
70          }
71        },
72        "type": {
73          "type": "string",
74          "enum": [
75            "create",
76            "update"
77          ],
78          "description": "Action associated with the event, such as creation or update of a rule."
79        },
80        "version": {
81          "type": "string",
82          "description": "Version of the event format, useful for handling backward compatibility."
83        }
84      }
85    },
86    "payload": {
87      "type": "object",
88      "description": "The core content of the RMA rule (V2).",
89      "required": [
90        "actions"
91      ],
92      "properties": {
93        "actions": {
94          "type": "object",
95          "description": "Defines the actionable reasons under this rule.",
96          "properties": {
97            "reasons": {
98              "type": "array",
99              "description": "Primary reasons (and nested sub-reasons) presented during the return process.",
100              "items": {
101                "type": "object",
102                "description": "A reason associated with the rule (V2).",
103                "properties": {
104                  "id": {
105                    "type": "integer",
106                    "description": "Unique identifier for the reason."
107                  },
108                  "display_name": {
109                    "type": "string",
110                    "description": "Human-readable name for the reason."
111                  },
112                  "qc_type": {
113                    "type": "array",
114                    "description": "List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.",
115                    "items": {
116                      "type": "string",
117                      "enum": [
118                        "pre_qc",
119                        "doorstep_qc"
120                      ]
121                    }
122                  },
123                  "question_set": {
124                    "type": "array",
125                    "description": "Set of questions associated with this reason, used to gather additional information necessary for the return process.",
126                    "items": {
127                      "type": "object",
128                      "properties": {
129                        "id": {
130                          "type": "integer",
131                          "description": "Unique identifier for the question."
132                        },
133                        "display_name": {
134                          "type": "string",
135                          "description": "Text of the question presented to the user."
136                        }
137                      }
138                    }
139                  },
140                  "reasons": {
141                    "type": "array",
142                    "description": "List of sub-reasons that further detail the main reason.",
143                    "items": {
144                      "$ref": "#/schema/schemas/ReasonV2"
145                    }
146                  },
147                  "is_active": {
148                    "type": "boolean",
149                    "description": "Flag indicating whether this reason is currently active and applicable."
150                  },
151                  "qc_enabled": {
152                    "type": "boolean",
153                    "description": "Indicates whether quality checks are enabled for this specific reason."
154                  },
155                  "remark_required": {
156                    "type": "boolean",
157                    "description": "Indicates whether a remark is required when selecting this reason."
158                  },
159                  "show_text_area": {
160                    "type": "boolean",
161                    "description": "Indicates whether a text area should be displayed for additional input when this reason is selected."
162                  },
163                  "application_id": {
164                    "type": [
165                      "string",
166                      "null"
167                    ],
168                    "description": "Identifier of the application associated with this reason, if applicable."
169                  }
170                }
171              }
172            }
173          }
174        },
175        "qc_enabled": {
176          "type": "boolean",
177          "description": "Indicates whether quality checks are required for the rule."
178        },
179        "is_deleted": {
180          "type": "boolean",
181          "description": "Flag indicating whether the rule has been deleted."
182        },
183        "name": {
184          "type": "string",
185          "description": "Descriptive title of the RMA rule."
186        },
187        "flow_type": {
188          "type": "string",
189          "enum": [
190            "return",
191            "cancel"
192          ],
193          "description": "Process flow governed by this rule."
194        },
195        "position": {
196          "type": "integer",
197          "description": "Ordering index for priority among multiple rules."
198        },
199        "department": {
200          "type": "array",
201          "items": {
202            "type": "integer"
203          },
204          "description": "List of department IDs to which this rule applies."
205        },
206        "l3": {
207          "type": "array",
208          "items": {
209            "type": "integer"
210          },
211          "description": "List of L3 category IDs to which this rule applies."
212        },
213        "price_effective_min": {
214          "type": "number",
215          "description": "Minimum effective price for which this rule applies."
216        },
217        "price_effective_max": {
218          "type": "number",
219          "description": "Maximum effective price for which this rule applies."
220        },
221        "price_marked_min": {
222          "type": "number",
223          "description": "Minimum marked price for which this rule applies."
224        },
225        "price_marked_max": {
226          "type": "number",
227          "description": "Maximum marked price for which this rule applies."
228        },
229        "restrict_forward_serviceability": {
230          "type": "boolean",
231          "description": "Controls serviceability checks for products where QC is not possible during returns. If true, restricts users from proceeding past the product display page and prevents adding these items to the cart.\n"
232        },
233        "tags": {
234          "type": "array",
235          "items": {
236            "type": "string"
237          },
238          "description": "Optional labels for categorizing or filtering rules."
239        },
240        "rule_type": {
241          "type": "string",
242          "enum": [
243            "custom",
244            "global"
245          ],
246          "description": "Indicates if the rule is custom (scoped) or global (universal)."
247        },
248        "is_active": {
249          "type": "boolean",
250          "description": "Flag indicating if the rule is currently active."
251        },
252        "updated_by": {
253          "type": "string",
254          "description": "Identifier of the last user to modify this rule."
255        },
256        "config_id": {
257          "type": "string",
258          "description": "Unique identifier for the configuration of the rule."
259        },
260        "description": {
261          "type": "string",
262          "description": "Additional details or notes about the rule."
263        },
264        "source": {
265          "type": "string",
266          "description": "Origin system or service that authored this rule."
267        }
268      }
269    }
270  },
271  "example": {
272    "application_id": [
273      "66d15d631b7211698ec0f39a"
274    ],
275    "company_id": 33708,
276    "contains": [
277      "actions",
278      "qc_enabled",
279      "name",
280      "flow_type",
281      "position",
282      "department",
283      "l3",
284      "price_effective_max",
285      "price_effective_min",
286      "rule_type",
287      "is_active",
288      "updated_by",
289      "config_id"
290    ],
291    "event": {
292      "category": "application",
293      "created_timestamp": 1745831613,
294      "id": "QsOwO98GEZml5dGw/vScF+Z+xHnDdgfSqRVjMMY/N/k=",
295      "name": "rma_rule",
296      "trace_id": [
297        "ed2d31e75b64fda48b0e531c84cc7ea1"
298      ],
299      "type": "create",
300      "version": "2"
301    },
302    "payload": {
303      "actions": {
304        "reasons": [
305          {
306            "id": 468,
307            "display_name": "Product quality issue",
308            "qc_type": [
309              "pre_qc"
310            ],
311            "question_set": [
312              {
313                "id": 14,
314                "display_name": "Is the product damaged?"
315              },
316              {
317                "id": 12,
318                "display_name": "Does the product match the description?"
319              }
320            ],
321            "is_active": true,
322            "qc_enabled": true,
323            "remark_required": true,
324            "show_text_area": true
325          }
326        ]
327      },
328      "qc_enabled": true,
329      "name": "Fashion Department Return Rule",
330      "flow_type": "return",
331      "position": 1,
332      "department": [
333        73995,
334        5957
335      ],
336      "l3": [
337        47829,
338        47833,
339        142058,
340        47827,
341        47828
342      ],
343      "price_effective_max": 151,
344      "price_effective_min": 0,
345      "rule_type": "custom",
346      "is_active": true,
347      "updated_by": "Alice Johnson",
348      "config_id": "442"
349    }
350  }
351}
Payload Example
1{
2  "application_id": [
3    "66d15d631b7211698ec0f39a"
4  ],
5  "company_id": 33708,
6  "contains": [
7    "actions",
8    "qc_enabled",
9    "name",
10    "flow_type",
11    "position",
12    "department",
13    "l3",
14    "price_effective_max",
15    "price_effective_min",
16    "rule_type",
17    "is_active",
18    "updated_by",
19    "config_id"
20  ],
21  "event": {
22    "category": "application",
23    "created_timestamp": 1745831613,
24    "id": "QsOwO98GEZml5dGw/vScF+Z+xHnDdgfSqRVjMMY/N/k=",
25    "name": "rma_rule",
26    "trace_id": [
27      "ed2d31e75b64fda48b0e531c84cc7ea1"
28    ],
29    "type": "create",
30    "version": "2"
31  },
32  "payload": {
33    "actions": {
34      "reasons": [
35        {
36          "id": 468,
37          "display_name": "Product quality issue",
38          "qc_type": [
39            "pre_qc"
40          ],
41          "question_set": [
42            {
43              "id": 14,
44              "display_name": "Is the product damaged?"
45            },
46            {
47              "id": 12,
48              "display_name": "Does the product match the description?"
49            }
50          ],
51          "is_active": true,
52          "qc_enabled": true,
53          "remark_required": true,
54          "show_text_area": true
55        }
56      ]
57    },
58    "qc_enabled": true,
59    "name": "Fashion Department Return Rule",
60    "flow_type": "return",
61    "position": 1,
62    "department": [
63      73995,
64      5957
65    ],
66    "l3": [
67      47829,
68      47833,
69      142058,
70      47827,
71      47828
72    ],
73    "price_effective_max": 151,
74    "price_effective_min": 0,
75    "rule_type": "custom",
76    "is_active": true,
77    "updated_by": "Alice Johnson",
78    "config_id": "442"
79  }
80}

RMA rule/rma_rule/update/v2

This event is triggered when an RMA rule is updated (V2).

Payload
Properties
application_id
array|string
Required
Identifier(s) of the sales channel(s) associated with the event. The event is triggered for these specific sales channels.
company_id
integer
Required
Unique identifier for the company to which the event pertains.
contains
array of string
Required
Array containing all keys present at the root level of the 'payload' object. This helps in identifying the structure of the payload.
event
object
Required
Details of the event being produced, including metadata such as event category, timestamp, and traceability information.
Properties
category
string
Required
The category of the event, which defines its scope (e.g., company-wide or specific to an application).
Enum
created_timestamp
integer
Required
Timestamp indicating when the event was generated, represented in epoch milliseconds.
id
string
Required
Unique identifier for the event. This ID can be used by receivers to check if the event has already been processed.
name
string
Required
Human-readable name for the event.
trace_id
array of string
Required
Array of internal trace IDs used by Fynd Platform services to trace the event through various processes.
type
string
Required
Action associated with the event, such as creation or update of a rule.
Enum
version
string
Required
Version of the event format, useful for handling backward compatibility.
payload
object
Required
The core content of the RMA rule (V2).
Properties
actions
object
Required
Defines the actionable reasons under this rule.
Properties
reasons
array of object
Primary reasons (and nested sub-reasons) presented during the return process.
Array of Properties
id
integer
Unique identifier for the reason.
display_name
string
Human-readable name for the reason.
qc_type
array of string
List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.
Enum
question_set
array of object
Set of questions associated with this reason, used to gather additional information necessary for the return process.
Array of Properties
id
integer
Unique identifier for the question.
display_name
string
Text of the question presented to the user.
reasons
array of object (ReasonV2)
List of sub-reasons that further detail the main reason.
Array of ReasonV2
id
integer
Unique identifier for the reason.
display_name
string
Human-readable name for the reason.
qc_type
array of string
List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.
Enum
question_set
array of object
Set of questions associated with this reason, used to gather additional information necessary for the return process.
Array of Properties
id
integer
Unique identifier for the question.
display_name
string
Text of the question presented to the user.
reasons
array of object (ReasonV2)
List of sub-reasons that further detail the main reason.
Array of ReasonV2
is_active
boolean
Flag indicating whether this reason is currently active and applicable.
qc_enabled
boolean
Indicates whether quality checks are enabled for this specific reason.
remark_required
boolean
Indicates whether a remark is required when selecting this reason.
show_text_area
boolean
Indicates whether a text area should be displayed for additional input when this reason is selected.
application_id
string|null
Identifier of the application associated with this reason, if applicable.
is_active
boolean
Flag indicating whether this reason is currently active and applicable.
qc_enabled
boolean
Indicates whether quality checks are enabled for this specific reason.
remark_required
boolean
Indicates whether a remark is required when selecting this reason.
show_text_area
boolean
Indicates whether a text area should be displayed for additional input when this reason is selected.
application_id
string|null
Identifier of the application associated with this reason, if applicable.
qc_enabled
boolean
Indicates whether quality checks are required for the rule.
is_deleted
boolean
Flag indicating whether the rule has been deleted.
name
string
Descriptive title of the RMA rule.
flow_type
string
Process flow governed by this rule.
Enum
position
integer
Ordering index for priority among multiple rules.
department
array of integer
List of department IDs to which this rule applies.
l3
array of integer
List of L3 category IDs to which this rule applies.
price_effective_min
number
Minimum effective price for which this rule applies.
price_effective_max
number
Maximum effective price for which this rule applies.
price_marked_min
number
Minimum marked price for which this rule applies.
price_marked_max
number
Maximum marked price for which this rule applies.
restrict_forward_serviceability
boolean
Controls serviceability checks for products where QC is not possible during returns. If true, restricts users from proceeding past the product display page and prevents adding these items to the cart.
tags
array of string
Optional labels for categorizing or filtering rules.
rule_type
string
Indicates if the rule is custom (scoped) or global (universal).
Enum
is_active
boolean
Flag indicating if the rule is currently active.
updated_by
string
Identifier of the last user to modify this rule.
config_id
string
Unique identifier for the configuration of the rule.
description
string
Additional details or notes about the rule.
source
string
Origin system or service that authored this rule.
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": "Identifier(s) of the sales channel(s) associated with the event. The event is triggered for these specific sales channels."
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "Unique identifier for the company to which the event pertains."
21    },
22    "contains": {
23      "type": "array",
24      "description": "Array containing all keys present at the root level of the 'payload' object. This helps in identifying the structure of the payload.",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "description": "Details of the event being produced, including metadata such as event category, timestamp, and traceability information.",
32      "required": [
33        "category",
34        "created_timestamp",
35        "id",
36        "name",
37        "trace_id",
38        "type",
39        "version"
40      ],
41      "properties": {
42        "category": {
43          "type": "string",
44          "enum": [
45            "company",
46            "application",
47            "extension",
48            "click",
49            "global"
50          ],
51          "description": "The category of the event, which defines its scope (e.g., company-wide or specific to an application)."
52        },
53        "created_timestamp": {
54          "type": "integer",
55          "description": "Timestamp indicating when the event was generated, represented in epoch milliseconds."
56        },
57        "id": {
58          "type": "string",
59          "description": "Unique identifier for the event. This ID can be used by receivers to check if the event has already been processed."
60        },
61        "name": {
62          "type": "string",
63          "description": "Human-readable name for the event."
64        },
65        "trace_id": {
66          "type": "array",
67          "description": "Array of internal trace IDs used by Fynd Platform services to trace the event through various processes.",
68          "items": {
69            "type": "string"
70          }
71        },
72        "type": {
73          "type": "string",
74          "enum": [
75            "create",
76            "update"
77          ],
78          "description": "Action associated with the event, such as creation or update of a rule."
79        },
80        "version": {
81          "type": "string",
82          "description": "Version of the event format, useful for handling backward compatibility."
83        }
84      }
85    },
86    "payload": {
87      "type": "object",
88      "description": "The core content of the RMA rule (V2).",
89      "required": [
90        "actions"
91      ],
92      "properties": {
93        "actions": {
94          "type": "object",
95          "description": "Defines the actionable reasons under this rule.",
96          "properties": {
97            "reasons": {
98              "type": "array",
99              "description": "Primary reasons (and nested sub-reasons) presented during the return process.",
100              "items": {
101                "type": "object",
102                "description": "A reason associated with the rule (V2).",
103                "properties": {
104                  "id": {
105                    "type": "integer",
106                    "description": "Unique identifier for the reason."
107                  },
108                  "display_name": {
109                    "type": "string",
110                    "description": "Human-readable name for the reason."
111                  },
112                  "qc_type": {
113                    "type": "array",
114                    "description": "List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.",
115                    "items": {
116                      "type": "string",
117                      "enum": [
118                        "pre_qc",
119                        "doorstep_qc"
120                      ]
121                    }
122                  },
123                  "question_set": {
124                    "type": "array",
125                    "description": "Set of questions associated with this reason, used to gather additional information necessary for the return process.",
126                    "items": {
127                      "type": "object",
128                      "properties": {
129                        "id": {
130                          "type": "integer",
131                          "description": "Unique identifier for the question."
132                        },
133                        "display_name": {
134                          "type": "string",
135                          "description": "Text of the question presented to the user."
136                        }
137                      }
138                    }
139                  },
140                  "reasons": {
141                    "type": "array",
142                    "description": "List of sub-reasons that further detail the main reason.",
143                    "items": {
144                      "$ref": "#/schema/schemas/ReasonV2"
145                    }
146                  },
147                  "is_active": {
148                    "type": "boolean",
149                    "description": "Flag indicating whether this reason is currently active and applicable."
150                  },
151                  "qc_enabled": {
152                    "type": "boolean",
153                    "description": "Indicates whether quality checks are enabled for this specific reason."
154                  },
155                  "remark_required": {
156                    "type": "boolean",
157                    "description": "Indicates whether a remark is required when selecting this reason."
158                  },
159                  "show_text_area": {
160                    "type": "boolean",
161                    "description": "Indicates whether a text area should be displayed for additional input when this reason is selected."
162                  },
163                  "application_id": {
164                    "type": [
165                      "string",
166                      "null"
167                    ],
168                    "description": "Identifier of the application associated with this reason, if applicable."
169                  }
170                }
171              }
172            }
173          }
174        },
175        "qc_enabled": {
176          "type": "boolean",
177          "description": "Indicates whether quality checks are required for the rule."
178        },
179        "is_deleted": {
180          "type": "boolean",
181          "description": "Flag indicating whether the rule has been deleted."
182        },
183        "name": {
184          "type": "string",
185          "description": "Descriptive title of the RMA rule."
186        },
187        "flow_type": {
188          "type": "string",
189          "enum": [
190            "return",
191            "cancel"
192          ],
193          "description": "Process flow governed by this rule."
194        },
195        "position": {
196          "type": "integer",
197          "description": "Ordering index for priority among multiple rules."
198        },
199        "department": {
200          "type": "array",
201          "items": {
202            "type": "integer"
203          },
204          "description": "List of department IDs to which this rule applies."
205        },
206        "l3": {
207          "type": "array",
208          "items": {
209            "type": "integer"
210          },
211          "description": "List of L3 category IDs to which this rule applies."
212        },
213        "price_effective_min": {
214          "type": "number",
215          "description": "Minimum effective price for which this rule applies."
216        },
217        "price_effective_max": {
218          "type": "number",
219          "description": "Maximum effective price for which this rule applies."
220        },
221        "price_marked_min": {
222          "type": "number",
223          "description": "Minimum marked price for which this rule applies."
224        },
225        "price_marked_max": {
226          "type": "number",
227          "description": "Maximum marked price for which this rule applies."
228        },
229        "restrict_forward_serviceability": {
230          "type": "boolean",
231          "description": "Controls serviceability checks for products where QC is not possible during returns. If true, restricts users from proceeding past the product display page and prevents adding these items to the cart.\n"
232        },
233        "tags": {
234          "type": "array",
235          "items": {
236            "type": "string"
237          },
238          "description": "Optional labels for categorizing or filtering rules."
239        },
240        "rule_type": {
241          "type": "string",
242          "enum": [
243            "custom",
244            "global"
245          ],
246          "description": "Indicates if the rule is custom (scoped) or global (universal)."
247        },
248        "is_active": {
249          "type": "boolean",
250          "description": "Flag indicating if the rule is currently active."
251        },
252        "updated_by": {
253          "type": "string",
254          "description": "Identifier of the last user to modify this rule."
255        },
256        "config_id": {
257          "type": "string",
258          "description": "Unique identifier for the configuration of the rule."
259        },
260        "description": {
261          "type": "string",
262          "description": "Additional details or notes about the rule."
263        },
264        "source": {
265          "type": "string",
266          "description": "Origin system or service that authored this rule."
267        }
268      }
269    }
270  },
271  "example": {
272    "application_id": [
273      "66d15d631b7211698ec0f39a"
274    ],
275    "company_id": 33708,
276    "contains": [
277      "actions",
278      "qc_enabled",
279      "is_deleted",
280      "name",
281      "flow_type",
282      "position",
283      "department",
284      "l3",
285      "price_effective_max",
286      "price_effective_min",
287      "rule_type",
288      "is_active",
289      "updated_by",
290      "config_id"
291    ],
292    "event": {
293      "category": "application",
294      "created_timestamp": 1745831613,
295      "id": "QsOwO98GEZml5dGw/vScF+Z+xHnDdgfSqRVjMMY/N/k=",
296      "name": "rma_rule",
297      "trace_id": [
298        "ed2d31e75b64fda48b0e531c84cc7ea1"
299      ],
300      "type": "update",
301      "version": "2"
302    },
303    "payload": {
304      "actions": {
305        "reasons": [
306          {
307            "id": 468,
308            "display_name": "Product quality issue (Updated)",
309            "qc_type": [
310              "pre_qc",
311              "doorstep_qc"
312            ],
313            "question_set": [
314              {
315                "id": 14,
316                "display_name": "Is the product damaged?"
317              },
318              {
319                "id": 12,
320                "display_name": "Does the product match the description?"
321              },
322              {
323                "id": 15,
324                "display_name": "Is the packaging intact?"
325              }
326            ],
327            "is_active": true,
328            "qc_enabled": true,
329            "remark_required": true,
330            "show_text_area": true
331          }
332        ]
333      },
334      "qc_enabled": true,
335      "is_deleted": false,
336      "name": "Updated Fashion Department Return Rule",
337      "flow_type": "return",
338      "position": 1,
339      "department": [
340        73995,
341        5957,
342        6001
343      ],
344      "l3": [
345        47829,
346        47833,
347        142058,
348        47827,
349        47828,
350        47830
351      ],
352      "price_effective_max": 200,
353      "price_effective_min": 10,
354      "rule_type": "custom",
355      "is_active": true,
356      "updated_by": "Bob Williams",
357      "config_id": "442"
358    }
359  }
360}
Payload Example
1{
2  "application_id": [
3    "66d15d631b7211698ec0f39a"
4  ],
5  "company_id": 33708,
6  "contains": [
7    "actions",
8    "qc_enabled",
9    "is_deleted",
10    "name",
11    "flow_type",
12    "position",
13    "department",
14    "l3",
15    "price_effective_max",
16    "price_effective_min",
17    "rule_type",
18    "is_active",
19    "updated_by",
20    "config_id"
21  ],
22  "event": {
23    "category": "application",
24    "created_timestamp": 1745831613,
25    "id": "QsOwO98GEZml5dGw/vScF+Z+xHnDdgfSqRVjMMY/N/k=",
26    "name": "rma_rule",
27    "trace_id": [
28      "ed2d31e75b64fda48b0e531c84cc7ea1"
29    ],
30    "type": "update",
31    "version": "2"
32  },
33  "payload": {
34    "actions": {
35      "reasons": [
36        {
37          "id": 468,
38          "display_name": "Product quality issue (Updated)",
39          "qc_type": [
40            "pre_qc",
41            "doorstep_qc"
42          ],
43          "question_set": [
44            {
45              "id": 14,
46              "display_name": "Is the product damaged?"
47            },
48            {
49              "id": 12,
50              "display_name": "Does the product match the description?"
51            },
52            {
53              "id": 15,
54              "display_name": "Is the packaging intact?"
55            }
56          ],
57          "is_active": true,
58          "qc_enabled": true,
59          "remark_required": true,
60          "show_text_area": true
61        }
62      ]
63    },
64    "qc_enabled": true,
65    "is_deleted": false,
66    "name": "Updated Fashion Department Return Rule",
67    "flow_type": "return",
68    "position": 1,
69    "department": [
70      73995,
71      5957,
72      6001
73    ],
74    "l3": [
75      47829,
76      47833,
77      142058,
78      47827,
79      47828,
80      47830
81    ],
82    "price_effective_max": 200,
83    "price_effective_min": 10,
84    "rule_type": "custom",
85    "is_active": true,
86    "updated_by": "Bob Williams",
87    "config_id": "442"
88  }
89}

RMA rule/rma_rule/create/v1

This event is triggered when an RMA rule is created (V1).

Payload
Properties
application_id
array|string
Required
Identifier(s) of the sales channel(s) associated with the event. The event is triggered for these specific sales channels.
company_id
integer
Required
Unique identifier for the company to which the event pertains.
contains
array of string
Required
Array containing all keys present at the root level of the 'payload' object. This helps in identifying the structure of the payload.
event
object
Required
Details of the event being produced, including metadata such as event category, timestamp, and traceability information.
Properties
category
string
Required
The category of the event, which defines its scope (e.g., company-wide or specific to an application).
Enum
created_timestamp
integer
Required
Timestamp indicating when the event was generated, represented in epoch milliseconds.
id
string
Required
Unique identifier for the event. This ID can be used by receivers to check if the event has already been processed.
name
string
Required
Human-readable name for the event.
trace_id
array of string
Required
Array of internal trace IDs used by Fynd Platform services to trace the event through various processes.
type
string
Required
Action associated with the event, such as creation or update of a rule.
Enum
version
string
Required
Version of the event format, useful for handling backward compatibility.
payload
object
Required
The core content of the RMA rule update. This includes the rule's applicability, actions, reasons for return, conditions, and other metadata. It outlines how the rule should be enforced during the return process.
Properties
entity_type
string
The type of entity the rule applies to, such as a specific department or category (e.g., 'l3').
value
string
The value corresponding to the entity type, such as the specific department ID or category ID.
actions
object
An object containing the reasons for return and corresponding actions. Each reason describes a scenario in which the rule applies and outlines the necessary checks or actions, such as quality control steps.
Properties
reasons
array of object
A list of reasons associated with the action, detailing the circumstances under which the rule is applied.
Array of Properties
id
integer
Unique identifier for the reason.
display_name
string
Human-readable name for the reason.
qc_type
array of string
List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.
Enum
question_set
array of object
Set of questions associated with this reason, used to gather additional information necessary for the return process.
Array of Properties
id
integer
Unique identifier for the question.
display_name
string
Text of the question presented to the user.
reasons
array of object (ReasonV1)
List of sub-reasons that further detail the main reason.
Array of ReasonV1
id
integer
Unique identifier for the reason.
display_name
string
Human-readable name for the reason.
qc_type
array of string
List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.
Enum
question_set
array of object
Set of questions associated with this reason, used to gather additional information necessary for the return process.
Array of Properties
id
integer
Unique identifier for the question.
display_name
string
Text of the question presented to the user.
reasons
array of object (ReasonV1)
List of sub-reasons that further detail the main reason.
Array of ReasonV1
meta
object
Additional metadata related to the reason, which may include specific conditions or configurations.
Properties
show_text_area
boolean
Whether to show a text area for additional input.
is_active
boolean
Flag indicating whether this reason is currently active and applicable.
meta
object
Additional metadata related to the reason, which may include specific conditions or configurations.
Properties
show_text_area
boolean
Whether to show a text area for additional input.
is_active
boolean
Flag indicating whether this reason is currently active and applicable.
qc_enabled
boolean
Indicates whether quality checks are required for the rule.
is_deleted
boolean
Flag indicating whether the rule has been deleted.
conditions
object
Conditions under which the rule is applied, such as specific departments or categories.
Properties
department
string
Department ID to which the rule is applicable.
l3
string
Level 3 category ID that the rule targets.
meta
object
Additional metadata related to the rule, which can include various key-value pairs.
rule_type
string
Indicates whether the rule is a 'custom' rule specific to certain conditions, or a 'global' rule applied universally.
Enum
is_active
boolean
Indicates whether the rule is currently active and being enforced.
updated_by
string
Identifier of the user who last modified the rule.
user_data
object
Additional data related to the user who interacted with the rule, such as preferences or settings.
config_id
string
Unique identifier for the configuration of the rule.
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": "Identifier(s) of the sales channel(s) associated with the event. The event is triggered for these specific sales channels."
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "Unique identifier for the company to which the event pertains."
21    },
22    "contains": {
23      "type": "array",
24      "description": "Array containing all keys present at the root level of the 'payload' object. This helps in identifying the structure of the payload.",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "description": "Details of the event being produced, including metadata such as event category, timestamp, and traceability information.",
32      "required": [
33        "category",
34        "created_timestamp",
35        "id",
36        "name",
37        "trace_id",
38        "type",
39        "version"
40      ],
41      "properties": {
42        "category": {
43          "type": "string",
44          "enum": [
45            "company",
46            "application",
47            "extension",
48            "click",
49            "global"
50          ],
51          "description": "The category of the event, which defines its scope (e.g., company-wide or specific to an application)."
52        },
53        "created_timestamp": {
54          "type": "integer",
55          "description": "Timestamp indicating when the event was generated, represented in epoch milliseconds."
56        },
57        "id": {
58          "type": "string",
59          "description": "Unique identifier for the event. This ID can be used by receivers to check if the event has already been processed."
60        },
61        "name": {
62          "type": "string",
63          "description": "Human-readable name for the event."
64        },
65        "trace_id": {
66          "type": "array",
67          "description": "Array of internal trace IDs used by Fynd Platform services to trace the event through various processes.",
68          "items": {
69            "type": "string"
70          }
71        },
72        "type": {
73          "type": "string",
74          "enum": [
75            "create",
76            "update"
77          ],
78          "description": "Action associated with the event, such as creation or update of a rule."
79        },
80        "version": {
81          "type": "string",
82          "description": "Version of the event format, useful for handling backward compatibility."
83        }
84      }
85    },
86    "payload": {
87      "type": "object",
88      "description": "The core content of the RMA rule update. This includes the rule's applicability, actions, reasons for return, conditions, and other metadata. It outlines how the rule should be enforced during the return process.",
89      "properties": {
90        "entity_type": {
91          "type": "string",
92          "description": "The type of entity the rule applies to, such as a specific department or category (e.g., 'l3').",
93          "x-not-enum": true
94        },
95        "value": {
96          "type": "string",
97          "description": "The value corresponding to the entity type, such as the specific department ID or category ID."
98        },
99        "actions": {
100          "type": "object",
101          "description": "An object containing the reasons for return and corresponding actions. Each reason describes a scenario in which the rule applies and outlines the necessary checks or actions, such as quality control steps.",
102          "properties": {
103            "reasons": {
104              "type": "array",
105              "description": "A list of reasons associated with the action, detailing the circumstances under which the rule is applied.",
106              "items": {
107                "type": "object",
108                "description": "A reason associated with the rule, which explains why the rule is applied during the return process. These reasons often involve specific quality checks or conditions that must be met.",
109                "properties": {
110                  "id": {
111                    "type": "integer",
112                    "description": "Unique identifier for the reason."
113                  },
114                  "display_name": {
115                    "type": "string",
116                    "description": "Human-readable name for the reason."
117                  },
118                  "qc_type": {
119                    "type": "array",
120                    "description": "List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.",
121                    "items": {
122                      "type": "string",
123                      "enum": [
124                        "pre_qc",
125                        "doorstep_qc"
126                      ]
127                    }
128                  },
129                  "question_set": {
130                    "type": "array",
131                    "description": "Set of questions associated with this reason, used to gather additional information necessary for the return process.",
132                    "items": {
133                      "type": "object",
134                      "properties": {
135                        "id": {
136                          "type": "integer",
137                          "description": "Unique identifier for the question."
138                        },
139                        "display_name": {
140                          "type": "string",
141                          "description": "Text of the question presented to the user."
142                        }
143                      }
144                    }
145                  },
146                  "reasons": {
147                    "type": "array",
148                    "description": "List of sub-reasons that further detail the main reason.",
149                    "items": {
150                      "$ref": "#/schema/schemas/ReasonV1"
151                    }
152                  },
153                  "meta": {
154                    "type": "object",
155                    "description": "Additional metadata related to the reason, which may include specific conditions or configurations.",
156                    "properties": {
157                      "show_text_area": {
158                        "type": "boolean",
159                        "description": "Whether to show a text area for additional input."
160                      }
161                    }
162                  },
163                  "is_active": {
164                    "type": "boolean",
165                    "description": "Flag indicating whether this reason is currently active and applicable."
166                  }
167                }
168              }
169            }
170          }
171        },
172        "qc_enabled": {
173          "type": "boolean",
174          "description": "Indicates whether quality checks are required for the rule."
175        },
176        "is_deleted": {
177          "type": "boolean",
178          "description": "Flag indicating whether the rule has been deleted."
179        },
180        "conditions": {
181          "type": "object",
182          "description": "Conditions under which the rule is applied, such as specific departments or categories.",
183          "properties": {
184            "department": {
185              "type": "string",
186              "description": "Department ID to which the rule is applicable."
187            },
188            "l3": {
189              "type": "string",
190              "description": "Level 3 category ID that the rule targets."
191            }
192          }
193        },
194        "meta": {
195          "type": "object",
196          "description": "Additional metadata related to the rule, which can include various key-value pairs.",
197          "additionalProperties": true
198        },
199        "rule_type": {
200          "type": "string",
201          "enum": [
202            "custom",
203            "global"
204          ],
205          "description": "Indicates whether the rule is a 'custom' rule specific to certain conditions, or a 'global' rule applied universally."
206        },
207        "is_active": {
208          "type": "boolean",
209          "description": "Indicates whether the rule is currently active and being enforced."
210        },
211        "updated_by": {
212          "type": "string",
213          "description": "Identifier of the user who last modified the rule."
214        },
215        "user_data": {
216          "type": "object",
217          "description": "Additional data related to the user who interacted with the rule, such as preferences or settings.",
218          "additionalProperties": true
219        },
220        "config_id": {
221          "type": "string",
222          "description": "Unique identifier for the configuration of the rule."
223        }
224      }
225    }
226  },
227  "example": {
228    "application_id": [
229      "65a50161af1fc9ad6890be95"
230    ],
231    "company_id": 6640,
232    "contains": [
233      "entity_type",
234      "value",
235      "actions",
236      "qc_enabled",
237      "conditions",
238      "meta",
239      "rule_type",
240      "is_active",
241      "updated_by",
242      "config_id"
243    ],
244    "event": {
245      "category": "application",
246      "created_timestamp": 1745823742,
247      "id": "QsOwO98GEZml5dGw/vScF+Z+xHnDdgfSqRVjMMY/N/k=",
248      "name": "rma",
249      "trace_id": [
250        "d2c5ca50ce94eeb723b2517ee7d04870"
251      ],
252      "type": "create",
253      "version": "1"
254    },
255    "payload": {
256      "entity_type": "department",
257      "value": "21",
258      "actions": {
259        "reasons": [
260          {
261            "id": 104,
262            "display_name": "Product not of good quality",
263            "qc_type": [
264              "doorstep_qc"
265            ],
266            "question_set": [
267              {
268                "id": 7,
269                "display_name": "Check if product is damaged"
270              },
271              {
272                "id": 6,
273                "display_name": "Check if product is used"
274              }
275            ],
276            "meta": {
277              "show_text_area": false
278            },
279            "is_active": true
280          }
281        ]
282      },
283      "qc_enabled": true,
284      "conditions": {
285        "department": "21"
286      },
287      "meta": {
288        "department": {
289          "id": "21",
290          "display_name": "Fashion"
291        }
292      },
293      "rule_type": "custom",
294      "is_active": true,
295      "updated_by": "John Doe",
296      "config_id": "166"
297    }
298  }
299}
Payload Example
1{
2  "application_id": [
3    "65a50161af1fc9ad6890be95"
4  ],
5  "company_id": 6640,
6  "contains": [
7    "entity_type",
8    "value",
9    "actions",
10    "qc_enabled",
11    "conditions",
12    "meta",
13    "rule_type",
14    "is_active",
15    "updated_by",
16    "config_id"
17  ],
18  "event": {
19    "category": "application",
20    "created_timestamp": 1745823742,
21    "id": "QsOwO98GEZml5dGw/vScF+Z+xHnDdgfSqRVjMMY/N/k=",
22    "name": "rma",
23    "trace_id": [
24      "d2c5ca50ce94eeb723b2517ee7d04870"
25    ],
26    "type": "create",
27    "version": "1"
28  },
29  "payload": {
30    "entity_type": "department",
31    "value": "21",
32    "actions": {
33      "reasons": [
34        {
35          "id": 104,
36          "display_name": "Product not of good quality",
37          "qc_type": [
38            "doorstep_qc"
39          ],
40          "question_set": [
41            {
42              "id": 7,
43              "display_name": "Check if product is damaged"
44            },
45            {
46              "id": 6,
47              "display_name": "Check if product is used"
48            }
49          ],
50          "meta": {
51            "show_text_area": false
52          },
53          "is_active": true
54        }
55      ]
56    },
57    "qc_enabled": true,
58    "conditions": {
59      "department": "21"
60    },
61    "meta": {
62      "department": {
63        "id": "21",
64        "display_name": "Fashion"
65      }
66    },
67    "rule_type": "custom",
68    "is_active": true,
69    "updated_by": "John Doe",
70    "config_id": "166"
71  }
72}

RMA rule/rma_rule/update/v1

This event is triggered when an RMA rule is updated (V1).

Payload
Properties
application_id
array|string
Required
Identifier(s) of the sales channel(s) associated with the event. The event is triggered for these specific sales channels.
company_id
integer
Required
Unique identifier for the company to which the event pertains.
contains
array of string
Required
Array containing all keys present at the root level of the 'payload' object. This helps in identifying the structure of the payload.
event
object
Required
Details of the event being produced, including metadata such as event category, timestamp, and traceability information.
Properties
category
string
Required
The category of the event, which defines its scope (e.g., company-wide or specific to an application).
Enum
created_timestamp
integer
Required
Timestamp indicating when the event was generated, represented in epoch milliseconds.
id
string
Required
Unique identifier for the event. This ID can be used by receivers to check if the event has already been processed.
name
string
Required
Human-readable name for the event.
trace_id
array of string
Required
Array of internal trace IDs used by Fynd Platform services to trace the event through various processes.
type
string
Required
Action associated with the event, such as creation or update of a rule.
Enum
version
string
Required
Version of the event format, useful for handling backward compatibility.
payload
object
Required
The core content of the RMA rule update. This includes the rule's applicability, actions, reasons for return, conditions, and other metadata. It outlines how the rule should be enforced during the return process.
Properties
entity_type
string
The type of entity the rule applies to, such as a specific department or category (e.g., 'l3').
value
string
The value corresponding to the entity type, such as the specific department ID or category ID.
actions
object
An object containing the reasons for return and corresponding actions. Each reason describes a scenario in which the rule applies and outlines the necessary checks or actions, such as quality control steps.
Properties
reasons
array of object
A list of reasons associated with the action, detailing the circumstances under which the rule is applied.
Array of Properties
id
integer
Unique identifier for the reason.
display_name
string
Human-readable name for the reason.
qc_type
array of string
List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.
Enum
question_set
array of object
Set of questions associated with this reason, used to gather additional information necessary for the return process.
Array of Properties
id
integer
Unique identifier for the question.
display_name
string
Text of the question presented to the user.
reasons
array of object (ReasonV1)
List of sub-reasons that further detail the main reason.
Array of ReasonV1
id
integer
Unique identifier for the reason.
display_name
string
Human-readable name for the reason.
qc_type
array of string
List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.
Enum
question_set
array of object
Set of questions associated with this reason, used to gather additional information necessary for the return process.
Array of Properties
id
integer
Unique identifier for the question.
display_name
string
Text of the question presented to the user.
reasons
array of object (ReasonV1)
List of sub-reasons that further detail the main reason.
Array of ReasonV1
meta
object
Additional metadata related to the reason, which may include specific conditions or configurations.
Properties
show_text_area
boolean
Whether to show a text area for additional input.
is_active
boolean
Flag indicating whether this reason is currently active and applicable.
meta
object
Additional metadata related to the reason, which may include specific conditions or configurations.
Properties
show_text_area
boolean
Whether to show a text area for additional input.
is_active
boolean
Flag indicating whether this reason is currently active and applicable.
qc_enabled
boolean
Indicates whether quality checks are required for the rule.
is_deleted
boolean
Flag indicating whether the rule has been deleted.
conditions
object
Conditions under which the rule is applied, such as specific departments or categories.
Properties
department
string
Department ID to which the rule is applicable.
l3
string
Level 3 category ID that the rule targets.
meta
object
Additional metadata related to the rule, which can include various key-value pairs.
rule_type
string
Indicates whether the rule is a 'custom' rule specific to certain conditions, or a 'global' rule applied universally.
Enum
is_active
boolean
Indicates whether the rule is currently active and being enforced.
updated_by
string
Identifier of the user who last modified the rule.
user_data
object
Additional data related to the user who interacted with the rule, such as preferences or settings.
config_id
string
Unique identifier for the configuration of the rule.
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": "Identifier(s) of the sales channel(s) associated with the event. The event is triggered for these specific sales channels."
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "Unique identifier for the company to which the event pertains."
21    },
22    "contains": {
23      "type": "array",
24      "description": "Array containing all keys present at the root level of the 'payload' object. This helps in identifying the structure of the payload.",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "description": "Details of the event being produced, including metadata such as event category, timestamp, and traceability information.",
32      "required": [
33        "category",
34        "created_timestamp",
35        "id",
36        "name",
37        "trace_id",
38        "type",
39        "version"
40      ],
41      "properties": {
42        "category": {
43          "type": "string",
44          "enum": [
45            "company",
46            "application",
47            "extension",
48            "click",
49            "global"
50          ],
51          "description": "The category of the event, which defines its scope (e.g., company-wide or specific to an application)."
52        },
53        "created_timestamp": {
54          "type": "integer",
55          "description": "Timestamp indicating when the event was generated, represented in epoch milliseconds."
56        },
57        "id": {
58          "type": "string",
59          "description": "Unique identifier for the event. This ID can be used by receivers to check if the event has already been processed."
60        },
61        "name": {
62          "type": "string",
63          "description": "Human-readable name for the event."
64        },
65        "trace_id": {
66          "type": "array",
67          "description": "Array of internal trace IDs used by Fynd Platform services to trace the event through various processes.",
68          "items": {
69            "type": "string"
70          }
71        },
72        "type": {
73          "type": "string",
74          "enum": [
75            "create",
76            "update"
77          ],
78          "description": "Action associated with the event, such as creation or update of a rule."
79        },
80        "version": {
81          "type": "string",
82          "description": "Version of the event format, useful for handling backward compatibility."
83        }
84      }
85    },
86    "payload": {
87      "type": "object",
88      "description": "The core content of the RMA rule update. This includes the rule's applicability, actions, reasons for return, conditions, and other metadata. It outlines how the rule should be enforced during the return process.",
89      "properties": {
90        "entity_type": {
91          "type": "string",
92          "description": "The type of entity the rule applies to, such as a specific department or category (e.g., 'l3').",
93          "x-not-enum": true
94        },
95        "value": {
96          "type": "string",
97          "description": "The value corresponding to the entity type, such as the specific department ID or category ID."
98        },
99        "actions": {
100          "type": "object",
101          "description": "An object containing the reasons for return and corresponding actions. Each reason describes a scenario in which the rule applies and outlines the necessary checks or actions, such as quality control steps.",
102          "properties": {
103            "reasons": {
104              "type": "array",
105              "description": "A list of reasons associated with the action, detailing the circumstances under which the rule is applied.",
106              "items": {
107                "type": "object",
108                "description": "A reason associated with the rule, which explains why the rule is applied during the return process. These reasons often involve specific quality checks or conditions that must be met.",
109                "properties": {
110                  "id": {
111                    "type": "integer",
112                    "description": "Unique identifier for the reason."
113                  },
114                  "display_name": {
115                    "type": "string",
116                    "description": "Human-readable name for the reason."
117                  },
118                  "qc_type": {
119                    "type": "array",
120                    "description": "List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.",
121                    "items": {
122                      "type": "string",
123                      "enum": [
124                        "pre_qc",
125                        "doorstep_qc"
126                      ]
127                    }
128                  },
129                  "question_set": {
130                    "type": "array",
131                    "description": "Set of questions associated with this reason, used to gather additional information necessary for the return process.",
132                    "items": {
133                      "type": "object",
134                      "properties": {
135                        "id": {
136                          "type": "integer",
137                          "description": "Unique identifier for the question."
138                        },
139                        "display_name": {
140                          "type": "string",
141                          "description": "Text of the question presented to the user."
142                        }
143                      }
144                    }
145                  },
146                  "reasons": {
147                    "type": "array",
148                    "description": "List of sub-reasons that further detail the main reason.",
149                    "items": {
150                      "$ref": "#/schema/schemas/ReasonV1"
151                    }
152                  },
153                  "meta": {
154                    "type": "object",
155                    "description": "Additional metadata related to the reason, which may include specific conditions or configurations.",
156                    "properties": {
157                      "show_text_area": {
158                        "type": "boolean",
159                        "description": "Whether to show a text area for additional input."
160                      }
161                    }
162                  },
163                  "is_active": {
164                    "type": "boolean",
165                    "description": "Flag indicating whether this reason is currently active and applicable."
166                  }
167                }
168              }
169            }
170          }
171        },
172        "qc_enabled": {
173          "type": "boolean",
174          "description": "Indicates whether quality checks are required for the rule."
175        },
176        "is_deleted": {
177          "type": "boolean",
178          "description": "Flag indicating whether the rule has been deleted."
179        },
180        "conditions": {
181          "type": "object",
182          "description": "Conditions under which the rule is applied, such as specific departments or categories.",
183          "properties": {
184            "department": {
185              "type": "string",
186              "description": "Department ID to which the rule is applicable."
187            },
188            "l3": {
189              "type": "string",
190              "description": "Level 3 category ID that the rule targets."
191            }
192          }
193        },
194        "meta": {
195          "type": "object",
196          "description": "Additional metadata related to the rule, which can include various key-value pairs.",
197          "additionalProperties": true
198        },
199        "rule_type": {
200          "type": "string",
201          "enum": [
202            "custom",
203            "global"
204          ],
205          "description": "Indicates whether the rule is a 'custom' rule specific to certain conditions, or a 'global' rule applied universally."
206        },
207        "is_active": {
208          "type": "boolean",
209          "description": "Indicates whether the rule is currently active and being enforced."
210        },
211        "updated_by": {
212          "type": "string",
213          "description": "Identifier of the user who last modified the rule."
214        },
215        "user_data": {
216          "type": "object",
217          "description": "Additional data related to the user who interacted with the rule, such as preferences or settings.",
218          "additionalProperties": true
219        },
220        "config_id": {
221          "type": "string",
222          "description": "Unique identifier for the configuration of the rule."
223        }
224      }
225    }
226  },
227  "example": {
228    "application_id": [
229      "65a50161af1fc9ad6890be95"
230    ],
231    "company_id": 6640,
232    "contains": [
233      "entity_type",
234      "value",
235      "actions",
236      "qc_enabled",
237      "is_deleted",
238      "conditions",
239      "meta",
240      "rule_type",
241      "is_active",
242      "updated_by",
243      "config_id"
244    ],
245    "event": {
246      "category": "application",
247      "created_timestamp": 1745823742,
248      "id": "QsOwO98GEZml5dGw/vScF+Z+xHnDdgfSqRVjMMY/N/k=",
249      "name": "rma",
250      "trace_id": [
251        "d2c5ca50ce94eeb723b2517ee7d04870"
252      ],
253      "type": "update",
254      "version": "1"
255    },
256    "payload": {
257      "entity_type": "department",
258      "value": "21",
259      "actions": {
260        "reasons": [
261          {
262            "id": 104,
263            "display_name": "Product not of good quality",
264            "qc_type": [
265              "doorstep_qc"
266            ],
267            "question_set": [
268              {
269                "id": 7,
270                "display_name": "Check if product is damaged"
271              },
272              {
273                "id": 6,
274                "display_name": "Check if product is used"
275              }
276            ],
277            "meta": {
278              "show_text_area": false
279            },
280            "is_active": true
281          }
282        ]
283      },
284      "qc_enabled": true,
285      "is_deleted": false,
286      "conditions": {
287        "department": "21"
288      },
289      "meta": {
290        "department": {
291          "id": "21",
292          "display_name": "Fashion"
293        }
294      },
295      "rule_type": "custom",
296      "is_active": true,
297      "updated_by": "Jane Smith",
298      "config_id": "166"
299    }
300  }
301}
Payload Example
1{
2  "application_id": [
3    "65a50161af1fc9ad6890be95"
4  ],
5  "company_id": 6640,
6  "contains": [
7    "entity_type",
8    "value",
9    "actions",
10    "qc_enabled",
11    "is_deleted",
12    "conditions",
13    "meta",
14    "rule_type",
15    "is_active",
16    "updated_by",
17    "config_id"
18  ],
19  "event": {
20    "category": "application",
21    "created_timestamp": 1745823742,
22    "id": "QsOwO98GEZml5dGw/vScF+Z+xHnDdgfSqRVjMMY/N/k=",
23    "name": "rma",
24    "trace_id": [
25      "d2c5ca50ce94eeb723b2517ee7d04870"
26    ],
27    "type": "update",
28    "version": "1"
29  },
30  "payload": {
31    "entity_type": "department",
32    "value": "21",
33    "actions": {
34      "reasons": [
35        {
36          "id": 104,
37          "display_name": "Product not of good quality",
38          "qc_type": [
39            "doorstep_qc"
40          ],
41          "question_set": [
42            {
43              "id": 7,
44              "display_name": "Check if product is damaged"
45            },
46            {
47              "id": 6,
48              "display_name": "Check if product is used"
49            }
50          ],
51          "meta": {
52            "show_text_area": false
53          },
54          "is_active": true
55        }
56      ]
57    },
58    "qc_enabled": true,
59    "is_deleted": false,
60    "conditions": {
61      "department": "21"
62    },
63    "meta": {
64      "department": {
65        "id": "21",
66        "display_name": "Fashion"
67      }
68    },
69    "rule_type": "custom",
70    "is_active": true,
71    "updated_by": "Jane Smith",
72    "config_id": "166"
73  }
74}

Previous
« return_config_categories/update/v1
Next
seo/update/v1 »