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.

Available pages

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

Events

application/available_pages/create/v1

# this event is triggered when available_pages is created

application/available_pages/update/v1

# this event is triggered when available_pages is updated

application/available_pages/delete/v1

# this event is triggered when available_pages is deleted

Available Pages/available_pages/create/v1

this event is triggered when available_pages is created

Payload

Hide

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

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

event

object

Required

Show

payload

object

Required

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "theme"
78      ],
79      "properties": {
80        "theme": {
81          "type": "object",
82          "description": "theme object containing various parameters",
83          "required": [
84            "path",
85            "type",
86            "seo",
87            "props",
88            "_id",
89            "value",
90            "text",
91            "sections",
92            "sections_meta",
93            "theme",
94            "application"
95          ],
96          "properties": {
97            "__v": {
98              "type": "integer"
99            },
100            "_id": {
101              "type": "string",
102              "description": "Unique Identifier of the section page"
103            },
104            "seo": {
105              "type": "object",
106              "description": "Title and description used for Search Engine Optimization",
107              "required": [
108                "title",
109                "description"
110              ],
111              "properties": {
112                "title": {
113                  "type": "string"
114                },
115                "description": {
116                  "type": "string"
117                }
118              }
119            },
120            "path": {
121              "type": "string",
122              "description": "Path where the page will be loaded"
123            },
124            "text": {
125              "type": "string",
126              "description": "Name given to the page"
127            },
128            "type": {
129              "type": "string",
130              "description": "Type of page, e.g. sections"
131            },
132            "props": {
133              "type": "array",
134              "description": "Page-level configuration details",
135              "items": {
136                "type": "object",
137                "properties": {
138                  "default": {
139                    "type": [
140                      "boolean",
141                      "string",
142                      "object",
143                      "number",
144                      "null",
145                      "array"
146                    ],
147                    "description": "Value for default value of prop."
148                  },
149                  "id": {
150                    "type": "string",
151                    "description": "string that represents the ID of the schema"
152                  },
153                  "label": {
154                    "type": "string",
155                    "description": "title of label"
156                  },
157                  "type": {
158                    "type": "string",
159                    "description": "type of UI component(like textbox,checkbox)"
160                  }
161                }
162              }
163            },
164            "theme": {
165              "type": "string",
166              "description": "ID of the theme within which the section page exists"
167            },
168            "value": {
169              "type": "string",
170              "description": "URL-friendly identifier given to the page"
171            },
172            "sections": {
173              "type": "array",
174              "description": "Details of all the sections included in the page",
175              "items": {}
176            },
177            "sections_meta": {
178              "type": "array",
179              "items": {}
180            },
181            "application": {
182              "type": "string"
183            }
184          }
185        }
186      }
187    }
188  }
189}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "blitzkrieg.12a01877-79fe-4b90-a91d-2cf1e78a8d43"
5    ],
6    "name": "available_pages",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711611409937,
10    "id": "5KksEFTHinLQhRYVhP6/sDdtj3jqf5wE6bSiA85VMKs=",
11    "category": "application"
12  },
13  "company_id": 4835,
14  "application_id": "646f16ecacf6d0900a166cc6",
15  "contains": [
16    "theme"
17  ],
18  "payload": {
19    "theme": {
20      "value": "c:::ugadi-contest",
21      "text": "Ugadi Contest",
22      "path": "c/ugadi-contest",
23      "type": "custom",
24      "sections": [],
25      "sections_meta": [],
26      "theme": "647032235be8e32873528087",
27      "seo": {
28        "title": "",
29        "description": "",
30        "sitemap": {
31          "priority": 0.5,
32          "frequency": "never"
33        },
34        "canonical_url": "",
35        "breadcrumbs": [],
36        "meta_tags": []
37      },
38      "props": [
39        {
40          "default": true,
41          "id": "header",
42          "label": "Header",
43          "type": "checkbox"
44        }
45      ],
46      "_id": "66051e11247a7df59105c4d2",
47      "created_at": "2024-03-28T07:36:49.925Z",
48      "updated_at": "2024-03-28T07:36:49.925Z",
49      "__v": 0,
50      "application": "646f16ecacf6d0900a166cc6",
51      "cli_version": "5.0.2"
52    }
53  }
54}

Available Pages/available_pages/update/v1

this event is triggered when available_pages is updated

Payload

Hide

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

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

event

object

Required

Show

payload

object

Required

Show

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        "theme"
78      ],
79      "properties": {
80        "theme": {
81          "type": "object",
82          "required": [
83            "path",
84            "type",
85            "seo",
86            "props",
87            "_id",
88            "value",
89            "text",
90            "sections",
91            "sections_meta",
92            "theme",
93            "application"
94          ],
95          "properties": {
96            "__v": {
97              "type": "integer",
98              "description": "Version number"
99            },
100            "_id": {
101              "type": "string",
102              "description": "Unique Identifier of the theme"
103            },
104            "seo": {
105              "type": "object",
106              "required": [
107                "title",
108                "description"
109              ],
110              "properties": {
111                "title": {
112                  "type": "string",
113                  "description": "Title used for Search Engine Optimization"
114                },
115                "description": {
116                  "type": "string",
117                  "description": "Description used for Search Engine Optimization"
118                }
119              },
120              "description": "SEO details"
121            },
122            "path": {
123              "type": "string",
124              "description": "Path where the theme is located"
125            },
126            "text": {
127              "type": "string",
128              "description": "Name given to the theme"
129            },
130            "type": {
131              "type": "string",
132              "description": "Type of theme"
133            },
134            "props": {
135              "type": "array",
136              "items": {
137                "type": "object",
138                "properties": {
139                  "default": {
140                    "type": [
141                      "boolean",
142                      "string",
143                      "object",
144                      "number",
145                      "null",
146                      "array"
147                    ],
148                    "description": "Value for default value of prop."
149                  },
150                  "id": {
151                    "type": "string",
152                    "description": "string that represents the ID of the schema"
153                  },
154                  "label": {
155                    "type": "string",
156                    "description": "title of label"
157                  },
158                  "type": {
159                    "type": "string",
160                    "description": "type of UI component(like textbox,checkbox)"
161                  }
162                }
163              },
164              "description": "Theme-level configuration details"
165            },
166            "theme": {
167              "type": "string",
168              "description": "Theme ID"
169            },
170            "value": {
171              "type": "string",
172              "description": "URL-friendly identifier given to the theme"
173            },
174            "sections": {
175              "type": "array",
176              "items": {},
177              "description": "Details of all sections included in the theme"
178            },
179            "sections_meta": {
180              "type": "array",
181              "items": {},
182              "description": "Metadata for the sections"
183            },
184            "application": {
185              "type": "string",
186              "description": "Application name"
187            }
188          }
189        }
190      }
191    }
192  }
193}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "blitzkrieg.c651defb-1349-459e-b866-ff1c786e0ac3"
5    ],
6    "name": "available_pages",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711611291092,
10    "id": "v/Vjp4mUS26IZ47rP4GM9mcwHsIHTfYj/9Z453fgJUk=",
11    "category": "application"
12  },
13  "company_id": 4835,
14  "application_id": "646f16ecacf6d0900a166cc6",
15  "contains": [
16    "theme"
17  ],
18  "payload": {
19    "theme": {
20      "_id": "647032265be8e306235280bc",
21      "path": "order-tracking/:orderId",
22      "type": "system",
23      "seo": {
24        "sitemap": {
25          "frequency": "never",
26          "priority": 0.5
27        },
28        "title": "",
29        "description": "",
30        "breadcrumbs": [],
31        "canonical_url": "",
32        "meta_tags": []
33      },
34      "props": [
35        {
36          "default": true,
37          "id": "header",
38          "label": "Header",
39          "type": "checkbox"
40        }
41      ],
42      "value": "order-tracking-details",
43      "sections": [],
44      "sections_meta": [],
45      "text": "Order Tracking Details",
46      "created_at": "2022-07-19T04:36:14.244Z",
47      "updated_at": "2024-03-28T07:34:50.985Z",
48      "theme": "647032235be8e32873528087",
49      "__v": 47,
50      "application": "646f16ecacf6d0900a166cc6",
51      "cli_version": "5.0.2"
52    }
53  }
54}

Available Pages/available_pages/delete/v1

this event is triggered when available_pages is deleted

Payload

Hide

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

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

event

object

Required

Show

payload

object

Required

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "theme"
78      ],
79      "properties": {
80        "theme": {
81          "type": "object",
82          "required": [
83            "path",
84            "type",
85            "seo",
86            "props",
87            "_id",
88            "value",
89            "text",
90            "sections",
91            "sections_meta",
92            "theme",
93            "application"
94          ],
95          "properties": {
96            "__v": {
97              "type": "integer",
98              "description": "Version number"
99            },
100            "_id": {
101              "type": "string",
102              "description": "Unique Identifier of the section page"
103            },
104            "seo": {
105              "type": "object",
106              "required": [
107                "title",
108                "description"
109              ],
110              "properties": {
111                "title": {
112                  "type": "string",
113                  "description": "Title used for Search Engine Optimization"
114                },
115                "description": {
116                  "type": "string",
117                  "description": "Description used for Search Engine Optimization"
118                }
119              },
120              "description": "SEO details"
121            },
122            "path": {
123              "type": "string",
124              "description": "Path where the page will be loaded"
125            },
126            "text": {
127              "type": "string",
128              "description": "Name given to the page"
129            },
130            "type": {
131              "type": "string",
132              "description": "Type of page, e.g. sections"
133            },
134            "props": {
135              "type": "array",
136              "items": {
137                "type": "object",
138                "properties": {
139                  "default": {
140                    "type": [
141                      "boolean",
142                      "string",
143                      "object",
144                      "number",
145                      "null",
146                      "array"
147                    ],
148                    "description": "Value for default value of prop."
149                  },
150                  "id": {
151                    "type": "string",
152                    "description": "string that represents the ID of the schema"
153                  },
154                  "label": {
155                    "type": "string",
156                    "description": "title of label"
157                  },
158                  "type": {
159                    "type": "string",
160                    "description": "type of UI component(like textbox,checkbox)"
161                  }
162                }
163              },
164              "description": "Page-level configuration details"
165            },
166            "theme": {
167              "type": "string",
168              "description": "ID of the theme within which the section page exists"
169            },
170            "value": {
171              "type": "string",
172              "description": "URL-friendly identifier given to the page"
173            },
174            "sections": {
175              "type": "array",
176              "items": {},
177              "description": "Details of all the sections included in the page"
178            },
179            "sections_meta": {
180              "type": "array",
181              "items": {},
182              "description": "Metadata for the sections"
183            },
184            "application": {
185              "type": "string",
186              "description": "Application name"
187            }
188          }
189        }
190      }
191    }
192  }
193}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "blitzkrieg.6f55b163-69b3-4d9b-a813-084df4b69a6a"
5    ],
6    "name": "available_pages",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1711701676466,
10    "id": "jhIEK0IZ4F/m3U9P8w1n3fT6uC5OK7XmyyQdf+pjP1o=",
11    "category": "application"
12  },
13  "company_id": 4835,
14  "application_id": "646f16ecacf6d0900a166cc6",
15  "contains": [
16    "theme"
17  ],
18  "payload": {
19    "theme": {
20      "_id": "65a12e9670e4da2ebf5f36ef",
21      "path": "c/republic-day-contest",
22      "type": "custom",
23      "seo": {
24        "sitemap": {
25          "priority": 0.5,
26          "frequency": "never"
27        },
28        "title": "",
29        "description": "",
30        "breadcrumbs": [],
31        "meta_tags": [],
32        "canonical_url": ""
33      },
34      "props": [
35        {
36          "default": true,
37          "id": "header",
38          "label": "Header",
39          "type": "checkbox"
40        }
41      ],
42      "value": "c:::republic-day-contest",
43      "text": "Republic Day Contest",
44      "sections": [],
45      "sections_meta": [],
46      "theme": "647032235be8e32873528087",
47      "created_at": "2024-01-12T12:20:38.973Z",
48      "updated_at": "2024-03-28T13:27:30.651Z",
49      "__v": 19,
50      "application": "646f16ecacf6d0900a166cc6",
51      "cli_version": "5.0.2"
52    }
53  }
54}

« article/create/v1

cart/create/v1 »