Company

Events categorised under company level will be triggered when any action performed on company. e.g. If new brand is created.

Customfields

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

Events

company/customfields/inventory-update/v1

# This event is triggered when a custom field from inventory is updated

company/customfields/inventory-delete/v1

# This event is triggered when a custom field from inventory is deleted

company/customfields/product-update/v1

# This event is triggered when a custom field from product is updated

company/customfields/product-delete/v1

# This event is triggered when a custom field from product is deleted

company/customfields/product-size-update/v1

# This event is triggered when a custom field from product size is updated

company/customfields/product-size-delete/v1

# This event is triggered when a custom field from product size is deleted

company/customfields/selling-location-update/v1

# This event is triggered when a custom field from selling location is updated

Customfields/customfields/inventory-update/v1

This event is triggered when a custom field from inventory is updated

Payload

Properties

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

array of Undefined Type

Required

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "Company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "Category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "Event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "Internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "array",
68      "items": [
69        {
70          "type": "object",
71          "properties": {
72            "id": {
73              "type": "string",
74              "description": "Uniquely generated mongoId of custom field and its not editable."
75            },
76            "namespace": {
77              "type": "string",
78              "description": "Namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
79            },
80            "slug": {
81              "type": "string",
82              "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
83            },
84            "resource": {
85              "type": "string",
86              "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
87            },
88            "resource_slug": {
89              "type": "string",
90              "description": "This indicate the resource id where this custom field value is assosiated."
91            },
92            "type": {
93              "type": "string",
94              "description": "This is field_type of the custom field definition. Its non-editable",
95              "enum": [
96                "string_single_line",
97                "string_multi_line",
98                "dropdown",
99                "integer",
100                "float_type",
101                "boolean_type",
102                "date",
103                "datetime",
104                "duration",
105                "json",
106                "file",
107                "url",
108                "html",
109                "metaobject",
110                "product",
111                "blog",
112                "page",
113                "order",
114                "collection"
115              ]
116            },
117            "multi_value": {
118              "type": "boolean",
119              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
120            },
121            "company_id": {
122              "type": "string",
123              "description": "This is company id where this custom fields created."
124            },
125            "value": {
126              "type": "array",
127              "items": {
128                "type": [
129                  "string",
130                  "number",
131                  "object",
132                  "boolean"
133                ]
134              },
135              "description": "This is array of values of custom fields. if multi value false then it has only single value in array. and in case of json this is json object."
136            }
137          },
138          "required": [
139            "id",
140            "namespace",
141            "slug",
142            "resource",
143            "resource_slug",
144            "type",
145            "multi_value",
146            "company_id",
147            "value"
148          ]
149        }
150      ]
151    }
152  }
153}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.153654a1-d988-4d39-aa87-8515d5e42aa5"
5    ],
6    "name": "customfields",
7    "type": "inventory-update",
8    "version": "1",
9    "created_timestamp": 1712060467980,
10    "id": "dyci3lT07XseHaDQPLUhjk1QSdl9b+koDs3MZsejFKI=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 123,
15  "contains": [
16    "0"
17  ],
18  "payload": [
19    {
20      "id": "660bf833d88ca61624eed2ef",
21      "namespace": "custom",
22      "slug": "testinventory",
23      "resource": "inventory",
24      "resource_slug": "2002_SDCLOINSKDFV",
25      "type": "dropdown",
26      "multi_value": false,
27      "company_id": "123",
28      "invalid_value_errors": [],
29      "has_invalid_values": false,
30      "value": [
31        "15"
32      ]
33    }
34  ]
35}

Customfields/customfields/inventory-delete/v1

This event is triggered when a custom field from inventory is deleted

Payload

Properties

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

array of Undefined Type

Required

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "Company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "Category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "Event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "Internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "array",
68      "items": [
69        {
70          "type": "object",
71          "properties": {
72            "id": {
73              "type": "string",
74              "description": "Uniquely generated mongoId of custom field and its not editable."
75            },
76            "namespace": {
77              "type": "string",
78              "description": "Namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
79            },
80            "slug": {
81              "type": "string",
82              "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
83            },
84            "resource": {
85              "type": "string",
86              "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
87            },
88            "resource_slug": {
89              "type": "string",
90              "description": "This indicate the resource id where this custom field value is assosiated."
91            },
92            "type": {
93              "type": "string",
94              "description": "This is field_type of the custom field definition. Its non-editable",
95              "enum": [
96                "string_single_line",
97                "string_multi_line",
98                "dropdown",
99                "integer",
100                "float_type",
101                "boolean_type",
102                "date",
103                "datetime",
104                "duration",
105                "json",
106                "file",
107                "url",
108                "html",
109                "metaobject",
110                "product",
111                "blog",
112                "page",
113                "order",
114                "collection"
115              ]
116            },
117            "multi_value": {
118              "type": "boolean",
119              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
120            },
121            "company_id": {
122              "type": "string",
123              "description": "This is company id where this custom fields created."
124            },
125            "value": {
126              "type": "array",
127              "items": {
128                "type": [
129                  "string",
130                  "number",
131                  "object",
132                  "boolean"
133                ]
134              },
135              "description": "This is array of values of custom fields. if multi value false then it has only single value in array. and in case of json this is json object."
136            }
137          },
138          "required": [
139            "id",
140            "namespace",
141            "slug",
142            "resource",
143            "resource_slug",
144            "type",
145            "multi_value",
146            "company_id",
147            "value"
148          ]
149        }
150      ]
151    }
152  }
153}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.50a12eec-1903-471e-9475-64ef9f3c3c4d"
5    ],
6    "name": "customfields",
7    "type": "inventory-delete",
8    "version": "1",
9    "created_timestamp": 1711970264456,
10    "id": "8K4FWSNo3x2t5IA1atkT3BKeII/MB+gXKEUiKxKTHaI=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "contains": [],
16  "payload": []
17}

Customfields/customfields/product-update/v1

This event is triggered when a custom field from product is updated

Payload

Properties

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

array of Undefined Type

Required

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "Company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "Category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "Event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "Internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "array",
68      "items": [
69        {
70          "type": "object",
71          "properties": {
72            "id": {
73              "type": "string",
74              "description": "Uniquely generated mongoId of custom field and its not editable."
75            },
76            "namespace": {
77              "type": "string",
78              "description": "Namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
79            },
80            "slug": {
81              "type": "string",
82              "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
83            },
84            "resource": {
85              "type": "string",
86              "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
87            },
88            "resource_slug": {
89              "type": "string",
90              "description": "This indicate the resource id where this custom field value is assosiated."
91            },
92            "type": {
93              "type": "string",
94              "description": "This is field_type of the custom field definition. Its non-editable",
95              "enum": [
96                "string_single_line",
97                "string_multi_line",
98                "dropdown",
99                "integer",
100                "float_type",
101                "boolean_type",
102                "date",
103                "datetime",
104                "duration",
105                "json",
106                "file",
107                "url",
108                "html",
109                "metaobject",
110                "product",
111                "blog",
112                "page",
113                "order",
114                "collection"
115              ]
116            },
117            "multi_value": {
118              "type": "boolean",
119              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
120            },
121            "company_id": {
122              "type": "string",
123              "description": "This is company id where this custom fields created."
124            },
125            "value": {
126              "type": "array",
127              "items": {
128                "type": [
129                  "string",
130                  "number",
131                  "object",
132                  "boolean"
133                ]
134              },
135              "description": "This is array of values of custom fields. if multi value false then it has only single value in array. and in case of json this is json object."
136            }
137          },
138          "required": [
139            "id",
140            "namespace",
141            "slug",
142            "resource",
143            "resource_slug",
144            "type",
145            "multi_value",
146            "company_id",
147            "value"
148          ]
149        }
150      ]
151    }
152  }
153}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.b8611b3f-9def-442f-896d-489efc61d662"
5    ],
6    "name": "customfields",
7    "type": "product-update",
8    "version": "1",
9    "created_timestamp": 1712577828434,
10    "id": "axvEXh33Uj4DohGqJ1QZ8ktwoow2Rcdrigj8oht8LOI=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "contains": [
16    "0",
17    "1",
18    "2",
19    "3",
20    "4"
21  ],
22  "payload": [
23    {
24      "id": "6613dd2438506758ac6c53ca",
25      "namespace": "custom",
26      "slug": "object-value",
27      "resource": "product",
28      "resource_slug": "7643471",
29      "type": "metaobject",
30      "multi_value": false,
31      "company_id": "1",
32      "invalid_value_errors": [],
33      "has_invalid_values": false,
34      "value": [
35        "66138964e7202ce6d4544d2c"
36      ]
37    },
38    {
39      "id": "6613dd2438506758ac6c53cb",
40      "namespace": "custom",
41      "slug": "kafka-def-product",
42      "resource": "product",
43      "resource_slug": "7643471",
44      "type": "float_type",
45      "multi_value": false,
46      "company_id": "1",
47      "invalid_value_errors": [],
48      "has_invalid_values": false,
49      "value": [
50        1.2356
51      ]
52    },
53    {
54      "id": "6613dd2438506758ac6c53cc",
55      "namespace": "custom",
56      "slug": "kafka-pro-def",
57      "resource": "product",
58      "resource_slug": "7643471",
59      "type": "string_single_line",
60      "multi_value": false,
61      "company_id": "1",
62      "invalid_value_errors": [],
63      "has_invalid_values": false,
64      "value": [
65        "pro input value"
66      ]
67    },
68    {
69      "id": "6613dd2438506758ac6c53cd",
70      "namespace": "custom",
71      "slug": "slt",
72      "resource": "product",
73      "resource_slug": "7643471",
74      "type": "string_single_line",
75      "multi_value": false,
76      "company_id": "1",
77      "invalid_value_errors": [],
78      "has_invalid_values": false,
79      "value": [
80        "SLT pro"
81      ]
82    },
83    {
84      "id": "6613dd2438506758ac6c53ce",
85      "namespace": "custom",
86      "slug": "url",
87      "resource": "product",
88      "resource_slug": "7643471",
89      "type": "url",
90      "multi_value": false,
91      "company_id": "1",
92      "invalid_value_errors": [],
93      "has_invalid_values": false,
94      "value": [
95        "https://dev.azure.com/GoFynd/FyndPlatformCore/_testPlans/execute?planId=603&suiteId=50419"
96      ]
97    }
98  ]
99}

Customfields/customfields/product-delete/v1

This event is triggered when a custom field from product is deleted

Payload

Properties

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

array of Undefined Type

Required

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "Company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "Category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "Event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "Internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "array",
68      "items": [
69        {
70          "type": "object",
71          "properties": {
72            "id": {
73              "type": "string",
74              "description": "Uniquely generated mongoId of custom field and its not editable."
75            },
76            "namespace": {
77              "type": "string",
78              "description": "Namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
79            },
80            "slug": {
81              "type": "string",
82              "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
83            },
84            "resource": {
85              "type": "string",
86              "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
87            },
88            "resource_slug": {
89              "type": "string",
90              "description": "This indicate the resource id where this custom field value is assosiated."
91            },
92            "type": {
93              "type": "string",
94              "description": "This is field_type of the custom field definition. Its non-editable",
95              "enum": [
96                "string_single_line",
97                "string_multi_line",
98                "dropdown",
99                "integer",
100                "float_type",
101                "boolean_type",
102                "date",
103                "datetime",
104                "duration",
105                "json",
106                "file",
107                "url",
108                "html",
109                "metaobject",
110                "product",
111                "blog",
112                "page",
113                "order",
114                "collection"
115              ]
116            },
117            "multi_value": {
118              "type": "boolean",
119              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
120            },
121            "company_id": {
122              "type": "string",
123              "description": "This is company id where this custom fields created."
124            },
125            "value": {
126              "type": "array",
127              "items": {
128                "type": [
129                  "string",
130                  "number",
131                  "object",
132                  "boolean"
133                ]
134              },
135              "description": "This is array of values of custom fields. if multi value false then it has only single value in array. and in case of json this is json object."
136            }
137          },
138          "required": [
139            "id",
140            "namespace",
141            "slug",
142            "resource",
143            "resource_slug",
144            "type",
145            "multi_value",
146            "company_id",
147            "value"
148          ]
149        }
150      ]
151    }
152  }
153}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.455949e3-aeae-4961-8660-857927b6c355"
5    ],
6    "name": "customfields",
7    "type": "product-delete",
8    "version": "1",
9    "created_timestamp": 1712572109757,
10    "id": "mLoBXO+HoSLffGUFuO6DEFVNiRMA2/UTmY+GM3TPt9c=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26778,
15  "contains": [],
16  "payload": []
17}

Customfields/customfields/product-size-update/v1

This event is triggered when a custom field from product size is updated

Payload

Properties

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

array of Undefined Type

Required

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "Company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "Category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "Event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "Internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "array",
68      "items": [
69        {
70          "type": "object",
71          "properties": {
72            "id": {
73              "type": "string",
74              "description": "Uniquely generated mongoId of custom field and its not editable."
75            },
76            "namespace": {
77              "type": "string",
78              "description": "Namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
79            },
80            "slug": {
81              "type": "string",
82              "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
83            },
84            "resource": {
85              "type": "string",
86              "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
87            },
88            "resource_slug": {
89              "type": "string",
90              "description": "This indicate the resource id where this custom field value is assosiated."
91            },
92            "type": {
93              "type": "string",
94              "description": "This is field_type of the custom field definition. Its non-editable",
95              "enum": [
96                "string_single_line",
97                "string_multi_line",
98                "dropdown",
99                "integer",
100                "float_type",
101                "boolean_type",
102                "date",
103                "datetime",
104                "duration",
105                "json",
106                "file",
107                "url",
108                "html",
109                "metaobject",
110                "product",
111                "blog",
112                "page",
113                "order",
114                "collection"
115              ]
116            },
117            "multi_value": {
118              "type": "boolean",
119              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
120            },
121            "company_id": {
122              "type": "string",
123              "description": "This is company id where this custom fields created."
124            },
125            "value": {
126              "type": "array",
127              "items": {
128                "type": [
129                  "string",
130                  "number",
131                  "object",
132                  "boolean"
133                ]
134              },
135              "description": "This is array of values of custom fields. if multi value false then it has only single value in array. and in case of json this is json object."
136            }
137          },
138          "required": [
139            "id",
140            "namespace",
141            "slug",
142            "resource",
143            "resource_slug",
144            "type",
145            "multi_value",
146            "company_id",
147            "value"
148          ]
149        }
150      ]
151    }
152  }
153}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.b8611b3f-9def-442f-896d-489efc61d662"
5    ],
6    "name": "customfields",
7    "type": "product-size-update",
8    "version": "1",
9    "created_timestamp": 1712577828434,
10    "id": "axvEXh33Uj4DohGqJ1QZ8ktwoow2Rcdrigj8oht8LOI=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "contains": [
16    "0",
17    "1",
18    "2",
19    "3",
20    "4"
21  ],
22  "payload": [
23    {
24      "id": "6613dd2438506758ac6c53ca",
25      "namespace": "custom",
26      "slug": "object-value",
27      "resource": "product-size",
28      "resource_slug": "7643471",
29      "type": "metaobject",
30      "multi_value": false,
31      "company_id": "1",
32      "invalid_value_errors": [],
33      "has_invalid_values": false,
34      "value": [
35        "66138964e7202ce6d4544d2c"
36      ]
37    },
38    {
39      "id": "6613dd2438506758ac6c53cb",
40      "namespace": "custom",
41      "slug": "kafka-def-product",
42      "resource": "product-size",
43      "resource_slug": "7643471",
44      "type": "float_type",
45      "multi_value": false,
46      "company_id": "1",
47      "invalid_value_errors": [],
48      "has_invalid_values": false,
49      "value": [
50        1.2356
51      ]
52    },
53    {
54      "id": "6613dd2438506758ac6c53cc",
55      "namespace": "custom",
56      "slug": "kafka-pro-def",
57      "resource": "product-size",
58      "resource_slug": "7643471",
59      "type": "string_single_line",
60      "multi_value": false,
61      "company_id": "1",
62      "invalid_value_errors": [],
63      "has_invalid_values": false,
64      "value": [
65        "pro input value"
66      ]
67    },
68    {
69      "id": "6613dd2438506758ac6c53cd",
70      "namespace": "custom",
71      "slug": "slt",
72      "resource": "product-size",
73      "resource_slug": "7643471",
74      "type": "string_single_line",
75      "multi_value": false,
76      "company_id": "1",
77      "invalid_value_errors": [],
78      "has_invalid_values": false,
79      "value": [
80        "SLT pro"
81      ]
82    },
83    {
84      "id": "6613dd2438506758ac6c53ce",
85      "namespace": "custom",
86      "slug": "url",
87      "resource": "product-size",
88      "resource_slug": "7643471",
89      "type": "url",
90      "multi_value": false,
91      "company_id": "1",
92      "invalid_value_errors": [],
93      "has_invalid_values": false,
94      "value": [
95        "https://dev.azure.com/GoFynd/FyndPlatformCore/_testPlans/execute?planId=603&suiteId=50419"
96      ]
97    }
98  ]
99}

Customfields/customfields/product-size-delete/v1

This event is triggered when a custom field from product size is deleted

Payload

Properties

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

array of Undefined Type

Required

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "Company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "Category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "Event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "Internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "array",
68      "items": [
69        {
70          "type": "object",
71          "properties": {
72            "id": {
73              "type": "string",
74              "description": "Uniquely generated mongoId of custom field and its not editable."
75            },
76            "namespace": {
77              "type": "string",
78              "description": "Namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
79            },
80            "slug": {
81              "type": "string",
82              "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
83            },
84            "resource": {
85              "type": "string",
86              "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
87            },
88            "resource_slug": {
89              "type": "string",
90              "description": "This indicate the resource id where this custom field value is assosiated."
91            },
92            "type": {
93              "type": "string",
94              "description": "This is field_type of the custom field definition. Its non-editable",
95              "enum": [
96                "string_single_line",
97                "string_multi_line",
98                "dropdown",
99                "integer",
100                "float_type",
101                "boolean_type",
102                "date",
103                "datetime",
104                "duration",
105                "json",
106                "file",
107                "url",
108                "html",
109                "metaobject",
110                "product",
111                "blog",
112                "page",
113                "order",
114                "collection"
115              ]
116            },
117            "multi_value": {
118              "type": "boolean",
119              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
120            },
121            "company_id": {
122              "type": "string",
123              "description": "This is company id where this custom fields created."
124            },
125            "value": {
126              "type": "array",
127              "items": {
128                "type": [
129                  "string",
130                  "number",
131                  "object",
132                  "boolean"
133                ]
134              },
135              "description": "This is array of values of custom fields. if multi value false then it has only single value in array. and in case of json this is json object."
136            }
137          },
138          "required": [
139            "id",
140            "namespace",
141            "slug",
142            "resource",
143            "resource_slug",
144            "type",
145            "multi_value",
146            "company_id",
147            "value"
148          ]
149        }
150      ]
151    }
152  }
153}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.455949e3-aeae-4961-8660-857927b6c355"
5    ],
6    "name": "customfields",
7    "type": "product-size-delete",
8    "version": "1",
9    "created_timestamp": 1712572109757,
10    "id": "mLoBXO+HoSLffGUFuO6DEFVNiRMA2/UTmY+GM3TPt9c=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26778,
15  "contains": [],
16  "payload": []
17}

Customfields/customfields/selling-location-update/v1

This event is triggered when a custom field from selling location is updated

Payload

Properties

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

array of Undefined Type

Required

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "Company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "Category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "Event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "Internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "array",
68      "items": [
69        {
70          "type": "object",
71          "properties": {
72            "id": {
73              "type": "string",
74              "description": "Uniquely generated mongoId of custom field and its not editable."
75            },
76            "namespace": {
77              "type": "string",
78              "description": "Namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
79            },
80            "slug": {
81              "type": "string",
82              "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
83            },
84            "resource": {
85              "type": "string",
86              "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
87            },
88            "resource_slug": {
89              "type": "string",
90              "description": "This indicate the resource id where this custom field value is assosiated."
91            },
92            "type": {
93              "type": "string",
94              "description": "This is field_type of the custom field definition. Its non-editable",
95              "enum": [
96                "string_single_line",
97                "string_multi_line",
98                "dropdown",
99                "integer",
100                "float_type",
101                "boolean_type",
102                "date",
103                "datetime",
104                "duration",
105                "json",
106                "file",
107                "url",
108                "html",
109                "metaobject",
110                "product",
111                "blog",
112                "page",
113                "order",
114                "collection"
115              ]
116            },
117            "multi_value": {
118              "type": "boolean",
119              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
120            },
121            "company_id": {
122              "type": "string",
123              "description": "This is company id where this custom fields created."
124            },
125            "value": {
126              "type": "array",
127              "items": {
128                "type": [
129                  "string",
130                  "number",
131                  "object",
132                  "boolean"
133                ]
134              },
135              "description": "This is array of values of custom fields. if multi value false then it has only single value in array. and in case of json this is json object."
136            }
137          },
138          "required": [
139            "id",
140            "namespace",
141            "slug",
142            "resource",
143            "resource_slug",
144            "type",
145            "multi_value",
146            "company_id",
147            "value"
148          ]
149        }
150      ]
151    }
152  }
153}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.24f67c49-d700-494c-9c42-64750bd8d22b"
5    ],
6    "name": "customfields",
7    "type": "selling-location-update",
8    "version": "1",
9    "created_timestamp": 1715059049046,
10    "id": "8JXCa9H19KRSaPChT9opbnGLtG2ZGhND6oIA7wcmq78=",
11    "category": "company",
12    "referer": "sit.fyndx1.de"
13  },
14  "company_id": 1,
15  "contains": [
16    "0"
17  ],
18  "payload": [
19    {
20      "id": "6639b969e1e66b3239ffab39",
21      "namespace": "custom",
22      "key": "mlt-01",
23      "resource": "store",
24      "resource_slug": "1",
25      "type": "string_multi_line",
26      "multi_value": false,
27      "company_id": "1",
28      "invalid_value_errors": [],
29      "has_invalid_values": false,
30      "value": [
31        "7 May"
32      ]
33    }
34  ]
35}

« customfield_definition/create/v1

customobject_definition/create/v1 »