Application

1{
2  "type": "object",
3  "description": "Event emitted when a Return Config is created/updated",
4  "properties": {
5    "application_id": {
6      "type": [
7        "array",
8        "string"
9      ],
10      "description": "Application/sales channel ID for which this event is triggered"
11    },
12    "company_id": {
13      "type": "integer",
14      "description": "Company ID for which this event is triggered"
15    },
16    "contains": {
17      "type": "array",
18      "description": "This array will have all the keys present at root level of 'payload' object",
19      "items": {
20        "type": "string"
21      }
22    },
23    "event": {
24      "type": "object",
25      "required": [
26        "category",
27        "created_timestamp",
28        "id",
29        "name",
30        "trace_id",
31        "type",
32        "version"
33      ],
34      "properties": {
35        "category": {
36          "type": "string",
37          "enum": [
38            "global",
39            "click",
40            "application",
41            "extension",
42            "company"
43          ],
44          "description": "Category of the event. If it is at sales channel level or company level or any other level"
45        },
46        "created_timestamp": {
47          "type": "integer",
48          "description": "Event generation timestamp in epoch milliseconds"
49        },
50        "id": {
51          "type": "string",
52          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
53        },
54        "name": {
55          "type": "string",
56          "description": "Name of the event"
57        },
58        "trace_id": {
59          "type": "array",
60          "description": "Internal trace_id for Fynd Platform services",
61          "items": {
62            "type": "string"
63          }
64        },
65        "type": {
66          "type": "string",
67          "description": "Type/Action of the event. e.g. create/update/delete"
68        },
69        "version": {
70          "type": "string",
71          "description": "Version of the event."
72        }
73      }
74    },
75    "payload": {
76      "type": "object",
77      "properties": {
78        "return_config": {
79          "type": "object",
80          "description": "Details of the return configuration that has been created or updated.",
81          "properties": {
82            "created_by": {
83              "type": "object",
84              "properties": {
85                "user_id": {
86                  "type": "string",
87                  "description": "User ID of the user who created the configuration."
88                }
89              },
90              "required": [
91                "user_id"
92              ]
93            },
94            "modified_by": {
95              "type": "object",
96              "properties": {
97                "user_id": {
98                  "type": "string",
99                  "description": "User ID of the user who last modified the configuration."
100                }
101              },
102              "required": [
103                "user_id"
104              ]
105            },
106            "return_config_level": {
107              "type": "string",
108              "enum": [
109                "category",
110                "product",
111                "no-return"
112              ],
113              "description": "The level at which the return configuration is applied"
114            },
115            "app_id": {
116              "type": "string",
117              "description": "ID of the application in which the return configuration is created."
118            },
119            "modified_on": {
120              "type": "string",
121              "format": "date-time",
122              "description": "Timestamp of the last modification."
123            },
124            "category_count": {
125              "type": "integer",
126              "description": "Number of categories mapped under the Application."
127            },
128            "company_id": {
129              "type": "integer",
130              "description": "ID of the company to which the return configuration belongs."
131            }
132          },
133          "required": [
134            "created_by",
135            "modified_by",
136            "return_config_level",
137            "app_id",
138            "modified_on",
139            "category_count",
140            "company_id"
141          ]
142        }
143      }
144    }
145  }
146}

1{
2  "payload": {
3    "return_config": {
4      "created_by": {
5        "user_id": "d48583e0b34c93299a86fba4"
6      },
7      "modified_by": {
8        "user_id": "d48583e0b34c93299a86fba4"
9      },
10      "return_config_level": "product",
11      "app_id": "668e76839b4b84c705f4cd16",
12      "modified_on": "2024-07-11T04:31:50.963072",
13      "category_count": 0,
14      "company_id": 4
15    }
16  },
17  "meta": {
18    "trace_id": [
19      "silverbolt.7e363340-3f3e-11ef-bba3-fa3a2703c0c6"
20    ],
21    "created_timestamp": 1720672310977,
22    "service": {
23      "name": "silverbolt"
24    },
25    "company_id": 4,
26    "application_id": "668e76839b4b84c705f4cd16",
27    "event": {
28      "name": "return-config",
29      "type": "update",
30      "version": "1"
31    }
32  }
33}