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.

Return config

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

Events

application/return_config_categories/update/v1

# This event is triggered when return config categories are created/updated

application/return_config_categories/delete/v1

# This event is triggered when return config categories are deleted

Return Config/return_config_categories/update/v1

This event is triggered when return config categories are created/updated

Payload

Properties

Event emitted when Return Config categories are created/updated

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

Company ID for which this event is triggered

contains

array of string

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

event

object

Properties

category

string

Required

Category of the event. If it is at sales channel level or company level or any other level

Enum

created_timestamp

integer

Required

Event generation timestamp in epoch milliseconds

string

Required

Unique ID for an event. This id can be used to verifiy if event is already processed by receiver

name

string

Required

Name of the event

trace_id

array of string

Required

Internal trace_id for Fynd Platform services

type

string

Required

Type/Action of the event. e.g. create/update/delete

version

string

Required

Version of the event.

payload

object

Properties

return_config_categories

array of object

An array of return configuration categories that have been created, updated, or deleted.

Array of Properties

app_id

string

Required

ID of the application in which the return configuration is created.

logo

string

Required

URL of the logo image.

category_id

integer

Required

ID of the category.

name

string

Required

Name of the return configuration category.

return_config

object

Required

Details of the return policy, including time duration, returnable status, and time unit.

Properties

time

integer

Required

Time duration for the return policy.

returnable

boolean

Required

Flag indicating if the item is returnable.

unit

string

Required

Unit of time for the return policy.

Enum

Payload Schema JSON

1{
2  "type": "object",
3  "description": "Event emitted when Return Config categories are 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_categories": {
79          "type": "array",
80          "description": "An array of return configuration categories that have been created, updated, or deleted.",
81          "items": {
82            "type": "object",
83            "properties": {
84              "app_id": {
85                "type": "string",
86                "description": "ID of the application in which the return configuration is created."
87              },
88              "logo": {
89                "type": "string",
90                "description": "URL of the logo image."
91              },
92              "category_id": {
93                "type": "integer",
94                "description": "ID of the category."
95              },
96              "name": {
97                "type": "string",
98                "description": "Name of the return configuration category."
99              },
100              "return_config": {
101                "type": "object",
102                "description": "Details of the return policy, including time duration, returnable status, and time unit.",
103                "properties": {
104                  "time": {
105                    "type": "integer",
106                    "description": "Time duration for the return policy."
107                  },
108                  "returnable": {
109                    "type": "boolean",
110                    "description": "Flag indicating if the item is returnable."
111                  },
112                  "unit": {
113                    "type": "string",
114                    "enum": [
115                      "days",
116                      "hours"
117                    ],
118                    "description": "Unit of time for the return policy."
119                  }
120                },
121                "required": [
122                  "time",
123                  "returnable",
124                  "unit"
125                ]
126              }
127            },
128            "required": [
129              "app_id",
130              "logo",
131              "category_id",
132              "name",
133              "return_config"
134            ]
135          }
136        }
137      }
138    }
139  }
140}

Payload Example

1{
2  "payload": {
3    "return_config_categories": [
4      {
5        "app_id": "668e76839b4b84c705f4cd16",
6        "logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/vsm194/test/general/free/original/sampleJPG.jpg",
7        "category_id": 30,
8        "name": "Fashion",
9        "return_config": {
10          "time": 5,
11          "returnable": true,
12          "unit": "days"
13        }
14      },
15      {
16        "app_id": "668e76839b4b84c705f4cd16",
17        "logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/vsm194/test/general/free/original/sampleJPG.jpg",
18        "category_id": 45,
19        "name": "Kids",
20        "return_config": {
21          "time": 5,
22          "returnable": true,
23          "unit": "days"
24        }
25      }
26    ]
27  },
28  "meta": {
29    "trace_id": [
30      "silverbolt.25a2aee0-3f41-11ef-bba3-fa3a2703c0c6"
31    ],
32    "created_timestamp": 1720673450861,
33    "service": {
34      "name": "silverbolt"
35    },
36    "company_id": 4,
37    "application_id": "668e76839b4b84c705f4cd16",
38    "event": {
39      "name": "return-config-categories",
40      "type": "update",
41      "version": "1"
42    }
43  }
44}

Return Config/return_config_categories/delete/v1

This event is triggered when return config categories are deleted

Payload

Properties

Event emitted when Return Config categories are deleted

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

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

event

object

Properties

category

string

Required

Category of the event. If it is at sales channel level or company level or any other level

Enum

created_timestamp

integer

Required

Event generation timestamp in epoch milliseconds

string

Required

Unique ID for an event. This id can be used to verifiy if event is already processed by receiver

name

string

Required

Name of the event

trace_id

array of string

Required

internal trace_id for Fynd Platform services

type

string

Required

Type/Action of the event. e.g. create/update/delete

version

string

Required

Version of the event.

payload

object

Properties

return_config_categories

array of integer

Required

IDs of the return configuration categories that have been deleted.

Payload Schema JSON

1{
2  "type": "object",
3  "description": "Event emitted when Return Config categories are deleted",
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_categories": {
79          "type": "array",
80          "items": {
81            "type": "integer"
82          },
83          "description": "IDs of the return configuration categories that have been deleted."
84        }
85      },
86      "required": [
87        "return_config_categories"
88      ]
89    }
90  }
91}

Payload Example

1{
2  "payload": {
3    "return_config_categories": [
4      30,
5      45
6    ]
7  },
8  "meta": {
9    "trace_id": [
10      "silverbolt.065dc036-3f43-11ef-bba3-fa3a2703c0c6"
11    ],
12    "created_timestamp": 1720674257394,
13    "service": {
14      "name": "silverbolt"
15    },
16    "company_id": 4,
17    "application_id": "668e76839b4b84c705f4cd16",
18    "event": {
19      "name": "return-config-categories",
20      "type": "delete",
21      "version": "1"
22    }
23  }
24}

« return_config/update/v1

rma_rule/create/v2 »