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.

Variant configuration

This event will be generated where there is any action done on application variant configuration.

Events

application/variant/create/v1

# this event is triggered when variant configuration is created.

application/variant/update/v1

# this event is triggered when variant configuration is updated.

application/variant/delete/v1

# this event is triggered when variant configuration is deleted.

Variant Configuration/variant/create/v1

this event is triggered when variant configuration is created.

Payload

Properties

application_id

array of

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

Properties

category

string

Required

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

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

Required

Properties

variant

object

Required

Variant configuration details.

Properties

string

Required

UUID of the variant configuration.

app_id

string

Required

Unique ID of the application.

key

string

Required

Unique Key for the attribute variant.

name

string

Required

Display name of the variant.

is_active

boolean

Required

Active status of the variant.

is_default

boolean

Whether this is the default variant configuration.

size

object

Required

Specifies the minimum and maximum number of variants to display.

Properties

min

integer

Minimum number of variants to be displayed.

max

integer

Maximum number of variants to be displayed.

logo

string

URL for the logo image of the variant.

priority

integer

Display priority for the variant.

display_type

string

Required

Type of display for the variant, e.g., text or image.

Enum

show

boolean

Visibility of the variant on the UI.

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": "array",
13      "description": "Sales channel ID for which this event is triggered."
14    },
15    "company_id": {
16      "type": "integer",
17      "description": "Company ID for which this event is triggered."
18    },
19    "contains": {
20      "type": "array",
21      "description": "This array will have all the keys present at root level of 'payload' object.",
22      "items": {
23        "type": "string"
24      }
25    },
26    "event": {
27      "type": "object",
28      "required": [
29        "category",
30        "created_timestamp",
31        "id",
32        "name",
33        "trace_id",
34        "type",
35        "version"
36      ],
37      "properties": {
38        "category": {
39          "type": "string",
40          "description": "Category of the event. If it is at sales channel level or company level."
41        },
42        "created_timestamp": {
43          "type": "integer",
44          "description": "Event generation timestamp in epoch milliseconds."
45        },
46        "id": {
47          "type": "string",
48          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver."
49        },
50        "name": {
51          "type": "string",
52          "description": "Name of the event"
53        },
54        "trace_id": {
55          "type": "array",
56          "description": "Internal trace_id for Fynd Platform services.",
57          "items": {
58            "type": "string"
59          }
60        },
61        "type": {
62          "type": "string",
63          "description": "Type/Action of the event. e.g. create/update/delete."
64        },
65        "version": {
66          "type": "string",
67          "description": "Version of the event."
68        }
69      }
70    },
71    "payload": {
72      "type": "object",
73      "required": [
74        "variant"
75      ],
76      "properties": {
77        "variant": {
78          "type": "object",
79          "required": [
80            "is_active",
81            "app_id",
82            "key",
83            "name",
84            "size",
85            "display_type",
86            "id"
87          ],
88          "properties": {
89            "id": {
90              "type": "string",
91              "description": "UUID of the variant configuration."
92            },
93            "app_id": {
94              "type": "string",
95              "description": "Unique ID of the application."
96            },
97            "key": {
98              "type": "string",
99              "description": "Unique Key for the attribute variant."
100            },
101            "name": {
102              "type": "string",
103              "description": "Display name of the variant."
104            },
105            "is_active": {
106              "type": "boolean",
107              "description": "Active status of the variant."
108            },
109            "is_default": {
110              "type": "boolean",
111              "description": "Whether this is the default variant configuration."
112            },
113            "size": {
114              "type": "object",
115              "description": "Specifies the minimum and maximum number of variants to display.",
116              "properties": {
117                "min": {
118                  "type": "integer",
119                  "description": "Minimum number of variants to be displayed."
120                },
121                "max": {
122                  "type": "integer",
123                  "description": "Maximum number of variants to be displayed."
124                }
125              }
126            },
127            "logo": {
128              "type": "string",
129              "description": "URL for the logo image of the variant."
130            },
131            "priority": {
132              "type": "integer",
133              "description": "Display priority for the variant."
134            },
135            "display_type": {
136              "type": "string",
137              "enum": [
138                "color",
139                "text",
140                "swatch_image",
141                "product_image"
142              ],
143              "description": "Type of display for the variant, e.g., text or image."
144            },
145            "show": {
146              "type": "boolean",
147              "description": "Visibility of the variant on the UI."
148            }
149          },
150          "description": "Variant configuration details."
151        }
152      }
153    }
154  }
155}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3f80dad4-f2bc-11ee-b736-92d34068c369"
5    ],
6    "name": "variant",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712260082824,
10    "id": "xjazBsVwGyBmiSmTf3M4rdAE542AfUji3z8F1i2eRT4=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31"
17  ],
18  "contains": [
19    "variant"
20  ],
21  "payload": {
22    "variant": {
23      "id": "6773ca37c1f7b57fcc7892ec",
24      "is_active": true,
25      "app_id": "676ac38c6073bad0cc4a4a5e",
26      "key": "test-attribute",
27      "name": "testing",
28      "is_default": false,
29      "size": {
30        "min": 1,
31        "max": 1
32      },
33      "logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/storearchive/misc/default-assets/original/popular.png",
34      "priority": 1,
35      "display_type": "text",
36      "show": true
37    }
38  }
39}

Variant Configuration/variant/update/v1

this event is triggered when variant configuration is updated.

Payload

Properties

application_id

array of

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

Properties

category

string

Required

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

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

Required

Properties

variant

object

Required

Variant configuration details.

Properties

string

Required

UUID of the variant configuration.

app_id

string

Required

Unique ID of the application.

key

string

Required

Unique Key for the attribute variant.

name

string

Required

Display name of the variant.

is_active

boolean

Required

Active status of the variant.

is_default

boolean

Whether this is the default variant configuration.

size

object

Required

Specifies the minimum and maximum number of variants to display.

Properties

min

integer

Minimum number of variants to be displayed.

max

integer

Maximum number of variants to be displayed.

logo

string

URL for the logo image of the variant.

priority

integer

Display priority for the variant.

display_type

string

Required

Type of display for the variant, e.g., text or image.

Enum

show

boolean

Visibility of the variant on the UI.

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": "array",
13      "description": "Sales channel ID for which this event is triggered."
14    },
15    "company_id": {
16      "type": "integer",
17      "description": "Company ID for which this event is triggered"
18    },
19    "contains": {
20      "type": "array",
21      "description": "This array will have all the keys present at root level of 'payload' object",
22      "items": {
23        "type": "string"
24      }
25    },
26    "event": {
27      "type": "object",
28      "required": [
29        "category",
30        "created_timestamp",
31        "id",
32        "name",
33        "trace_id",
34        "type",
35        "version"
36      ],
37      "properties": {
38        "category": {
39          "type": "string",
40          "description": "Category of the event. If it is at sales channel level or company level."
41        },
42        "created_timestamp": {
43          "type": "integer",
44          "description": "Event generation timestamp in epoch milliseconds."
45        },
46        "id": {
47          "type": "string",
48          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver."
49        },
50        "name": {
51          "type": "string",
52          "description": "Name of the event."
53        },
54        "trace_id": {
55          "type": "array",
56          "description": "Internal trace_id for Fynd Platform services.",
57          "items": {
58            "type": "string"
59          }
60        },
61        "type": {
62          "type": "string",
63          "description": "Type/Action of the event. e.g. create/update/delete."
64        },
65        "version": {
66          "type": "string",
67          "description": "Version of the event."
68        }
69      }
70    },
71    "payload": {
72      "type": "object",
73      "required": [
74        "variant"
75      ],
76      "properties": {
77        "variant": {
78          "type": "object",
79          "required": [
80            "is_active",
81            "app_id",
82            "key",
83            "name",
84            "size",
85            "display_type",
86            "id"
87          ],
88          "properties": {
89            "id": {
90              "type": "string",
91              "description": "UUID of the variant configuration."
92            },
93            "app_id": {
94              "type": "string",
95              "description": "Unique ID of the application."
96            },
97            "key": {
98              "type": "string",
99              "description": "Unique Key for the attribute variant."
100            },
101            "name": {
102              "type": "string",
103              "description": "Display name of the variant."
104            },
105            "is_active": {
106              "type": "boolean",
107              "description": "Active status of the variant."
108            },
109            "is_default": {
110              "type": "boolean",
111              "description": "Whether this is the default variant configuration."
112            },
113            "size": {
114              "type": "object",
115              "description": "Specifies the minimum and maximum number of variants to display.",
116              "properties": {
117                "min": {
118                  "type": "integer",
119                  "description": "Minimum number of variants to be displayed."
120                },
121                "max": {
122                  "type": "integer",
123                  "description": "Maximum number of variants to be displayed."
124                }
125              }
126            },
127            "logo": {
128              "type": "string",
129              "description": "URL for the logo image of the variant."
130            },
131            "priority": {
132              "type": "integer",
133              "description": "Display priority for the variant."
134            },
135            "display_type": {
136              "type": "string",
137              "enum": [
138                "color",
139                "text",
140                "swatch_image",
141                "product_image"
142              ],
143              "description": "Type of display for the variant, e.g., text or image."
144            },
145            "show": {
146              "type": "boolean",
147              "description": "Visibility of the variant on the UI."
148            }
149          },
150          "description": "Variant configuration details."
151        }
152      }
153    }
154  }
155}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3f80dad4-f2bc-11ee-b736-92d34068c369"
5    ],
6    "name": "variant",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712260082824,
10    "id": "xjazBsVwGyBmiSmTf3M4rdAE542AfUji3z8F1i2eRT4=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31"
17  ],
18  "contains": [
19    "variant"
20  ],
21  "payload": {
22    "variant": {
23      "id": "6773ca37c1f7b57fcc7892ec",
24      "is_active": true,
25      "app_id": "676ac38c6073bad0cc4a4a5e",
26      "key": "test-attribute",
27      "name": "testing",
28      "is_default": false,
29      "size": {
30        "min": 1,
31        "max": 1
32      },
33      "logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/storearchive/misc/default-assets/original/popular.png",
34      "priority": 1,
35      "display_type": "text",
36      "show": true
37    }
38  }
39}

Variant Configuration/variant/delete/v1

this event is triggered when variant configuration is deleted.

Payload

Properties

application_id

array of

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

Properties

category

string

Required

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

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

Required

Properties

variant

object

Required

Variant configuration details.

Properties

string

Required

UUID of the variant configuration.

key

string

Required

Unique Key for the attribute variant.

name

string

Required

Display name of the variant.

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": "array",
13      "description": "Sales channel ID for which this event is triggered."
14    },
15    "company_id": {
16      "type": "integer",
17      "description": "Company ID for which this event is triggered"
18    },
19    "contains": {
20      "type": "array",
21      "description": "This array will have all the keys present at root level of 'payload' object.",
22      "items": {
23        "type": "string"
24      }
25    },
26    "event": {
27      "type": "object",
28      "required": [
29        "category",
30        "created_timestamp",
31        "id",
32        "name",
33        "trace_id",
34        "type",
35        "version"
36      ],
37      "properties": {
38        "category": {
39          "type": "string",
40          "description": "Category of the event. If it is at sales channel level or company level."
41        },
42        "created_timestamp": {
43          "type": "integer",
44          "description": "Event generation timestamp in epoch milliseconds."
45        },
46        "id": {
47          "type": "string",
48          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver."
49        },
50        "name": {
51          "type": "string",
52          "description": "Name of the event."
53        },
54        "trace_id": {
55          "type": "array",
56          "description": "Internal trace_id for Fynd Platform services.",
57          "items": {
58            "type": "string"
59          }
60        },
61        "type": {
62          "type": "string",
63          "description": "Type/Action of the event. e.g. create/update/delete."
64        },
65        "version": {
66          "type": "string",
67          "description": "Version of the event."
68        }
69      }
70    },
71    "payload": {
72      "type": "object",
73      "required": [
74        "variant"
75      ],
76      "properties": {
77        "variant": {
78          "type": "object",
79          "required": [
80            "key",
81            "name",
82            "id"
83          ],
84          "properties": {
85            "id": {
86              "type": "string",
87              "description": "UUID of the variant configuration."
88            },
89            "key": {
90              "type": "string",
91              "description": "Unique Key for the attribute variant."
92            },
93            "name": {
94              "type": "string",
95              "description": "Display name of the variant."
96            }
97          },
98          "description": "Variant configuration details."
99        }
100      }
101    }
102  }
103}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3f80dad4-f2bc-11ee-b736-92d34068c369"
5    ],
6    "name": "variant",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712260082824,
10    "id": "xjazBsVwGyBmiSmTf3M4rdAE542AfUji3z8F1i2eRT4=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31"
17  ],
18  "contains": [
19    "variant"
20  ],
21  "payload": {
22    "variant": {
23      "id": "6773ca37c1f7b57fcc7892ec",
24      "is_active": true,
25      "app_id": "676ac38c6073bad0cc4a4a5e",
26      "key": "test-attribute",
27      "name": "testing",
28      "is_default": false,
29      "size": {
30        "min": 1,
31        "max": 1
32      },
33      "priority": 1,
34      "display_type": "text",
35      "show": true
36    }
37  }
38}

« user/create/v1

zone/create/v1 »