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.

Details groups

This event will be generated when detail group is modified. Detail group represents a reusable set of attributes that are displayed in product description on product detail page.

Events

application/details_groups/create/v1

# This event is triggered when product detail group is created. This will be displayed in product description.

application/details_groups/update/v1

# This event is triggered when product detail group is updated. This will be displayed in product description.

application/details_groups/delete/v1

# This event is triggered when product detail group is deleted. This will be displayed in product description.

Details groups/details_groups/create/v1

This event is triggered when product detail group is created. This will be displayed in product description.

Payload

Hide

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

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

event

object

Required

Show

payload

object

Required

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "details-groups"
78      ],
79      "properties": {
80        "details-groups": {
81          "type": "object",
82          "description": "Object containing information about a product detail group. This contains information displayed in product description.",
83          "properties": {
84            "is_default": {
85              "type": "boolean",
86              "description": "Is this a default detailed to be added in all product description."
87            },
88            "slug": {
89              "type": "string",
90              "description": "A unique identifier for the details group."
91            },
92            "is_active": {
93              "type": "boolean",
94              "description": "Specifies whether the details group is active and should be visible in descriptions."
95            },
96            "priority": {
97              "type": "integer",
98              "description": "Defines the priority of this details group. Higher values mean it is displayed before other details in description."
99            },
100            "attributes": {
101              "type": "array",
102              "description": "List of attributes associated with the details group.",
103              "items": {
104                "type": "object",
105                "properties": {
106                  "is_active": {
107                    "type": "boolean",
108                    "description": "Indicates if the attribute is active."
109                  },
110                  "name": {
111                    "type": "string",
112                    "description": "Name of the attribute."
113                  },
114                  "display_type": {
115                    "type": "string",
116                    "description": "Type of display used for this attribute (e.g., text, dropdown)."
117                  },
118                  "slug": {
119                    "type": "string",
120                    "description": "A unique identifier for the attribute."
121                  },
122                  "key": {
123                    "type": "string",
124                    "description": "Key used for identifying the attribute in data processing."
125                  },
126                  "priority": {
127                    "type": "integer",
128                    "description": "Defines the order for the attribute withing a group. Higher values indicate that it needs to placed on top in the group."
129                  }
130                },
131                "required": [
132                  "is_active",
133                  "name",
134                  "display_type",
135                  "slug",
136                  "key",
137                  "priority"
138                ]
139              }
140            },
141            "name": {
142              "type": "string",
143              "description": "Name of the details group."
144            },
145            "template_slugs": {
146              "type": "array",
147              "description": "List of unique string associated with any predefined template for the group.",
148              "items": {
149                "type": "string"
150              }
151            },
152            "app_id": {
153              "type": "string",
154              "description": "Identifier for the application this details group belongs to."
155            },
156            "id": {
157              "type": "string",
158              "description": "Unique identifier for the details group."
159            }
160          },
161          "required": [
162            "is_default",
163            "slug",
164            "is_active",
165            "priority",
166            "attributes",
167            "name",
168            "template_slugs",
169            "app_id",
170            "id"
171          ]
172        }
173      }
174    }
175  }
176}

Payload Example

1{
2  "application_id": "6523fa5f41f4eb4c10a1d869",
3  "company_id": 5842,
4  "contains": [
5    "collection"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1708644940476,
10    "id": "gFx0LWac2FBTIAmnrwlX05p0cDVbAc02TU46sTOepIQ=",
11    "name": "collection",
12    "trace_id": [
13      "silverbolt.16bfae2e-d1db-11ee-ae64-b66edc95121c"
14    ],
15    "type": "create",
16    "version": "2"
17  },
18  "payload": {
19    "details-groups": {
20      "is_default": false,
21      "slug": "details-groups",
22      "is_active": true,
23      "priority": 1,
24      "attributes": [
25        {
26          "is_active": true,
27          "name": "Color",
28          "display_type": "dropdown",
29          "slug": "color",
30          "key": "color_key",
31          "priority": 5
32        }
33      ],
34      "name": "Basic details",
35      "template_slugs": [
36        "test_slug"
37      ],
38      "app_id": "12121232efef",
39      "id": "67f9876abc32"
40    }
41  }
42}

Details groups/details_groups/update/v1

This event is triggered when product detail group is updated. This will be displayed in product description.

Payload

Hide

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

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

event

object

Required

Show

payload

object

Required

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "details-groups"
78      ],
79      "properties": {
80        "details-groups": {
81          "type": "object",
82          "description": "Object containing information about a product detail group. This contains information displayed in product description.",
83          "properties": {
84            "is_default": {
85              "type": "boolean",
86              "description": "Is this a default detailed to be added in all product description."
87            },
88            "slug": {
89              "type": "string",
90              "description": "A unique identifier for the details group."
91            },
92            "is_active": {
93              "type": "boolean",
94              "description": "Specifies whether the details group is active and should be visible in descriptions."
95            },
96            "priority": {
97              "type": "integer",
98              "description": "Defines the priority of this details group. Higher values mean it is displayed before other details in description."
99            },
100            "attributes": {
101              "type": "array",
102              "description": "List of attributes associated with the details group.",
103              "items": {
104                "type": "object",
105                "properties": {
106                  "is_active": {
107                    "type": "boolean",
108                    "description": "Indicates if the attribute is active."
109                  },
110                  "name": {
111                    "type": "string",
112                    "description": "Name of the attribute."
113                  },
114                  "display_type": {
115                    "type": "string",
116                    "description": "Type of display used for this attribute (e.g., text, html or other)."
117                  },
118                  "slug": {
119                    "type": "string",
120                    "description": "A unique identifier for the attribute."
121                  },
122                  "key": {
123                    "type": "string",
124                    "description": "Key used for identifying the attribute from the product data. This can be different from slug as this is a field present in data."
125                  },
126                  "priority": {
127                    "type": "integer",
128                    "description": "Defines the order for the attribute withing a group. Higher values indicate that it needs to placed on top in the group."
129                  }
130                },
131                "required": [
132                  "is_active",
133                  "name",
134                  "display_type",
135                  "slug",
136                  "key",
137                  "priority"
138                ]
139              }
140            },
141            "name": {
142              "type": "string",
143              "description": "Name of the details group."
144            },
145            "template_slugs": {
146              "type": "array",
147              "description": "List of unique string associated with any predefined template for the group.",
148              "items": {
149                "type": "string"
150              }
151            },
152            "app_id": {
153              "type": "string",
154              "description": "Identifier for the application id this details group belongs to."
155            },
156            "id": {
157              "type": "string",
158              "description": "Unique identifier for the details group."
159            }
160          },
161          "required": [
162            "is_default",
163            "slug",
164            "is_active",
165            "priority",
166            "attributes",
167            "name",
168            "template_slugs",
169            "app_id",
170            "id"
171          ]
172        }
173      }
174    }
175  }
176}

Payload Example

1{
2  "application_id": "6523fa5f41f4eb4c10a1d869",
3  "company_id": 5842,
4  "contains": [
5    "collection"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1708644940476,
10    "id": "gFx0LWac2FBTIAmnrwlX05p0cDVbAc02TU46sTOepIQ=",
11    "name": "collection",
12    "trace_id": [
13      "silverbolt.16bfae2e-d1db-11ee-ae64-b66edc95121c"
14    ],
15    "type": "create",
16    "version": "2"
17  },
18  "payload": {
19    "details-groups": {
20      "is_default": false,
21      "slug": "details-groups",
22      "is_active": true,
23      "priority": 1,
24      "attributes": [
25        {
26          "is_active": true,
27          "name": "Color",
28          "display_type": "dropdown",
29          "slug": "color",
30          "key": "color_key",
31          "priority": 5
32        }
33      ],
34      "name": "Basic details",
35      "template_slugs": [
36        "test_slug"
37      ],
38      "app_id": "12121232efef",
39      "id": "67f9876abc32"
40    }
41  }
42}

Details groups/details_groups/delete/v1

This event is triggered when product detail group is deleted. This will be displayed in product description.

Payload

Hide

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

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

event

object

Required

Show

payload

object

Required

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "details-groups"
78      ],
79      "properties": {
80        "details-groups": {
81          "type": "object",
82          "description": "Object containing information about a product detail group. This contains information displayed in product description.",
83          "properties": {
84            "is_default": {
85              "type": "boolean",
86              "description": "Is this a default detailed to be added in all product description."
87            },
88            "slug": {
89              "type": "string",
90              "description": "A unique identifier for the details."
91            },
92            "is_active": {
93              "type": "boolean",
94              "description": "Specifies whether the details group is active and should be visible in descriptions."
95            },
96            "priority": {
97              "type": "integer",
98              "description": "Defines the priority of this details group. Higher values mean it is displayed before other details in description."
99            },
100            "attributes": {
101              "type": "array",
102              "description": "List of attributes associated with the details group.",
103              "items": {
104                "type": "object",
105                "properties": {
106                  "is_active": {
107                    "type": "boolean",
108                    "description": "Indicates if the attribute is active."
109                  },
110                  "name": {
111                    "type": "string",
112                    "description": "Name of the attribute."
113                  },
114                  "display_type": {
115                    "type": "string",
116                    "description": "Type of display used for this attribute (e.g., text, dropdown)."
117                  },
118                  "slug": {
119                    "type": "string",
120                    "description": "A unique identifier for the attribute."
121                  },
122                  "key": {
123                    "type": "string",
124                    "description": "Key used for identifying the attribute in data processing."
125                  },
126                  "priority": {
127                    "type": "integer",
128                    "description": "Defines the order for the attribute withing a group. Higher values indicate that it needs to placed on top in the group."
129                  }
130                },
131                "required": [
132                  "is_active",
133                  "name",
134                  "display_type",
135                  "slug",
136                  "key",
137                  "priority"
138                ]
139              }
140            },
141            "name": {
142              "type": "string",
143              "description": "Name of the details group."
144            },
145            "template_slugs": {
146              "type": "array",
147              "description": "List of unique string associated with any predefined template for the group.",
148              "items": {
149                "type": "string"
150              }
151            },
152            "app_id": {
153              "type": "string",
154              "description": "Identifier for the application this details group belongs to."
155            },
156            "id": {
157              "type": "string",
158              "description": "Unique identifier for the details group."
159            }
160          },
161          "required": [
162            "is_default",
163            "slug",
164            "is_active",
165            "priority",
166            "attributes",
167            "name",
168            "template_slugs",
169            "app_id",
170            "id"
171          ]
172        }
173      }
174    }
175  }
176}

Payload Example

1{
2  "application_id": "6523fa5f41f4eb4c10a1d869",
3  "company_id": 5842,
4  "contains": [
5    "details-groups"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1708644940476,
10    "id": "gFx0LWac2FBTIAmnrwlX05p0cDVbAc02TU46sTOepIQ=",
11    "name": "details-groups",
12    "trace_id": [
13      "silverbolt.16bfae2e-d1db-11ee-ae64-b66edc95121c"
14    ],
15    "type": "create",
16    "version": "1"
17  },
18  "payload": {
19    "details-groups": {
20      "is_default": false,
21      "slug": "details-groups",
22      "is_active": true,
23      "priority": 1,
24      "attributes": [
25        {
26          "is_active": true,
27          "name": "Color",
28          "display_type": "dropdown",
29          "slug": "color",
30          "key": "color_key",
31          "priority": 5
32        }
33      ],
34      "name": "Basic details",
35      "template_slugs": [
36        "test_slug"
37      ],
38      "app_id": "12121232efef",
39      "id": "67f9876abc32"
40    }
41  }
42}

« customobjects/create/v1

discount/create/v1 »