Company

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

Customobjects

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

Events

company/customobjects/create/v1

# This event is triggered when a custom object is created

company/customobjects/update/v1

# This event is triggered when a custom object is updated

company/customobjects/delete/v1

# This event is triggered when a custom object is deleted

Customobjects/customobjects/create/v1

This event is triggered when a custom object is created

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

object

Required

Properties

string

Required

Uniquely generated mongoId of custom object and its not editable.

company_id

string

Required

This is company id where this custom object created.

status

string

This is use for active/inactive status of custom object entry

slug

string

Required

This is a unique identifier for a custom object under a custom object definition

definition_slug

string

Required

A unique identifier for the custom object definition. Its required and will not be modified once created.

fields

array of Undefined Type

Required

This is list of custom fields values.

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": "object",
68      "properties": {
69        "id": {
70          "type": "string",
71          "description": "Uniquely generated mongoId of custom object and its not editable."
72        },
73        "company_id": {
74          "type": "string",
75          "description": "This is company id where this custom object created."
76        },
77        "status": {
78          "type": "string",
79          "description": "This is use for active/inactive status of custom object entry"
80        },
81        "slug": {
82          "type": "string",
83          "description": "This is a unique identifier for a custom object under a custom object definition"
84        },
85        "definition_slug": {
86          "type": "string",
87          "description": "A unique identifier for the custom object definition. Its required and will not be modified once created."
88        },
89        "fields": {
90          "type": "array",
91          "description": "This is list of custom fields values.",
92          "items": [
93            {
94              "type": "object",
95              "properties": {
96                "id": {
97                  "type": "string",
98                  "description": "Uniquely generated mongoId of custom field entry and its not editable."
99                },
100                "namespace": {
101                  "type": "string",
102                  "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."
103                },
104                "slug": {
105                  "type": "string",
106                  "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
107                },
108                "resource": {
109                  "type": "string",
110                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
111                },
112                "type": {
113                  "type": "string",
114                  "description": "This is field_type of the custom field definition. Its non-editable"
115                },
116                "multi_value": {
117                  "type": "boolean",
118                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
119                },
120                "company_id": {
121                  "type": "string",
122                  "description": "This is company id where this custom fields created."
123                },
124                "metaobject_definition_id": {
125                  "type": "string",
126                  "description": "This indicates the current custom field is associated with which custom object"
127                },
128                "value": {
129                  "type": "array",
130                  "items": {
131                    "type": [
132                      "string",
133                      "number",
134                      "object",
135                      "boolean"
136                    ]
137                  },
138                  "description": "This tells the values against the custom definition"
139                }
140              },
141              "required": [
142                "slug",
143                "type",
144                "value"
145              ]
146            }
147          ]
148        }
149      },
150      "required": [
151        "id",
152        "company_id",
153        "slug",
154        "definition_slug",
155        "fields"
156      ]
157    }
158  }
159}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.3a324961-84f6-4c63-b929-e550837e0a7e"
5    ],
6    "name": "customobjects",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711112937649,
10    "id": "gOkWjc1vYD0p0wgOpgxc3oMUcspHw7cPrvJu/8c7A4M=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "contains": [
16    "id",
17    "company_id",
18    "status",
19    "slug",
20    "definition_slug",
21    "display_name",
22    "fields"
23  ],
24  "payload": {
25    "id": "65fd82e99074516f7d7d9786",
26    "company_id": "1",
27    "status": "active",
28    "slug": "65fd82e99074516f7d7d9786",
29    "type": "test",
30    "display_name": "SLT 0001",
31    "fields": [
32      {
33        "id": "65fd82e99074516f7d7d978a",
34        "namespace": "test",
35        "slug": "mlt",
36        "type": "string_multi_line",
37        "multi_value": false,
38        "company_id": "1",
39        "invalid_value_errors": [],
40        "has_invalid_values": false,
41        "value": [
42          "qswadsf\nwadesf\nqsswade\nawdesrfg"
43        ]
44      },
45      {
46        "id": "65fd82e99074516f7d7d978b",
47        "namespace": "test",
48        "slug": "slt",
49        "type": "string_single_line",
50        "multi_value": false,
51        "company_id": "1",
52        "invalid_value_errors": [],
53        "has_invalid_values": false,
54        "value": [
55          "SLT 0001"
56        ]
57      }
58    ]
59  }
60}

Customobjects/customobjects/update/v1

This event is triggered when a custom object 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

object

Required

Properties

string

Required

Uniquely generated mongoId of custom object and its not editable.

company_id

string

Required

This is company id where this custom object created.

status

string

This is use for active/inactive status of custom object entry

slug

string

Required

This is a unique identifier for a custom object

definition_slug

string

Required

Unique identifier for the custom object definition. Its required and will not be modified once created.

fields

array of Undefined Type

Required

This is list of custom fields values.

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": "object",
68      "properties": {
69        "id": {
70          "type": "string",
71          "description": "Uniquely generated mongoId of custom object and its not editable."
72        },
73        "company_id": {
74          "type": "string",
75          "description": "This is company id where this custom object created."
76        },
77        "status": {
78          "type": "string",
79          "description": "This is use for active/inactive status of custom object entry"
80        },
81        "slug": {
82          "type": "string",
83          "description": "This is a unique identifier for a custom object"
84        },
85        "definition_slug": {
86          "type": "string",
87          "description": "Unique identifier for the custom object definition. Its required and will not be modified once created."
88        },
89        "fields": {
90          "type": "array",
91          "description": "This is list of custom fields values.",
92          "items": [
93            {
94              "type": "object",
95              "properties": {
96                "id": {
97                  "type": "string",
98                  "description": "Uniquely generated mongoId of custom field entry and its not editable."
99                },
100                "namespace": {
101                  "type": "string",
102                  "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."
103                },
104                "slug": {
105                  "type": "string",
106                  "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
107                },
108                "type": {
109                  "type": "string",
110                  "description": "This is field_type of the custom field definition. Its non-editable"
111                },
112                "multi_value": {
113                  "type": "boolean",
114                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
115                },
116                "company_id": {
117                  "type": "string",
118                  "description": "This is company id where this custom fields created."
119                },
120                "value": {
121                  "type": "array",
122                  "items": {
123                    "type": [
124                      "string",
125                      "number",
126                      "object",
127                      "boolean"
128                    ]
129                  },
130                  "description": "This tells the values against the custom definition"
131                }
132              },
133              "required": [
134                "slug",
135                "type",
136                "value"
137              ]
138            }
139          ]
140        }
141      },
142      "required": [
143        "id",
144        "company_id",
145        "slug",
146        "definition_slug",
147        "fields"
148      ]
149    }
150  }
151}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.3a79c376-1144-4ca7-a310-79afd0bf3b0d"
5    ],
6    "name": "customobjects",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1708683294673,
10    "id": "gkr95+EzbC3D/TrRVe7T/iVI5olpUBRXLy05Obm22vU=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "contains": [
16    "id",
17    "definition_slug",
18    "company_id",
19    "status",
20    "type",
21    "display_name",
22    "fields"
23  ],
24  "payload": {
25    "id": "65d74aa58f97e6c1942f6ff9",
26    "definition_slug": "65d7471e0664a7dbc45a5292",
27    "company_id": "1",
28    "status": "active",
29    "type": "algolia",
30    "display_name": "kuldeep test",
31    "fields": [
32      {
33        "id": "65d74aa58f97e6c1942f6fff",
34        "namespace": "algolia",
35        "slug": "name",
36        "resource": "metaobject",
37        "resource_id": "65d74aa58f97e6c1942f6ff9",
38        "type": "string_single_line",
39        "multi_value": false,
40        "company_id": "1",
41        "invalid_value_errors": [],
42        "has_invalid_values": false,
43        "value": [
44          "kuldeep test"
45        ]
46      },
47      {
48        "id": "65d74aa58f97e6c1942f6ffe",
49        "namespace": "algolia",
50        "slug": "distance",
51        "resource": "metaobject",
52        "resource_id": "65d74aa58f97e6c1942f6ff9",
53        "type": "integer",
54        "multi_value": false,
55        "company_id": "1",
56        "invalid_value_errors": [],
57        "has_invalid_values": false,
58        "value": [
59          12
60        ]
61      },
62      {
63        "id": "65d74aa58f97e6c1942f7000",
64        "namespace": "algolia",
65        "slug": "productid",
66        "resource": "metaobject",
67        "resource_id": "65d74aa58f97e6c1942f6ff9",
68        "type": "integer",
69        "multi_value": false,
70        "company_id": "1",
71        "invalid_value_errors": [],
72        "has_invalid_values": false,
73        "value": [
74          432
75        ]
76      },
77      {
78        "id": "65d74aa58f97e6c1942f6ffd",
79        "namespace": "algolia",
80        "slug": "discount",
81        "resource": "metaobject",
82        "resource_id": "65d74aa58f97e6c1942f6ff9",
83        "type": "string_single_line",
84        "multi_value": false,
85        "company_id": "1",
86        "invalid_value_errors": [],
87        "has_invalid_values": false,
88        "value": [
89          "test"
90        ]
91      },
92      {
93        "id": "65d74aa58f97e6c1942f7001",
94        "namespace": "algolia",
95        "slug": "sizes",
96        "resource": "metaobject",
97        "resource_id": "65d74aa58f97e6c1942f6ff9",
98        "type": "string_single_line",
99        "multi_value": false,
100        "company_id": "1",
101        "invalid_value_errors": [],
102        "has_invalid_values": false,
103        "value": [
104          "test"
105        ]
106      }
107    ]
108  }
109}

Customobjects/customobjects/delete/v1

This event is triggered when a custom object 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

object

Required

Properties

string

Required

Uniquely generated mongoId of custom object and its not editable.

company_id

string

Required

This is company id where this custom object created.

status

string

This is use for active/inactive status of custom object entry

slug

string

Required

This is a unique identifier for a custom object

definition_slug

string

Required

Unique identifier for the custom object definition. Its required and will not be modified once created.

fields

array of Undefined Type

Required

This is list of custom fields values.

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": "object",
68      "properties": {
69        "id": {
70          "type": "string",
71          "description": "Uniquely generated mongoId of custom object and its not editable."
72        },
73        "company_id": {
74          "type": "string",
75          "description": "This is company id where this custom object created."
76        },
77        "status": {
78          "type": "string",
79          "description": "This is use for active/inactive status of custom object entry"
80        },
81        "slug": {
82          "type": "string",
83          "description": "This is a unique identifier for a custom object"
84        },
85        "definition_slug": {
86          "type": "string",
87          "description": "Unique identifier for the custom object definition. Its required and will not be modified once created."
88        },
89        "fields": {
90          "type": "array",
91          "description": "This is list of custom fields values.",
92          "items": [
93            {
94              "type": "object",
95              "properties": {
96                "id": {
97                  "type": "string",
98                  "description": "Uniquely generated mongoId of custom field entry and its not editable."
99                },
100                "namespace": {
101                  "type": "string",
102                  "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."
103                },
104                "slug": {
105                  "type": "string",
106                  "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
107                },
108                "type": {
109                  "type": "string",
110                  "description": "This is field_type of the custom field definition. Its non-editable"
111                },
112                "multi_value": {
113                  "type": "boolean",
114                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
115                },
116                "company_id": {
117                  "type": "string",
118                  "description": "This is company id where this custom fields created."
119                },
120                "value": {
121                  "type": "array",
122                  "items": {
123                    "type": [
124                      "string",
125                      "number",
126                      "object",
127                      "boolean"
128                    ]
129                  },
130                  "description": "This tells the values against the custom definition"
131                }
132              },
133              "required": [
134                "slug",
135                "type",
136                "value"
137              ]
138            }
139          ]
140        }
141      },
142      "required": [
143        "id",
144        "company_id",
145        "slug",
146        "definition_slug",
147        "fields"
148      ]
149    }
150  }
151}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.3a79c376-1144-4ca7-a310-79afd0bf3b0d"
5    ],
6    "name": "customobjects",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1708683294673,
10    "id": "gkr95+EzbC3D/TrRVe7T/iVI5olpUBRXLy05Obm22vU=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "contains": [
16    "id",
17    "definition_slug",
18    "company_id",
19    "status",
20    "type",
21    "display_name",
22    "fields"
23  ],
24  "payload": {
25    "id": "65d74aa58f97e6c1942f6ff9",
26    "definition_slug": "65d7471e0664a7dbc45a5292",
27    "company_id": "1",
28    "status": "active",
29    "type": "algolia",
30    "display_name": "kuldeep test",
31    "fields": [
32      {
33        "id": "65d74aa58f97e6c1942f6fff",
34        "namespace": "algolia",
35        "slug": "name",
36        "resource": "metaobject",
37        "resource_id": "65d74aa58f97e6c1942f6ff9",
38        "type": "string_single_line",
39        "multi_value": false,
40        "company_id": "1",
41        "invalid_value_errors": [],
42        "has_invalid_values": false,
43        "value": [
44          "kuldeep test"
45        ]
46      },
47      {
48        "id": "65d74aa58f97e6c1942f6ffe",
49        "namespace": "algolia",
50        "slug": "distance",
51        "resource": "metaobject",
52        "resource_id": "65d74aa58f97e6c1942f6ff9",
53        "type": "integer",
54        "multi_value": false,
55        "company_id": "1",
56        "invalid_value_errors": [],
57        "has_invalid_values": false,
58        "value": [
59          12
60        ]
61      },
62      {
63        "id": "65d74aa58f97e6c1942f7000",
64        "namespace": "algolia",
65        "slug": "productid",
66        "resource": "metaobject",
67        "resource_id": "65d74aa58f97e6c1942f6ff9",
68        "type": "integer",
69        "multi_value": false,
70        "company_id": "1",
71        "invalid_value_errors": [],
72        "has_invalid_values": false,
73        "value": [
74          432
75        ]
76      },
77      {
78        "id": "65d74aa58f97e6c1942f6ffd",
79        "namespace": "algolia",
80        "slug": "discount",
81        "resource": "metaobject",
82        "resource_id": "65d74aa58f97e6c1942f6ff9",
83        "type": "string_single_line",
84        "multi_value": false,
85        "company_id": "1",
86        "invalid_value_errors": [],
87        "has_invalid_values": false,
88        "value": [
89          "test"
90        ]
91      },
92      {
93        "id": "65d74aa58f97e6c1942f7001",
94        "namespace": "algolia",
95        "slug": "sizes",
96        "resource": "metaobject",
97        "resource_id": "65d74aa58f97e6c1942f6ff9",
98        "type": "string_single_line",
99        "multi_value": false,
100        "company_id": "1",
101        "invalid_value_errors": [],
102        "has_invalid_values": false,
103        "value": [
104          "test"
105        ]
106      }
107    ]
108  }
109}

« customobject_definition/create/v1

location/create/v2 »