Webhooks
Overview
Webhook Configuration
Best Practices
Kafka
Amazon EventBridge
Amazon SQS
Google Pub/Sub
Temporal
Customfields
Customobjects
Article
Brand
Company
Courier Partner
Customfield Definition
Customfields
Customobject Definition
Customobjects
Location
Logistics Configuration
Product Size
Product
Support Ticket
Zone
Address
Article
Available Pages
Cart Price Adjustment
Cart
Collection
Configuration
Coupon
Courier Partner
Customer Credit Note Configuration
Customfield Definition
Customfields
Customobject Definition
Customobjects
Discount
Domain
Faq
Filter
Legal
Order
Payment
Product
Promotion
Promotion Usage
Refund
Return Config
Return Config Categories
Rule
Seo
Shipment
Sort
Tags
Theme
User
Category
Department
Extension Subscription
Extension
Add To Cart
Order Checkedout
Order Checkout
Order Complete
Product Listing
Product Search
Product View
Product Wishlist Add
Product Wishlist Remove
Remove From Cart
User Login
User Logout

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-delete/v1
# this event is triggered when customfields is inventory-deleted
company/customfields/inventory-update/v1
# this event is triggered when customfields is inventory-updated
company/customfields/product-delete/v1
# this event is triggered when customfields is product-deleted
company/customfields/product-update/v1
# this event is triggered when customfields is product-updated
company/customfields/selling-location-update/v1
# this event is triggered when customfields is selling-location-updated

company/customfields/inventory-delete/v1

this event is triggered when customfields is inventory-deleted

Payload
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
id
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            "key": {
81              "type": "string",
82              "description": "Key is a slug and its 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_id": {
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            },
96            "multi_value": {
97              "type": "boolean",
98              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
99            },
100            "company_id": {
101              "type": "string",
102              "description": "This is company id where this custom fields created."
103            },
104            "creator": {
105              "type": "string",
106              "description": "It is creator of the custom fields definition, possible values are - company, application"
107            },
108            "definition_id": {
109              "type": "string",
110              "description": "This indicates the definition id of the custom field"
111            },
112            "value": {
113              "type": "array",
114              "items": {},
115              "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."
116            },
117            "created_by": {
118              "type": "string",
119              "description": "User id who create this custom field vlaue."
120            }
121          },
122          "required": [
123            "_id",
124            "namespace",
125            "key",
126            "resource",
127            "resource_id",
128            "type",
129            "multi_value",
130            "company_id",
131            "creator",
132            "definition_id",
133            "value"
134          ]
135        }
136      ]
137    }
138  }
139}
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}

company/customfields/inventory-update/v1

this event is triggered when customfields is inventory-updated

Payload
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
id
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            "key": {
81              "type": "string",
82              "description": "Key is a slug and its 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_id": {
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            },
96            "multi_value": {
97              "type": "boolean",
98              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
99            },
100            "company_id": {
101              "type": "string",
102              "description": "This is company id where this custom fields created."
103            },
104            "creator": {
105              "type": "string",
106              "description": "It is creator of the custom fields definition, possible values are - company, application"
107            },
108            "definition_id": {
109              "type": "string",
110              "description": "This indicates the definition id of the custom field"
111            },
112            "value": {
113              "type": "array",
114              "items": {},
115              "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."
116            },
117            "created_by": {
118              "type": "string",
119              "description": "User id who create this custom field vlaue."
120            }
121          },
122          "required": [
123            "_id",
124            "namespace",
125            "key",
126            "resource",
127            "resource_id",
128            "type",
129            "multi_value",
130            "company_id",
131            "creator",
132            "definition_id",
133            "value"
134          ]
135        }
136      ]
137    }
138  }
139}
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      "key": "testinventory",
23      "resource": "inventory",
24      "resource_id": "2002_SDCLOINSKDFV",
25      "type": "dropdown",
26      "multi_value": false,
27      "company_id": "123",
28      "creator": "company",
29      "invalid_value_errors": [],
30      "has_invalid_values": false,
31      "definition_id": "660bf80e0b27788daa92d0d3",
32      "value": [
33        "15"
34      ],
35      "created_by": "f770a7b6935b4464357a02c5"
36    }
37  ]
38}

company/customfields/product-delete/v1

this event is triggered when customfields is product-deleted

Payload
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
id
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            "key": {
81              "type": "string",
82              "description": "Key is a slug and its 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_id": {
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            },
96            "multi_value": {
97              "type": "boolean",
98              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
99            },
100            "company_id": {
101              "type": "string",
102              "description": "This is company id where this custom fields created."
103            },
104            "creator": {
105              "type": "string",
106              "description": "It is creator of the custom fields definition, possible values are - company, application"
107            },
108            "definition_id": {
109              "type": "string",
110              "description": "This indicates the definition id of the custom field"
111            },
112            "value": {
113              "type": "array",
114              "items": {},
115              "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."
116            },
117            "created_by": {
118              "type": "string",
119              "description": "User id who create this custom field vlaue."
120            }
121          },
122          "required": [
123            "_id",
124            "namespace",
125            "key",
126            "resource",
127            "resource_id",
128            "type",
129            "multi_value",
130            "company_id",
131            "creator",
132            "definition_id",
133            "value"
134          ]
135        }
136      ]
137    }
138  }
139}
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}

company/customfields/product-update/v1

this event is triggered when customfields is product-updated

Payload
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
id
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            "key": {
81              "type": "string",
82              "description": "Key is a slug and its 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_id": {
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            },
96            "multi_value": {
97              "type": "boolean",
98              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
99            },
100            "company_id": {
101              "type": "string",
102              "description": "This is company id where this custom fields created."
103            },
104            "creator": {
105              "type": "string",
106              "description": "It is creator of the custom fields definition, possible values are - company, application"
107            },
108            "definition_id": {
109              "type": "string",
110              "description": "This indicates the definition id of the custom field"
111            },
112            "value": {
113              "type": "array",
114              "items": {},
115              "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."
116            },
117            "created_by": {
118              "type": "string",
119              "description": "User id who create this custom field vlaue."
120            }
121          },
122          "required": [
123            "_id",
124            "namespace",
125            "key",
126            "resource",
127            "resource_id",
128            "type",
129            "multi_value",
130            "company_id",
131            "creator",
132            "definition_id",
133            "value"
134          ]
135        }
136      ]
137    }
138  }
139}
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      "key": "object-value",
27      "resource": "product",
28      "resource_id": "7643471",
29      "type": "metaobject",
30      "multi_value": false,
31      "company_id": "1",
32      "creator": "company",
33      "invalid_value_errors": [],
34      "has_invalid_values": false,
35      "definition_id": "66138e32e7202ce6d4544e4b",
36      "value": [
37        "66138964e7202ce6d4544d2c"
38      ],
39      "created_by": "aed592c2bc3ce375acef87db"
40    },
41    {
42      "_id": "6613dd2438506758ac6c53cb",
43      "namespace": "custom",
44      "key": "kafka-def-product",
45      "resource": "product",
46      "resource_id": "7643471",
47      "type": "float_type",
48      "multi_value": false,
49      "company_id": "1",
50      "creator": "company",
51      "invalid_value_errors": [],
52      "has_invalid_values": false,
53      "definition_id": "660f9095de80496a4c003264",
54      "value": [
55        1.2356
56      ],
57      "created_by": "aed592c2bc3ce375acef87db"
58    },
59    {
60      "_id": "6613dd2438506758ac6c53cc",
61      "namespace": "custom",
62      "key": "kafka-pro-def",
63      "resource": "product",
64      "resource_id": "7643471",
65      "type": "string_single_line",
66      "multi_value": false,
67      "company_id": "1",
68      "creator": "company",
69      "invalid_value_errors": [],
70      "has_invalid_values": false,
71      "definition_id": "660f8c6ade80496a4c003253",
72      "value": [
73        "pro input value"
74      ],
75      "created_by": "aed592c2bc3ce375acef87db"
76    },
77    {
78      "_id": "6613dd2438506758ac6c53cd",
79      "namespace": "custom",
80      "key": "slt",
81      "resource": "product",
82      "resource_id": "7643471",
83      "type": "string_single_line",
84      "multi_value": false,
85      "company_id": "1",
86      "creator": "company",
87      "invalid_value_errors": [],
88      "has_invalid_values": false,
89      "definition_id": "660e6d88d820c17d21f18113",
90      "value": [
91        "SLT pro"
92      ],
93      "created_by": "aed592c2bc3ce375acef87db"
94    },
95    {
96      "_id": "6613dd2438506758ac6c53ce",
97      "namespace": "custom",
98      "key": "url",
99      "resource": "product",
100      "resource_id": "7643471",
101      "type": "url",
102      "multi_value": false,
103      "company_id": "1",
104      "creator": "company",
105      "invalid_value_errors": [],
106      "has_invalid_values": false,
107      "definition_id": "660e6d57d820c17d21f180ce",
108      "value": [
109        "https://dev.azure.com/GoFynd/FyndPlatformCore/_testPlans/execute?planId=603&suiteId=50419"
110      ],
111      "created_by": "aed592c2bc3ce375acef87db"
112    }
113  ]
114}

company/customfields/selling-location-update/v1

this event is triggered when customfields is selling-location-updated

Payload
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
id
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          "required": [
72            "_id",
73            "namespace",
74            "key",
75            "resource",
76            "resource_id",
77            "type",
78            "multi_value",
79            "company_id",
80            "creator",
81            "definition_id",
82            "value"
83          ],
84          "properties": {
85            "_id": {
86              "type": "string",
87              "description": "Uniquely generated mongoId of custom field and its not editable."
88            },
89            "namespace": {
90              "type": "string",
91              "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."
92            },
93            "key": {
94              "type": "string",
95              "description": "Key is a slug and its unique identifier for the custom fields definition. Its required and will not be modified once created."
96            },
97            "resource": {
98              "type": "string",
99              "description": "Resource indicate that this custom field is assosiated with this resource.This is non editable"
100            },
101            "resource_id": {
102              "type": "string",
103              "description": "This indicate the resource id where this custom field value is assosiated."
104            },
105            "type": {
106              "type": "string",
107              "description": "This is field_type of the custom field definition. Its non editable"
108            },
109            "multi_value": {
110              "type": "boolean",
111              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
112            },
113            "company_id": {
114              "type": "string",
115              "description": "This is company id where this custom fields created."
116            },
117            "creator": {
118              "type": "string",
119              "description": "It is creator of the custom fields definition, possible values are - company, application"
120            },
121            "definition_id": {
122              "type": "string",
123              "description": "This indicates the definition id of the custom field"
124            },
125            "value": {
126              "type": "array",
127              "items": {},
128              "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."
129            },
130            "created_by": {
131              "type": "string",
132              "description": "User id who create this custom field vlaue."
133            }
134          }
135        }
136      ]
137    }
138  }
139}
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_id": "1",
25      "type": "string_multi_line",
26      "multi_value": false,
27      "company_id": "1",
28      "creator": "company",
29      "invalid_value_errors": [],
30      "has_invalid_values": false,
31      "definition_id": "6618e06beab82f52cdc4bf11",
32      "value": [
33        "7 May"
34      ],
35      "created_by": "bb94c5b2b470a4e4ddad0c5a"
36    }
37  ]
38}

Customobjects

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

Events
company/customobjects/create/v1
# this event is triggered when customobjects is created
company/customobjects/update/v1
# this event is triggered when customobjects is updated

company/customobjects/create/v1

this event is triggered when customobjects is created

Payload
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
id
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
id
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        "creator": {
74          "type": "string",
75          "description": "It is creator of the custom object definition, possible values are - company, application"
76        },
77        "company_id": {
78          "type": "string",
79          "description": "This is company id where this custom object created."
80        },
81        "created_by": {
82          "type": "string",
83          "description": "The user who created this entry"
84        },
85        "updated_by": {
86          "type": "string",
87          "description": "The user who last updated this entry"
88        },
89        "status": {
90          "type": "string",
91          "description": "This is use for active/inactive status of custom object entry"
92        },
93        "type": {
94          "type": "string",
95          "description": "Type is a slug and its unique identifier for the custom object definition. Its required and will not be modified once created."
96        },
97        "display_name": {
98          "type": "string",
99          "description": "Display name is the disaply text for the custom object entry"
100        },
101        "definition_id": {
102          "type": "string",
103          "description": "This is definition id of custom object definition against this entry."
104        },
105        "fields": {
106          "type": "array",
107          "description": "This is list of custom fields values.",
108          "items": [
109            {
110              "type": "object",
111              "properties": {
112                "_id": {
113                  "type": "string",
114                  "description": "Uniquely generated mongoId of custom field entry and its not editable."
115                },
116                "namespace": {
117                  "type": "string",
118                  "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."
119                },
120                "key": {
121                  "type": "string",
122                  "description": "Key is a slug and its unique identifier for the custom fields definition. Its required and will not be modified once created."
123                },
124                "resource": {
125                  "type": "string",
126                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non editable"
127                },
128                "resource_id": {
129                  "type": "string",
130                  "description": "This indicates the id of the resource"
131                },
132                "type": {
133                  "type": "string",
134                  "description": "This is field_type of the custom field definition. Its non editable"
135                },
136                "multi_value": {
137                  "type": "boolean",
138                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
139                },
140                "company_id": {
141                  "type": "string",
142                  "description": "This is company id where this custom fields created."
143                },
144                "creator": {
145                  "type": "string",
146                  "description": "It is creator of the custom fields definition, possible values are - company, application"
147                },
148                "metaobject_definition_id": {
149                  "type": "string",
150                  "description": "This indicates the current custom field is associated with which custom object"
151                },
152                "definition_id": {
153                  "type": "string",
154                  "description": "Uniquely generated mongoId of custom field and its not editable."
155                },
156                "value": {
157                  "type": "array",
158                  "items": {},
159                  "description": "This tells the values against the custom definition"
160                }
161              },
162              "required": [
163                "_id",
164                "namespace",
165                "key",
166                "resource",
167                "resource_id",
168                "type",
169                "multi_value",
170                "company_id",
171                "creator",
172                "metaobject_definition_id",
173                "definition_id",
174                "value"
175              ]
176            }
177          ]
178        }
179      },
180      "required": [
181        "_id",
182        "creator",
183        "company_id",
184        "created_by",
185        "updated_by",
186        "status",
187        "type",
188        "display_name",
189        "definition_id",
190        "fields"
191      ]
192    }
193  }
194}
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    "creator",
18    "company_id",
19    "created_by",
20    "updated_by",
21    "status",
22    "slug",
23    "type",
24    "display_name",
25    "definition_id",
26    "fields"
27  ],
28  "payload": {
29    "_id": "65fd82e99074516f7d7d9786",
30    "creator": "company",
31    "company_id": "1",
32    "created_by": "aed592c2bc3ce375acef87db",
33    "updated_by": "aed592c2bc3ce375acef87db",
34    "status": "active",
35    "slug": "65fd82e99074516f7d7d9786",
36    "type": "test",
37    "display_name": "SLT 0001",
38    "definition_id": "65fd8293ad5e1cf3e82d55fb",
39    "fields": [
40      {
41        "_id": "65fd82e99074516f7d7d978a",
42        "namespace": "test",
43        "key": "mlt",
44        "resource": "metaobject",
45        "resource_id": "65fd82e99074516f7d7d9786",
46        "type": "string_multi_line",
47        "multi_value": false,
48        "company_id": "1",
49        "creator": "company",
50        "invalid_value_errors": [],
51        "has_invalid_values": false,
52        "metaobject_definition_id": "65fd8293ad5e1cf3e82d55fb",
53        "definition_id": "65fd8293ad5e1cf3e82d55ff",
54        "value": [
55          "qswadsf\nwadesf\nqsswade\nawdesrfg"
56        ],
57        "created_by": "aed592c2bc3ce375acef87db"
58      },
59      {
60        "_id": "65fd82e99074516f7d7d978b",
61        "namespace": "test",
62        "key": "slt",
63        "resource": "metaobject",
64        "resource_id": "65fd82e99074516f7d7d9786",
65        "type": "string_single_line",
66        "multi_value": false,
67        "company_id": "1",
68        "creator": "company",
69        "invalid_value_errors": [],
70        "has_invalid_values": false,
71        "metaobject_definition_id": "65fd8293ad5e1cf3e82d55fb",
72        "definition_id": "65fd8293ad5e1cf3e82d55fe",
73        "value": [
74          "SLT 0001"
75        ],
76        "created_by": "aed592c2bc3ce375acef87db"
77      }
78    ]
79  }
80}

company/customobjects/update/v1

this event is triggered when customobjects is updated

Payload
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
id
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
id
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        "creator": {
74          "type": "string",
75          "description": "It is creator of the custom object definition, possible values are - company, application"
76        },
77        "company_id": {
78          "type": "string",
79          "description": "This is company id where this custom object created."
80        },
81        "created_by": {
82          "type": "string",
83          "description": "The user who created this entry"
84        },
85        "updated_by": {
86          "type": "string",
87          "description": "The user who last updated this entry"
88        },
89        "status": {
90          "type": "string",
91          "description": "This is use for active/inactive status of custom object entry"
92        },
93        "type": {
94          "type": "string",
95          "description": "Type is a slug and its unique identifier for the custom object definition. Its required and will not be modified once created."
96        },
97        "display_name": {
98          "type": "string",
99          "description": "Display name is the disaply text for the custom object entry"
100        },
101        "definition_id": {
102          "type": "string",
103          "description": "This is definition id of custom object definition against this entry."
104        },
105        "fields": {
106          "type": "array",
107          "description": "This is list of custom fields values.",
108          "items": [
109            {
110              "type": "object",
111              "properties": {
112                "_id": {
113                  "type": "string",
114                  "description": "Uniquely generated mongoId of custom field entry and its not editable."
115                },
116                "namespace": {
117                  "type": "string",
118                  "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."
119                },
120                "key": {
121                  "type": "string",
122                  "description": "Key is a slug and its unique identifier for the custom fields definition. Its required and will not be modified once created."
123                },
124                "resource": {
125                  "type": "string",
126                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non editable"
127                },
128                "resource_id": {
129                  "type": "string",
130                  "description": "This indicates the id of the resource"
131                },
132                "type": {
133                  "type": "string",
134                  "description": "This is field_type of the custom field definition. Its non editable"
135                },
136                "multi_value": {
137                  "type": "boolean",
138                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
139                },
140                "company_id": {
141                  "type": "string",
142                  "description": "This is company id where this custom fields created."
143                },
144                "creator": {
145                  "type": "string",
146                  "description": "It is creator of the custom fields definition, possible values are - company, application"
147                },
148                "metaobject_definition_id": {
149                  "type": "string",
150                  "description": "This indicates the current custom field is associated with which custom object"
151                },
152                "definition_id": {
153                  "type": "string",
154                  "description": "Uniquely generated mongoId of custom field and its not editable."
155                },
156                "value": {
157                  "type": "array",
158                  "items": {},
159                  "description": "This tells the values against the custom definition"
160                }
161              },
162              "required": [
163                "_id",
164                "namespace",
165                "key",
166                "resource",
167                "resource_id",
168                "type",
169                "multi_value",
170                "company_id",
171                "creator",
172                "metaobject_definition_id",
173                "definition_id",
174                "value"
175              ]
176            }
177          ]
178        }
179      },
180      "required": [
181        "_id",
182        "creator",
183        "company_id",
184        "created_by",
185        "updated_by",
186        "status",
187        "type",
188        "display_name",
189        "definition_id",
190        "fields"
191      ]
192    }
193  }
194}
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_id",
18    "creator",
19    "company_id",
20    "status",
21    "type",
22    "created_by",
23    "updated_by",
24    "is_deleted",
25    "created_at",
26    "updated_at",
27    "display_name",
28    "fields"
29  ],
30  "payload": {
31    "_id": "65d74aa58f97e6c1942f6ff9",
32    "definition_id": "65d7471e0664a7dbc45a5292",
33    "creator": "company",
34    "company_id": "1",
35    "status": "active",
36    "type": "algolia",
37    "created_by": "9759643b65ebc6bacb5275f5",
38    "updated_by": "9759643b65ebc6bacb5275f5",
39    "is_deleted": false,
40    "created_at": "2024-02-22T13:22:45.442Z",
41    "updated_at": "2024-02-23T10:14:54.665Z",
42    "display_name": "kuldeep test",
43    "fields": [
44      {
45        "_id": "65d74aa58f97e6c1942f6fff",
46        "updated_by": "9759643b65ebc6bacb5275f5",
47        "namespace": "algolia",
48        "key": "name",
49        "resource": "metaobject",
50        "resource_id": "65d74aa58f97e6c1942f6ff9",
51        "type": "string_single_line",
52        "multi_value": false,
53        "company_id": "1",
54        "creator": "company",
55        "invalid_value_errors": [],
56        "has_invalid_values": false,
57        "metaobject_definition_id": "65d7471e0664a7dbc45a5292",
58        "definition_id": "65d7471e0664a7dbc45a5296",
59        "value": [
60          "kuldeep test"
61        ]
62      },
63      {
64        "_id": "65d74aa58f97e6c1942f6ffe",
65        "updated_by": "9759643b65ebc6bacb5275f5",
66        "namespace": "algolia",
67        "key": "distance",
68        "resource": "metaobject",
69        "resource_id": "65d74aa58f97e6c1942f6ff9",
70        "type": "integer",
71        "multi_value": false,
72        "company_id": "1",
73        "creator": "company",
74        "invalid_value_errors": [],
75        "has_invalid_values": false,
76        "metaobject_definition_id": "65d7471e0664a7dbc45a5292",
77        "definition_id": "65d74a080664a7dbc45a52be",
78        "value": [
79          12
80        ]
81      },
82      {
83        "_id": "65d74aa58f97e6c1942f7000",
84        "updated_by": "9759643b65ebc6bacb5275f5",
85        "namespace": "algolia",
86        "key": "productid",
87        "resource": "metaobject",
88        "resource_id": "65d74aa58f97e6c1942f6ff9",
89        "type": "integer",
90        "multi_value": false,
91        "company_id": "1",
92        "creator": "company",
93        "invalid_value_errors": [],
94        "has_invalid_values": false,
95        "metaobject_definition_id": "65d7471e0664a7dbc45a5292",
96        "definition_id": "65d7471e0664a7dbc45a5295",
97        "value": [
98          432
99        ]
100      },
101      {
102        "_id": "65d74aa58f97e6c1942f6ffd",
103        "updated_by": "9759643b65ebc6bacb5275f5",
104        "namespace": "algolia",
105        "key": "discount",
106        "resource": "metaobject",
107        "resource_id": "65d74aa58f97e6c1942f6ff9",
108        "type": "string_single_line",
109        "multi_value": false,
110        "company_id": "1",
111        "creator": "company",
112        "invalid_value_errors": [],
113        "has_invalid_values": false,
114        "metaobject_definition_id": "65d7471e0664a7dbc45a5292",
115        "definition_id": "65d7471e0664a7dbc45a5298",
116        "value": [
117          "test"
118        ]
119      },
120      {
121        "_id": "65d74aa58f97e6c1942f7001",
122        "updated_by": "9759643b65ebc6bacb5275f5",
123        "namespace": "algolia",
124        "key": "sizes",
125        "resource": "metaobject",
126        "resource_id": "65d74aa58f97e6c1942f6ff9",
127        "type": "string_single_line",
128        "multi_value": false,
129        "company_id": "1",
130        "creator": "company",
131        "invalid_value_errors": [],
132        "has_invalid_values": false,
133        "metaobject_definition_id": "65d7471e0664a7dbc45a5292",
134        "definition_id": "65d7471e0664a7dbc45a5297",
135        "value": [
136          "test"
137        ]
138      }
139    ]
140  }
141}

Article

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

Events
company/article/create/v1
# this event is triggered when article is created
company/article/delete/v1
# this event is triggered when article is deleted
company/article/update/v1
# this event is triggered when article is updated

company/article/create/v1

this event is triggered when article is created

Payload
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
id
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
articles
array of object
Required
Array of Properties
id
string
Unique identifier for the article.
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
size
string
Required
Product size (e.g., S, M, L, XL).
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
price
object
Required
Pricing details of the product, including various price types.
Properties
marked
number
Required
Marked price or original listed price of the product.
currency
string
Required
Currency used for the product's pricing (e.g., USD, EUR).
transfer
number
Required
Transfer price of the product.
effective
number
Required
Final price after applying discounts.
updated_at
string
| date-time
Date and time when the pricing information was last updated.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
is_set
boolean
Indicates if the product is sold as part of a set.
weight
object
Required
Weight details of the product.
Properties
unit
string
Required
Unit of weight measurement (e.g., kg, lbs).
shipping
number
Required
Shipping weight of the product.
is_default
boolean
Indicates if this is the default weight configuration.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
item_id
integer
Required
Unique identifier for the item.
date_meta
object
Timestamps for important events in the product's lifecycle.
Properties
created_on
string
| date-time
Date and time when the product was first created.
modified_on
string
| date-time
Required
Last modification timestamp of the product inventory details.
added_on_store
string
| date-time
Date and time when the product was added to the store.
inventory_updated_on
string
| date-time
Last inventory update timestamp.
dimension
object
Required
Dimension details of the product.
Properties
unit
string
Required
Unit of dimension measurement (e.g., cm, inches).
width
number
Required
Width of the product.
height
number
Required
Height of the product.
length
number
Required
Length of the product.
is_default
boolean
Indicates if these are the default dimensions.
is_active
boolean
Indicates if the product is currently active (available for sale).
identifier
object
Required
Product-specific identifier details.
quantities
object
Information about product quantities, including available and unavailable stock.
Properties
damaged
object
Details of damaged stock.
Properties
count
integer
Required
Number of damaged units.
updated_at
string
Required
Timestamp of the last damaged stock update.
sellable
object
Required
Sellable stock information.
Properties
count
integer
Required
Number of sellable units available.
updated_at
string
Required
Timestamp of the last sellable stock update.
not_available
object
Information about unavailable stock.
Properties
count
integer
Required
Number of unavailable units.
updated_at
string
Required
Timestamp of the last unavailable stock update.
order_committed
object
Details of committed orders.
Properties
count
integer
Number of units committed to orders.
updated_at
string
Timestamp of the last order committed update.
_custom_json
object
Custom JSON data associated with the product.
trader
array of object
List of traders associated with the product.
Array of Properties
name
string
Trader's name.
type
string
Indicates the trader type.
Enum
address
array of string
List of addresses associated with the trader.
manufacturer
object
Required
Information about the product's manufacturer.
Properties
name
string
Required
Manufacturer's name.
address
string
Required
Manufacturer's physical address.
is_default
boolean
Indicates if this is the default manufacturer for the product.
return_config
object
Return policy configuration for the product.
Properties
unit
string
Time unit for the return period (either days or hours).
Enum
time
integer
Duration within which the product can be returned.
returnable
boolean
Required
Indicates if the product is returnable.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
tax_identifier
object
Tax-related identification for the product.
Properties
hsn_code_id
string
HSN (Harmonized System of Nomenclature) code identifier.
total_quantity
integer
Required
Total quantity available for the product.
expiration_date
string
Expiration or validity end date for the product.
track_inventory
boolean
Indicates if inventory tracking is enabled for the product.
country_of_origin
string
Required
Country where the product was manufactured or originated.
stage
string
Current stage of the product lifecycle (e.g., verified).
set
object
Configuration of the set, if the product is sold as one.
Properties
quantity
integer
Total number of items in the set.
size_distribution
object
Size distribution details within the set.
Properties
sizes
array of object
List of sizes and their respective quantities.
Array of Properties
size
string
Label of the size (e.g., S, M, L).
pieces
integer
Quantity of pieces for the corresponding size.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
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      "required": [
69        "articles"
70      ],
71      "properties": {
72        "articles": {
73          "type": "array",
74          "items": {
75            "type": "object",
76            "required": [
77              "uid",
78              "item_id",
79              "fynd_item_code",
80              "store",
81              "brand",
82              "company",
83              "size",
84              "identifier",
85              "seller_identifier",
86              "price",
87              "total_quantity",
88              "dimension",
89              "weight",
90              "manufacturer",
91              "country_of_origin"
92            ],
93            "properties": {
94              "id": {
95                "type": "string",
96                "description": "Unique identifier for the article."
97              },
98              "uid": {
99                "type": "string",
100                "description": "Combination of item code and store ID to uniquely identify the article."
101              },
102              "size": {
103                "type": "string",
104                "description": "Product size (e.g., S, M, L, XL)."
105              },
106              "brand": {
107                "type": "object",
108                "description": "Details about the product's brand.",
109                "properties": {
110                  "id": {
111                    "type": "integer",
112                    "description": "Unique identifier for the brand."
113                  }
114                },
115                "required": [
116                  "id"
117                ]
118              },
119              "price": {
120                "type": "object",
121                "description": "Pricing details of the product, including various price types.",
122                "properties": {
123                  "marked": {
124                    "type": "number",
125                    "description": "Marked price or original listed price of the product."
126                  },
127                  "currency": {
128                    "type": "string",
129                    "description": "Currency used for the product's pricing (e.g., USD, EUR)."
130                  },
131                  "transfer": {
132                    "type": "number",
133                    "description": "Transfer price of the product."
134                  },
135                  "effective": {
136                    "type": "number",
137                    "description": "Final price after applying discounts."
138                  },
139                  "updated_at": {
140                    "type": "string",
141                    "format": "date-time",
142                    "description": "Date and time when the pricing information was last updated."
143                  }
144                },
145                "required": [
146                  "transfer",
147                  "effective",
148                  "marked",
149                  "currency"
150                ]
151              },
152              "store": {
153                "type": "object",
154                "description": "Information about the store selling the product.",
155                "properties": {
156                  "id": {
157                    "type": "integer",
158                    "description": "Unique identifier for the store."
159                  }
160                },
161                "required": [
162                  "id"
163                ]
164              },
165              "is_set": {
166                "type": "boolean",
167                "description": "Indicates if the product is sold as part of a set."
168              },
169              "weight": {
170                "type": "object",
171                "description": "Weight details of the product.",
172                "properties": {
173                  "unit": {
174                    "type": "string",
175                    "description": "Unit of weight measurement (e.g., kg, lbs)."
176                  },
177                  "shipping": {
178                    "type": "number",
179                    "description": "Shipping weight of the product."
180                  },
181                  "is_default": {
182                    "type": "boolean",
183                    "description": "Indicates if this is the default weight configuration."
184                  }
185                },
186                "required": [
187                  "unit",
188                  "shipping"
189                ]
190              },
191              "company": {
192                "type": "object",
193                "description": "Information about the company producing or selling the product.",
194                "properties": {
195                  "id": {
196                    "type": "integer",
197                    "description": "Unique identifier for the company."
198                  }
199                },
200                "required": [
201                  "id"
202                ]
203              },
204              "item_id": {
205                "type": "integer",
206                "description": "Unique identifier for the item."
207              },
208              "date_meta": {
209                "type": "object",
210                "description": "Timestamps for important events in the product's lifecycle.",
211                "properties": {
212                  "created_on": {
213                    "type": "string",
214                    "format": "date-time",
215                    "description": "Date and time when the product was first created."
216                  },
217                  "modified_on": {
218                    "type": "string",
219                    "format": "date-time",
220                    "description": "Last modification timestamp of the product inventory details."
221                  },
222                  "added_on_store": {
223                    "type": "string",
224                    "format": "date-time",
225                    "description": "Date and time when the product was added to the store."
226                  },
227                  "inventory_updated_on": {
228                    "type": "string",
229                    "format": "date-time",
230                    "description": "Last inventory update timestamp."
231                  }
232                },
233                "required": [
234                  "modified_on"
235                ]
236              },
237              "dimension": {
238                "type": "object",
239                "description": "Dimension details of the product.",
240                "properties": {
241                  "unit": {
242                    "type": "string",
243                    "description": "Unit of dimension measurement (e.g., cm, inches)."
244                  },
245                  "width": {
246                    "type": "number",
247                    "description": "Width of the product."
248                  },
249                  "height": {
250                    "type": "number",
251                    "description": "Height of the product."
252                  },
253                  "length": {
254                    "type": "number",
255                    "description": "Length of the product."
256                  },
257                  "is_default": {
258                    "type": "boolean",
259                    "description": "Indicates if these are the default dimensions."
260                  }
261                },
262                "required": [
263                  "unit",
264                  "height",
265                  "width",
266                  "length"
267                ]
268              },
269              "is_active": {
270                "type": "boolean",
271                "description": "Indicates if the product is currently active (available for sale)."
272              },
273              "identifier": {
274                "type": "object",
275                "description": "Product-specific identifier details."
276              },
277              "quantities": {
278                "type": "object",
279                "description": "Information about product quantities, including available and unavailable stock.",
280                "properties": {
281                  "damaged": {
282                    "type": "object",
283                    "description": "Details of damaged stock.",
284                    "properties": {
285                      "count": {
286                        "type": "integer",
287                        "description": "Number of damaged units."
288                      },
289                      "updated_at": {
290                        "type": "string",
291                        "description": "Timestamp of the last damaged stock update."
292                      }
293                    },
294                    "required": [
295                      "count",
296                      "updated_at"
297                    ]
298                  },
299                  "sellable": {
300                    "type": "object",
301                    "description": "Sellable stock information.",
302                    "properties": {
303                      "count": {
304                        "type": "integer",
305                        "description": "Number of sellable units available."
306                      },
307                      "updated_at": {
308                        "type": "string",
309                        "description": "Timestamp of the last sellable stock update."
310                      }
311                    },
312                    "required": [
313                      "count",
314                      "updated_at"
315                    ]
316                  },
317                  "not_available": {
318                    "type": "object",
319                    "description": "Information about unavailable stock.",
320                    "properties": {
321                      "count": {
322                        "type": "integer",
323                        "description": "Number of unavailable units."
324                      },
325                      "updated_at": {
326                        "type": "string",
327                        "description": "Timestamp of the last unavailable stock update."
328                      }
329                    },
330                    "required": [
331                      "count",
332                      "updated_at"
333                    ]
334                  },
335                  "order_committed": {
336                    "type": "object",
337                    "description": "Details of committed orders.",
338                    "properties": {
339                      "count": {
340                        "type": "integer",
341                        "description": "Number of units committed to orders."
342                      },
343                      "updated_at": {
344                        "type": "string",
345                        "description": "Timestamp of the last order committed update."
346                      }
347                    }
348                  }
349                },
350                "required": [
351                  "sellable"
352                ]
353              },
354              "_custom_json": {
355                "type": "object",
356                "description": "Custom JSON data associated with the product."
357              },
358              "trader": {
359                "type": "array",
360                "description": "List of traders associated with the product.",
361                "items": {
362                  "type": "object",
363                  "properties": {
364                    "name": {
365                      "type": "string",
366                      "description": "Trader's name."
367                    },
368                    "type": {
369                      "type": "string",
370                      "enum": [
371                        "Manufacturer",
372                        "Importer",
373                        "Packer",
374                        "Marketer"
375                      ],
376                      "description": "Indicates the trader type."
377                    },
378                    "address": {
379                      "type": "array",
380                      "description": "List of addresses associated with the trader.",
381                      "items": {
382                        "type": "string"
383                      }
384                    }
385                  }
386                }
387              },
388              "manufacturer": {
389                "type": "object",
390                "description": "Information about the product's manufacturer.",
391                "properties": {
392                  "name": {
393                    "type": "string",
394                    "description": "Manufacturer's name."
395                  },
396                  "address": {
397                    "type": "string",
398                    "description": "Manufacturer's physical address."
399                  },
400                  "is_default": {
401                    "type": "boolean",
402                    "description": "Indicates if this is the default manufacturer for the product."
403                  }
404                },
405                "required": [
406                  "name",
407                  "address"
408                ]
409              },
410              "return_config": {
411                "type": "object",
412                "description": "Return policy configuration for the product.",
413                "properties": {
414                  "unit": {
415                    "type": "string",
416                    "enum": [
417                      "days",
418                      "hours"
419                    ],
420                    "description": "Time unit for the return period (either days or hours)."
421                  },
422                  "time": {
423                    "type": "integer",
424                    "description": "Duration within which the product can be returned."
425                  },
426                  "returnable": {
427                    "type": "boolean",
428                    "description": "Indicates if the product is returnable."
429                  }
430                },
431                "required": [
432                  "returnable"
433                ]
434              },
435              "fynd_item_code": {
436                "type": "string",
437                "description": "Fynd's unique internal code for the product."
438              },
439              "tax_identifier": {
440                "type": "object",
441                "description": "Tax-related identification for the product.",
442                "properties": {
443                  "hsn_code_id": {
444                    "type": "string",
445                    "description": "HSN (Harmonized System of Nomenclature) code identifier."
446                  }
447                }
448              },
449              "total_quantity": {
450                "type": "integer",
451                "description": "Total quantity available for the product."
452              },
453              "expiration_date": {
454                "type": "string",
455                "description": "Expiration or validity end date for the product."
456              },
457              "track_inventory": {
458                "type": "boolean",
459                "description": "Indicates if inventory tracking is enabled for the product."
460              },
461              "country_of_origin": {
462                "type": "string",
463                "description": "Country where the product was manufactured or originated."
464              },
465              "stage": {
466                "type": "string",
467                "description": "Current stage of the product lifecycle (e.g., verified)."
468              },
469              "set": {
470                "type": "object",
471                "description": "Configuration of the set, if the product is sold as one.",
472                "properties": {
473                  "quantity": {
474                    "type": "integer",
475                    "description": "Total number of items in the set."
476                  },
477                  "size_distribution": {
478                    "type": "object",
479                    "description": "Size distribution details within the set.",
480                    "properties": {
481                      "sizes": {
482                        "type": "array",
483                        "description": "List of sizes and their respective quantities.",
484                        "items": {
485                          "type": "object",
486                          "properties": {
487                            "size": {
488                              "type": "string",
489                              "description": "Label of the size (e.g., S, M, L)."
490                            },
491                            "pieces": {
492                              "type": "integer",
493                              "description": "Quantity of pieces for the corresponding size."
494                            }
495                          }
496                        }
497                      }
498                    }
499                  }
500                }
501              },
502              "seller_identifier": {
503                "type": "string",
504                "description": "Unique identifier used by the seller for the product."
505              }
506            }
507          }
508        }
509      }
510    }
511  }
512}
Payload Example
1{
2  "company_id": 3932,
3  "contains": [
4    "articles"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1712213140518,
9    "id": "uVxPGUEmbYi7/WCvNFfFY03tJiSTOqP6kgMZOxxmGrI=",
10    "name": "article",
11    "trace_id": [
12      "silverbolt.f3b55ffc-f24e-11ee-ad2e-c227286f4511"
13    ],
14    "type": "create",
15    "version": "1"
16  },
17  "payload": {
18    "articles": [
19      {
20        "_custom_json": {},
21        "brand": {
22          "id": 414
23        },
24        "company": {
25          "id": 3932
26        },
27        "country_of_origin": "India",
28        "date_meta": {
29          "added_on_store": "2024-04-04 06:45:40.083507+00:00",
30          "created_on": "2024-04-04 06:45:40.072820",
31          "inventory_updated_on": "2024-04-04 06:45:40.072820",
32          "modified_on": "2024-04-04 06:45:40.072820"
33        },
34        "dimension": {
35          "height": 5,
36          "length": 33,
37          "unit": "cm",
38          "width": 25
39        },
40        "expiration_date": "9998-01-30 23:59:00",
41        "fynd_item_code": "MFK-9332-Q-163-LIGHT BLUE",
42        "id": "",
43        "identifier": {
44          "ean": "8905310270582"
45        },
46        "is_active": true,
47        "is_set": false,
48        "item_id": 8684655,
49        "manufacturer": {
50          "address": "B-8, MIDC CENTRAL ROAD, MAROL, NEXT TO MIDC POLICE STATION, ANDHERI EAST, MUMBAI -400093, , Maharashtra, Mumbai",
51          "name": "Credo Brands Marketing Limited"
52        },
53        "price": {
54          "currency": "INR",
55          "effective": 2199,
56          "marked": 2199,
57          "transfer": 0
58        },
59        "quantities": {
60          "sellable": {
61            "count": 1,
62            "updated_at": "2024-04-04 06:45:40.072820"
63          }
64        },
65        "return_config": {
66          "returnable": true,
67          "time": 30,
68          "unit": "days"
69        },
70        "seller_identifier": "8905310270582",
71        "size": "L",
72        "stage": "verified",
73        "store": {
74          "id": 23630
75        },
76        "tags": [],
77        "tax_identifier": {
78          "hsn_code_id": "6277837c5e4c6fdbc8be3e93"
79        },
80        "total_quantity": 1,
81        "trace_id": "inventory.f366a506-f24e-11ee-ad2e-c227286f4511",
82        "track_inventory": true,
83        "uid": "23630_8905310270582",
84        "weight": {
85          "shipping": 250,
86          "unit": "gram"
87        }
88      }
89    ]
90  }
91}

company/article/delete/v1

this event is triggered when article is deleted

Payload
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
id
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
articles
array of object
Required
Array of Properties
id
string
Unique identifier for the article.
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
size
string
Required
Product size (e.g., S, M, L, XL).
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
price
object
Required
Pricing details of the product, including various price types.
Properties
marked
number
Required
Marked price or original listed price of the product.
currency
string
Required
Currency used for the product's pricing (e.g., USD, EUR).
transfer
number
Required
Transfer price of the product.
effective
number
Required
Final price after applying discounts.
updated_at
string
| date-time
Date and time when the pricing information was last updated.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
is_set
boolean
Indicates if the product is sold as part of a set.
weight
object
Required
Weight details of the product.
Properties
unit
string
Required
Unit of weight measurement (e.g., kg, lbs).
shipping
number
Required
Shipping weight of the product.
is_default
boolean
Indicates if this is the default weight configuration.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
item_id
integer
Required
Unique identifier for the item.
date_meta
object
Timestamps for important events in the product's lifecycle.
Properties
created_on
string
| date-time
Date and time when the product was first created.
modified_on
string
| date-time
Required
Last modification timestamp of the product inventory details.
added_on_store
string
| date-time
Date and time when the product was added to the store.
inventory_updated_on
string
| date-time
Last inventory update timestamp.
dimension
object
Required
Dimension details of the product.
Properties
unit
string
Required
Unit of dimension measurement (e.g., cm, inches).
width
number
Required
Width of the product.
height
number
Required
Height of the product.
length
number
Required
Length of the product.
is_default
boolean
Indicates if these are the default dimensions.
is_active
boolean
Indicates if the product is currently active (available for sale).
identifier
object
Required
Product-specific identifier details.
quantities
object
Information about product quantities, including available and unavailable stock.
Properties
damaged
object
Details of damaged stock.
Properties
count
integer
Required
Number of damaged units.
updated_at
string
Required
Timestamp of the last damaged stock update.
sellable
object
Required
Sellable stock information.
Properties
count
integer
Required
Number of sellable units available.
updated_at
string
Required
Timestamp of the last sellable stock update.
not_available
object
Information about unavailable stock.
Properties
count
integer
Required
Number of unavailable units.
updated_at
string
Required
Timestamp of the last unavailable stock update.
order_committed
object
Details of committed orders.
Properties
count
integer
Number of units committed to orders.
updated_at
string
Timestamp of the last order committed update.
_custom_json
object
Custom JSON data associated with the product.
trader
array of object
List of traders associated with the product.
Array of Properties
name
string
Trader's name.
type
string
Indicates the trader type.
Enum
address
array of string
List of addresses associated with the trader.
manufacturer
object
Required
Information about the product's manufacturer.
Properties
name
string
Required
Manufacturer's name.
address
string
Required
Manufacturer's physical address.
is_default
boolean
Indicates if this is the default manufacturer for the product.
return_config
object
Return policy configuration for the product.
Properties
unit
string
Time unit for the return period (either days or hours).
Enum
time
integer
Duration within which the product can be returned.
returnable
boolean
Required
Indicates if the product is returnable.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
tax_identifier
object
Tax-related identification for the product.
Properties
hsn_code_id
string
HSN (Harmonized System of Nomenclature) code identifier.
total_quantity
integer
Required
Total quantity available for the product.
expiration_date
string
Expiration or validity end date for the product.
track_inventory
boolean
Indicates if inventory tracking is enabled for the product.
country_of_origin
string
Required
Country where the product was manufactured or originated.
stage
string
Current stage of the product lifecycle (e.g., verified).
set
object
Configuration of the set, if the product is sold as one.
Properties
quantity
integer
Total number of items in the set.
size_distribution
object
Size distribution details within the set.
Properties
sizes
array of object
List of sizes and their respective quantities.
Array of Properties
size
string
Label of the size (e.g., S, M, L).
pieces
integer
Quantity of pieces for the corresponding size.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
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      "required": [
69        "articles"
70      ],
71      "properties": {
72        "articles": {
73          "type": "array",
74          "items": {
75            "type": "object",
76            "required": [
77              "uid",
78              "item_id",
79              "fynd_item_code",
80              "store",
81              "brand",
82              "company",
83              "size",
84              "identifier",
85              "seller_identifier",
86              "price",
87              "total_quantity",
88              "dimension",
89              "weight",
90              "manufacturer",
91              "country_of_origin"
92            ],
93            "properties": {
94              "id": {
95                "type": "string",
96                "description": "Unique identifier for the article."
97              },
98              "uid": {
99                "type": "string",
100                "description": "Combination of item code and store ID to uniquely identify the article."
101              },
102              "size": {
103                "type": "string",
104                "description": "Product size (e.g., S, M, L, XL)."
105              },
106              "brand": {
107                "type": "object",
108                "description": "Details about the product's brand.",
109                "properties": {
110                  "id": {
111                    "type": "integer",
112                    "description": "Unique identifier for the brand."
113                  }
114                },
115                "required": [
116                  "id"
117                ]
118              },
119              "price": {
120                "type": "object",
121                "description": "Pricing details of the product, including various price types.",
122                "properties": {
123                  "marked": {
124                    "type": "number",
125                    "description": "Marked price or original listed price of the product."
126                  },
127                  "currency": {
128                    "type": "string",
129                    "description": "Currency used for the product's pricing (e.g., USD, EUR)."
130                  },
131                  "transfer": {
132                    "type": "number",
133                    "description": "Transfer price of the product."
134                  },
135                  "effective": {
136                    "type": "number",
137                    "description": "Final price after applying discounts."
138                  },
139                  "updated_at": {
140                    "type": "string",
141                    "format": "date-time",
142                    "description": "Date and time when the pricing information was last updated."
143                  }
144                },
145                "required": [
146                  "transfer",
147                  "effective",
148                  "marked",
149                  "currency"
150                ]
151              },
152              "store": {
153                "type": "object",
154                "description": "Information about the store selling the product.",
155                "properties": {
156                  "id": {
157                    "type": "integer",
158                    "description": "Unique identifier for the store."
159                  }
160                },
161                "required": [
162                  "id"
163                ]
164              },
165              "is_set": {
166                "type": "boolean",
167                "description": "Indicates if the product is sold as part of a set."
168              },
169              "weight": {
170                "type": "object",
171                "description": "Weight details of the product.",
172                "properties": {
173                  "unit": {
174                    "type": "string",
175                    "description": "Unit of weight measurement (e.g., kg, lbs)."
176                  },
177                  "shipping": {
178                    "type": "number",
179                    "description": "Shipping weight of the product."
180                  },
181                  "is_default": {
182                    "type": "boolean",
183                    "description": "Indicates if this is the default weight configuration."
184                  }
185                },
186                "required": [
187                  "unit",
188                  "shipping"
189                ]
190              },
191              "company": {
192                "type": "object",
193                "description": "Information about the company producing or selling the product.",
194                "properties": {
195                  "id": {
196                    "type": "integer",
197                    "description": "Unique identifier for the company."
198                  }
199                },
200                "required": [
201                  "id"
202                ]
203              },
204              "item_id": {
205                "type": "integer",
206                "description": "Unique identifier for the item."
207              },
208              "date_meta": {
209                "type": "object",
210                "description": "Timestamps for important events in the product's lifecycle.",
211                "properties": {
212                  "created_on": {
213                    "type": "string",
214                    "format": "date-time",
215                    "description": "Date and time when the product was first created."
216                  },
217                  "modified_on": {
218                    "type": "string",
219                    "format": "date-time",
220                    "description": "Last modification timestamp of the product inventory details."
221                  },
222                  "added_on_store": {
223                    "type": "string",
224                    "format": "date-time",
225                    "description": "Date and time when the product was added to the store."
226                  },
227                  "inventory_updated_on": {
228                    "type": "string",
229                    "format": "date-time",
230                    "description": "Last inventory update timestamp."
231                  }
232                },
233                "required": [
234                  "modified_on"
235                ]
236              },
237              "dimension": {
238                "type": "object",
239                "description": "Dimension details of the product.",
240                "properties": {
241                  "unit": {
242                    "type": "string",
243                    "description": "Unit of dimension measurement (e.g., cm, inches)."
244                  },
245                  "width": {
246                    "type": "number",
247                    "description": "Width of the product."
248                  },
249                  "height": {
250                    "type": "number",
251                    "description": "Height of the product."
252                  },
253                  "length": {
254                    "type": "number",
255                    "description": "Length of the product."
256                  },
257                  "is_default": {
258                    "type": "boolean",
259                    "description": "Indicates if these are the default dimensions."
260                  }
261                },
262                "required": [
263                  "unit",
264                  "height",
265                  "width",
266                  "length"
267                ]
268              },
269              "is_active": {
270                "type": "boolean",
271                "description": "Indicates if the product is currently active (available for sale)."
272              },
273              "identifier": {
274                "type": "object",
275                "description": "Product-specific identifier details."
276              },
277              "quantities": {
278                "type": "object",
279                "description": "Information about product quantities, including available and unavailable stock.",
280                "properties": {
281                  "damaged": {
282                    "type": "object",
283                    "description": "Details of damaged stock.",
284                    "properties": {
285                      "count": {
286                        "type": "integer",
287                        "description": "Number of damaged units."
288                      },
289                      "updated_at": {
290                        "type": "string",
291                        "description": "Timestamp of the last damaged stock update."
292                      }
293                    },
294                    "required": [
295                      "count",
296                      "updated_at"
297                    ]
298                  },
299                  "sellable": {
300                    "type": "object",
301                    "description": "Sellable stock information.",
302                    "properties": {
303                      "count": {
304                        "type": "integer",
305                        "description": "Number of sellable units available."
306                      },
307                      "updated_at": {
308                        "type": "string",
309                        "description": "Timestamp of the last sellable stock update."
310                      }
311                    },
312                    "required": [
313                      "count",
314                      "updated_at"
315                    ]
316                  },
317                  "not_available": {
318                    "type": "object",
319                    "description": "Information about unavailable stock.",
320                    "properties": {
321                      "count": {
322                        "type": "integer",
323                        "description": "Number of unavailable units."
324                      },
325                      "updated_at": {
326                        "type": "string",
327                        "description": "Timestamp of the last unavailable stock update."
328                      }
329                    },
330                    "required": [
331                      "count",
332                      "updated_at"
333                    ]
334                  },
335                  "order_committed": {
336                    "type": "object",
337                    "description": "Details of committed orders.",
338                    "properties": {
339                      "count": {
340                        "type": "integer",
341                        "description": "Number of units committed to orders."
342                      },
343                      "updated_at": {
344                        "type": "string",
345                        "description": "Timestamp of the last order committed update."
346                      }
347                    }
348                  }
349                },
350                "required": [
351                  "sellable"
352                ]
353              },
354              "_custom_json": {
355                "type": "object",
356                "description": "Custom JSON data associated with the product."
357              },
358              "trader": {
359                "type": "array",
360                "description": "List of traders associated with the product.",
361                "items": {
362                  "type": "object",
363                  "properties": {
364                    "name": {
365                      "type": "string",
366                      "description": "Trader's name."
367                    },
368                    "type": {
369                      "type": "string",
370                      "enum": [
371                        "Manufacturer",
372                        "Importer",
373                        "Packer",
374                        "Marketer"
375                      ],
376                      "description": "Indicates the trader type."
377                    },
378                    "address": {
379                      "type": "array",
380                      "description": "List of addresses associated with the trader.",
381                      "items": {
382                        "type": "string"
383                      }
384                    }
385                  }
386                }
387              },
388              "manufacturer": {
389                "type": "object",
390                "description": "Information about the product's manufacturer.",
391                "properties": {
392                  "name": {
393                    "type": "string",
394                    "description": "Manufacturer's name."
395                  },
396                  "address": {
397                    "type": "string",
398                    "description": "Manufacturer's physical address."
399                  },
400                  "is_default": {
401                    "type": "boolean",
402                    "description": "Indicates if this is the default manufacturer for the product."
403                  }
404                },
405                "required": [
406                  "name",
407                  "address"
408                ]
409              },
410              "return_config": {
411                "type": "object",
412                "description": "Return policy configuration for the product.",
413                "properties": {
414                  "unit": {
415                    "type": "string",
416                    "enum": [
417                      "days",
418                      "hours"
419                    ],
420                    "description": "Time unit for the return period (either days or hours)."
421                  },
422                  "time": {
423                    "type": "integer",
424                    "description": "Duration within which the product can be returned."
425                  },
426                  "returnable": {
427                    "type": "boolean",
428                    "description": "Indicates if the product is returnable."
429                  }
430                },
431                "required": [
432                  "returnable"
433                ]
434              },
435              "fynd_item_code": {
436                "type": "string",
437                "description": "Fynd's unique internal code for the product."
438              },
439              "tax_identifier": {
440                "type": "object",
441                "description": "Tax-related identification for the product.",
442                "properties": {
443                  "hsn_code_id": {
444                    "type": "string",
445                    "description": "HSN (Harmonized System of Nomenclature) code identifier."
446                  }
447                }
448              },
449              "total_quantity": {
450                "type": "integer",
451                "description": "Total quantity available for the product."
452              },
453              "expiration_date": {
454                "type": "string",
455                "description": "Expiration or validity end date for the product."
456              },
457              "track_inventory": {
458                "type": "boolean",
459                "description": "Indicates if inventory tracking is enabled for the product."
460              },
461              "country_of_origin": {
462                "type": "string",
463                "description": "Country where the product was manufactured or originated."
464              },
465              "stage": {
466                "type": "string",
467                "description": "Current stage of the product lifecycle (e.g., verified)."
468              },
469              "set": {
470                "type": "object",
471                "description": "Configuration of the set, if the product is sold as one.",
472                "properties": {
473                  "quantity": {
474                    "type": "integer",
475                    "description": "Total number of items in the set."
476                  },
477                  "size_distribution": {
478                    "type": "object",
479                    "description": "Size distribution details within the set.",
480                    "properties": {
481                      "sizes": {
482                        "type": "array",
483                        "description": "List of sizes and their respective quantities.",
484                        "items": {
485                          "type": "object",
486                          "properties": {
487                            "size": {
488                              "type": "string",
489                              "description": "Label of the size (e.g., S, M, L)."
490                            },
491                            "pieces": {
492                              "type": "integer",
493                              "description": "Quantity of pieces for the corresponding size."
494                            }
495                          }
496                        }
497                      }
498                    }
499                  }
500                }
501              },
502              "seller_identifier": {
503                "type": "string",
504                "description": "Unique identifier used by the seller for the product."
505              }
506            }
507          }
508        }
509      }
510    }
511  }
512}
Payload Example
1{
2  "company_id": 61,
3  "contains": [
4    "articles"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1711552926254,
9    "id": "TnDwx8zqahrSj4ZoX7pGG0wqnchYTJt9BduujJ+RM2M=",
10    "name": "article",
11    "trace_id": [
12      "silverbolt.c5576594-ec4d-11ee-ba7a-36c24ca45877"
13    ],
14    "type": "delete",
15    "version": "1"
16  },
17  "payload": {
18    "articles": [
19      {
20        "_custom_json": {},
21        "brand": {
22          "id": 3559
23        },
24        "company": {
25          "id": 61
26        },
27        "country_of_origin": "India",
28        "date_meta": {
29          "added_on_store": "2024-03-27 15:20:48.796000",
30          "created_on": "2024-03-27 15:20:48.787000",
31          "inventory_updated_on": "2024-03-27 15:20:48.787000",
32          "modified_on": "2024-03-27 15:21:26.432000"
33        },
34        "dimension": {
35          "height": 5,
36          "length": 5,
37          "unit": "cm",
38          "width": 5
39        },
40        "expiration_date": "9998-01-30 23:59:00",
41        "fynd_item_code": "DSJHJJKSVD",
42        "id": "6604399e1d962a270d7bf31b",
43        "identifier": {
44          "ean": "SDVKJNSVD"
45        },
46        "is_active": true,
47        "is_set": false,
48        "item_id": 10198724,
49        "manufacturer": {
50          "address": "FYND, KONDIVITA, MAHARASHTRA, MUMBAI",
51          "name": "FUCHSIA VINE DESIGNS PRIVATE LIMITED"
52        },
53        "price": {
54          "currency": "INR",
55          "effective": 50000,
56          "marked": 100000,
57          "transfer": 0
58        },
59        "quantities": {
60          "sellable": {
61            "count": 10000,
62            "updated_at": "2024-03-27 15:20:48.787000"
63          }
64        },
65        "return_config": {
66          "returnable": false,
67          "time": 0,
68          "unit": "days"
69        },
70        "seller_identifier": "SDVKJNSVD",
71        "size": "OS",
72        "stage": "verified",
73        "store": {
74          "id": 15411
75        },
76        "tags": [],
77        "tax_identifier": {
78          "hsn_code_id": "65fd783dc528d7515782df49"
79        },
80        "total_quantity": 10000,
81        "trace_id": "inventory.9727cd26-ec4d-11ee-bd11-aa1ad4821f40",
82        "track_inventory": true,
83        "uid": "15411_SDVKJNSVD",
84        "weight": {
85          "shipping": 5,
86          "unit": "gram"
87        }
88      }
89    ]
90  }
91}

company/article/update/v1

this event is triggered when article is updated

Payload
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
id
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
articles
array of object
Required
Array of Properties
id
string
Unique identifier for the article.
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
size
string
Required
Product size (e.g., S, M, L, XL).
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
price
object
Required
Pricing details of the product, including various price types.
Properties
marked
number
Required
Marked price or original listed price of the product.
currency
string
Required
Currency used for the product's pricing (e.g., USD, EUR).
transfer
number
Required
Transfer price of the product.
effective
number
Required
Final price after applying discounts.
updated_at
string
| date-time
Date and time when the pricing information was last updated.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
is_set
boolean
Indicates if the product is sold as part of a set.
weight
object
Required
Weight details of the product.
Properties
unit
string
Required
Unit of weight measurement (e.g., kg, lbs).
shipping
number
Required
Shipping weight of the product.
is_default
boolean
Indicates if this is the default weight configuration.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
item_id
integer
Required
Unique identifier for the item.
date_meta
object
Timestamps for important events in the product's lifecycle.
Properties
created_on
string
| date-time
Date and time when the product was first created.
modified_on
string
| date-time
Required
Last modification timestamp of the product inventory details.
added_on_store
string
| date-time
Date and time when the product was added to the store.
inventory_updated_on
string
| date-time
Last inventory update timestamp.
dimension
object
Required
Dimension details of the product.
Properties
unit
string
Required
Unit of dimension measurement (e.g., cm, inches).
width
number
Required
Width of the product.
height
number
Required
Height of the product.
length
number
Required
Length of the product.
is_default
boolean
Indicates if these are the default dimensions.
is_active
boolean
Indicates if the product is currently active (available for sale).
identifier
object
Required
Product-specific identifier details.
quantities
object
Information about product quantities, including available and unavailable stock.
Properties
damaged
object
Details of damaged stock.
Properties
count
integer
Required
Number of damaged units.
updated_at
string
Required
Timestamp of the last damaged stock update.
sellable
object
Required
Sellable stock information.
Properties
count
integer
Required
Number of sellable units available.
updated_at
string
Required
Timestamp of the last sellable stock update.
not_available
object
Information about unavailable stock.
Properties
count
integer
Required
Number of unavailable units.
updated_at
string
Required
Timestamp of the last unavailable stock update.
order_committed
object
Details of committed orders.
Properties
count
integer
Number of units committed to orders.
updated_at
string
Timestamp of the last order committed update.
_custom_json
object
Custom JSON data associated with the product.
trader
array of object
List of traders associated with the product.
Array of Properties
name
string
Trader's name.
type
string
Indicates the trader type.
Enum
address
array of string
List of addresses associated with the trader.
manufacturer
object
Required
Information about the product's manufacturer.
Properties
name
string
Required
Manufacturer's name.
address
string
Required
Manufacturer's physical address.
is_default
boolean
Indicates if this is the default manufacturer for the product.
return_config
object
Return policy configuration for the product.
Properties
unit
string
Time unit for the return period (either days or hours).
Enum
time
integer
Duration within which the product can be returned.
returnable
boolean
Required
Indicates if the product is returnable.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
tax_identifier
object
Tax-related identification for the product.
Properties
hsn_code_id
string
HSN (Harmonized System of Nomenclature) code identifier.
total_quantity
integer
Required
Total quantity available for the product.
expiration_date
string
Expiration or validity end date for the product.
track_inventory
boolean
Indicates if inventory tracking is enabled for the product.
country_of_origin
string
Required
Country where the product was manufactured or originated.
stage
string
Current stage of the product lifecycle (e.g., verified).
set
object
Configuration of the set, if the product is sold as one.
Properties
quantity
integer
Total number of items in the set.
size_distribution
object
Size distribution details within the set.
Properties
sizes
array of object
List of sizes and their respective quantities.
Array of Properties
size
string
Label of the size (e.g., S, M, L).
pieces
integer
Quantity of pieces for the corresponding size.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
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      "required": [
69        "articles"
70      ],
71      "properties": {
72        "articles": {
73          "type": "array",
74          "items": {
75            "type": "object",
76            "required": [
77              "uid",
78              "item_id",
79              "fynd_item_code",
80              "store",
81              "brand",
82              "company",
83              "size",
84              "identifier",
85              "seller_identifier",
86              "price",
87              "total_quantity",
88              "dimension",
89              "weight",
90              "manufacturer",
91              "country_of_origin"
92            ],
93            "properties": {
94              "id": {
95                "type": "string",
96                "description": "Unique identifier for the article."
97              },
98              "uid": {
99                "type": "string",
100                "description": "Combination of item code and store ID to uniquely identify the article."
101              },
102              "size": {
103                "type": "string",
104                "description": "Product size (e.g., S, M, L, XL)."
105              },
106              "brand": {
107                "type": "object",
108                "description": "Details about the product's brand.",
109                "properties": {
110                  "id": {
111                    "type": "integer",
112                    "description": "Unique identifier for the brand."
113                  }
114                },
115                "required": [
116                  "id"
117                ]
118              },
119              "price": {
120                "type": "object",
121                "description": "Pricing details of the product, including various price types.",
122                "properties": {
123                  "marked": {
124                    "type": "number",
125                    "description": "Marked price or original listed price of the product."
126                  },
127                  "currency": {
128                    "type": "string",
129                    "description": "Currency used for the product's pricing (e.g., USD, EUR)."
130                  },
131                  "transfer": {
132                    "type": "number",
133                    "description": "Transfer price of the product."
134                  },
135                  "effective": {
136                    "type": "number",
137                    "description": "Final price after applying discounts."
138                  },
139                  "updated_at": {
140                    "type": "string",
141                    "format": "date-time",
142                    "description": "Date and time when the pricing information was last updated."
143                  }
144                },
145                "required": [
146                  "transfer",
147                  "effective",
148                  "marked",
149                  "currency"
150                ]
151              },
152              "store": {
153                "type": "object",
154                "description": "Information about the store selling the product.",
155                "properties": {
156                  "id": {
157                    "type": "integer",
158                    "description": "Unique identifier for the store."
159                  }
160                },
161                "required": [
162                  "id"
163                ]
164              },
165              "is_set": {
166                "type": "boolean",
167                "description": "Indicates if the product is sold as part of a set."
168              },
169              "weight": {
170                "type": "object",
171                "description": "Weight details of the product.",
172                "properties": {
173                  "unit": {
174                    "type": "string",
175                    "description": "Unit of weight measurement (e.g., kg, lbs)."
176                  },
177                  "shipping": {
178                    "type": "number",
179                    "description": "Shipping weight of the product."
180                  },
181                  "is_default": {
182                    "type": "boolean",
183                    "description": "Indicates if this is the default weight configuration."
184                  }
185                },
186                "required": [
187                  "unit",
188                  "shipping"
189                ]
190              },
191              "company": {
192                "type": "object",
193                "description": "Information about the company producing or selling the product.",
194                "properties": {
195                  "id": {
196                    "type": "integer",
197                    "description": "Unique identifier for the company."
198                  }
199                },
200                "required": [
201                  "id"
202                ]
203              },
204              "item_id": {
205                "type": "integer",
206                "description": "Unique identifier for the item."
207              },
208              "date_meta": {
209                "type": "object",
210                "description": "Timestamps for important events in the product's lifecycle.",
211                "properties": {
212                  "created_on": {
213                    "type": "string",
214                    "format": "date-time",
215                    "description": "Date and time when the product was first created."
216                  },
217                  "modified_on": {
218                    "type": "string",
219                    "format": "date-time",
220                    "description": "Last modification timestamp of the product inventory details."
221                  },
222                  "added_on_store": {
223                    "type": "string",
224                    "format": "date-time",
225                    "description": "Date and time when the product was added to the store."
226                  },
227                  "inventory_updated_on": {
228                    "type": "string",
229                    "format": "date-time",
230                    "description": "Last inventory update timestamp."
231                  }
232                },
233                "required": [
234                  "modified_on"
235                ]
236              },
237              "dimension": {
238                "type": "object",
239                "description": "Dimension details of the product.",
240                "properties": {
241                  "unit": {
242                    "type": "string",
243                    "description": "Unit of dimension measurement (e.g., cm, inches)."
244                  },
245                  "width": {
246                    "type": "number",
247                    "description": "Width of the product."
248                  },
249                  "height": {
250                    "type": "number",
251                    "description": "Height of the product."
252                  },
253                  "length": {
254                    "type": "number",
255                    "description": "Length of the product."
256                  },
257                  "is_default": {
258                    "type": "boolean",
259                    "description": "Indicates if these are the default dimensions."
260                  }
261                },
262                "required": [
263                  "unit",
264                  "height",
265                  "width",
266                  "length"
267                ]
268              },
269              "is_active": {
270                "type": "boolean",
271                "description": "Indicates if the product is currently active (available for sale)."
272              },
273              "identifier": {
274                "type": "object",
275                "description": "Product-specific identifier details."
276              },
277              "quantities": {
278                "type": "object",
279                "description": "Information about product quantities, including available and unavailable stock.",
280                "properties": {
281                  "damaged": {
282                    "type": "object",
283                    "description": "Details of damaged stock.",
284                    "properties": {
285                      "count": {
286                        "type": "integer",
287                        "description": "Number of damaged units."
288                      },
289                      "updated_at": {
290                        "type": "string",
291                        "description": "Timestamp of the last damaged stock update."
292                      }
293                    },
294                    "required": [
295                      "count",
296                      "updated_at"
297                    ]
298                  },
299                  "sellable": {
300                    "type": "object",
301                    "description": "Sellable stock information.",
302                    "properties": {
303                      "count": {
304                        "type": "integer",
305                        "description": "Number of sellable units available."
306                      },
307                      "updated_at": {
308                        "type": "string",
309                        "description": "Timestamp of the last sellable stock update."
310                      }
311                    },
312                    "required": [
313                      "count",
314                      "updated_at"
315                    ]
316                  },
317                  "not_available": {
318                    "type": "object",
319                    "description": "Information about unavailable stock.",
320                    "properties": {
321                      "count": {
322                        "type": "integer",
323                        "description": "Number of unavailable units."
324                      },
325                      "updated_at": {
326                        "type": "string",
327                        "description": "Timestamp of the last unavailable stock update."
328                      }
329                    },
330                    "required": [
331                      "count",
332                      "updated_at"
333                    ]
334                  },
335                  "order_committed": {
336                    "type": "object",
337                    "description": "Details of committed orders.",
338                    "properties": {
339                      "count": {
340                        "type": "integer",
341                        "description": "Number of units committed to orders."
342                      },
343                      "updated_at": {
344                        "type": "string",
345                        "description": "Timestamp of the last order committed update."
346                      }
347                    }
348                  }
349                },
350                "required": [
351                  "sellable"
352                ]
353              },
354              "_custom_json": {
355                "type": "object",
356                "description": "Custom JSON data associated with the product."
357              },
358              "trader": {
359                "type": "array",
360                "description": "List of traders associated with the product.",
361                "items": {
362                  "type": "object",
363                  "properties": {
364                    "name": {
365                      "type": "string",
366                      "description": "Trader's name."
367                    },
368                    "type": {
369                      "type": "string",
370                      "enum": [
371                        "Manufacturer",
372                        "Importer",
373                        "Packer",
374                        "Marketer"
375                      ],
376                      "description": "Indicates the trader type."
377                    },
378                    "address": {
379                      "type": "array",
380                      "description": "List of addresses associated with the trader.",
381                      "items": {
382                        "type": "string"
383                      }
384                    }
385                  }
386                }
387              },
388              "manufacturer": {
389                "type": "object",
390                "description": "Information about the product's manufacturer.",
391                "properties": {
392                  "name": {
393                    "type": "string",
394                    "description": "Manufacturer's name."
395                  },
396                  "address": {
397                    "type": "string",
398                    "description": "Manufacturer's physical address."
399                  },
400                  "is_default": {
401                    "type": "boolean",
402                    "description": "Indicates if this is the default manufacturer for the product."
403                  }
404                },
405                "required": [
406                  "name",
407                  "address"
408                ]
409              },
410              "return_config": {
411                "type": "object",
412                "description": "Return policy configuration for the product.",
413                "properties": {
414                  "unit": {
415                    "type": "string",
416                    "enum": [
417                      "days",
418                      "hours"
419                    ],
420                    "description": "Time unit for the return period (either days or hours)."
421                  },
422                  "time": {
423                    "type": "integer",
424                    "description": "Duration within which the product can be returned."
425                  },
426                  "returnable": {
427                    "type": "boolean",
428                    "description": "Indicates if the product is returnable."
429                  }
430                },
431                "required": [
432                  "returnable"
433                ]
434              },
435              "fynd_item_code": {
436                "type": "string",
437                "description": "Fynd's unique internal code for the product."
438              },
439              "tax_identifier": {
440                "type": "object",
441                "description": "Tax-related identification for the product.",
442                "properties": {
443                  "hsn_code_id": {
444                    "type": "string",
445                    "description": "HSN (Harmonized System of Nomenclature) code identifier."
446                  }
447                }
448              },
449              "total_quantity": {
450                "type": "integer",
451                "description": "Total quantity available for the product."
452              },
453              "expiration_date": {
454                "type": "string",
455                "description": "Expiration or validity end date for the product."
456              },
457              "track_inventory": {
458                "type": "boolean",
459                "description": "Indicates if inventory tracking is enabled for the product."
460              },
461              "country_of_origin": {
462                "type": "string",
463                "description": "Country where the product was manufactured or originated."
464              },
465              "stage": {
466                "type": "string",
467                "description": "Current stage of the product lifecycle (e.g., verified)."
468              },
469              "set": {
470                "type": "object",
471                "description": "Configuration of the set, if the product is sold as one.",
472                "properties": {
473                  "quantity": {
474                    "type": "integer",
475                    "description": "Total number of items in the set."
476                  },
477                  "size_distribution": {
478                    "type": "object",
479                    "description": "Size distribution details within the set.",
480                    "properties": {
481                      "sizes": {
482                        "type": "array",
483                        "description": "List of sizes and their respective quantities.",
484                        "items": {
485                          "type": "object",
486                          "properties": {
487                            "size": {
488                              "type": "string",
489                              "description": "Label of the size (e.g., S, M, L)."
490                            },
491                            "pieces": {
492                              "type": "integer",
493                              "description": "Quantity of pieces for the corresponding size."
494                            }
495                          }
496                        }
497                      }
498                    }
499                  }
500                }
501              },
502              "seller_identifier": {
503                "type": "string",
504                "description": "Unique identifier used by the seller for the product."
505              }
506            }
507          }
508        }
509      }
510    }
511  }
512}
Payload Example
1{
2  "company_id": 3932,
3  "contains": [
4    "articles"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1712143546633,
9    "id": "JTxFS9aTWX0Jzkzgher4YEpDoRWtok4kUdIwPHtufiQ=",
10    "name": "article",
11    "trace_id": [
12      "silverbolt.ea855272-f1ac-11ee-b06f-aeef32a192b9"
13    ],
14    "type": "update",
15    "version": "1"
16  },
17  "payload": {
18    "articles": [
19      {
20        "_custom_json": {},
21        "brand": {
22          "id": 414
23        },
24        "company": {
25          "id": 3932
26        },
27        "country_of_origin": "India",
28        "date_meta": {
29          "inventory_updated_on": "2024-04-03 11:25:46.620269",
30          "modified_on": "2024-04-03 11:25:46.620269"
31        },
32        "dimension": {
33          "height": 5,
34          "length": 33,
35          "unit": "cm",
36          "width": 25
37        },
38        "expiration_date": "9998-01-30 23:59:00",
39        "fynd_item_code": "MFT-28408-P-01-BLACK",
40        "id": "64a8bb0c3834e4c1b96f72f2",
41        "identifier": {
42          "ean": "8905310163563"
43        },
44        "is_active": true,
45        "is_set": false,
46        "item_id": 8696234,
47        "manufacturer": {
48          "address": "B-8, ANDHERI EAST, MUMBAI -400093, , MAHARASHTRA, MUMBAI SUBURBAN",
49          "name": "Credo Brands Marketing Limited"
50        },
51        "price": {
52          "currency": "INR",
53          "effective": 4099,
54          "marked": 4099,
55          "transfer": 0
56        },
57        "quantities": {
58          "damaged": {
59            "count": 0,
60            "updated_at": "2024-04-03 11:25:46.620269"
61          },
62          "not_available": {
63            "count": 0,
64            "updated_at": "2024-04-03 11:25:46.620269"
65          },
66          "sellable": {
67            "count": 2,
68            "updated_at": "2024-04-03 11:25:46.620269"
69          }
70        },
71        "return_config": {
72          "returnable": true,
73          "time": 30,
74          "unit": "days"
75        },
76        "seller_identifier": "8905310163563",
77        "size": "30",
78        "stage": "verified",
79        "store": {
80          "id": 18104
81        },
82        "tags": [],
83        "tax_identifier": {
84          "hsn_code_id": "6277838c5e4c6fdbc8be402d"
85        },
86        "total_quantity": 2,
87        "trace_id": "660d3cb866632959e7348904",
88        "track_inventory": true,
89        "uid": "18104_8905310163563",
90        "weight": {
91          "shipping": 600,
92          "unit": "gram"
93        }
94      }
95    ]
96  }
97}

Brand

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

Events
company/brand/create/v1
# this event is triggered when brand is created
company/brand/update/v1
# this event is triggered when brand is updated

company/brand/create/v1

this event is triggered when brand is created

Payload
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
id
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
brand
object
Required
Brand details.
Properties
id
string
The unique ID of the brand.
uid
integer
Required
The UID of the brand.
_cls
string
Class information of the brand.
logo
string
Required
The URL of the brand's logo.
mode
string
The mode of the brand.
name
string
Required
The name of the brand.
stage
string
Required
The stage of the brand.
banner
object
The banner images of the brand.
Properties
portrait
string
The URL of the brand's portrait banner.
landscape
string
The URL of the brand's landscape banner.
slug_key
string
Required
The slug key of the brand.
synonyms
array of string
A list of synonyms for the brand name.
warnings
object
A dictionary of warnings related to the brand.
meta_json
object
The meta data for the brand.
Properties
company_id
integer
The ID of the company associated with this meta data.
company_id
integer
Required
The ID of the company the brand belongs to.
created_by
object
The user who created the brand.
Properties
user_id
string
Required
The unique ID of the user who created the brand.
username
string
Required
The username of the user who created the brand.
created_on
string
The date and time when the brand was created.
description
string
A description of the brand.
modified_by
object
The user who last modified the brand.
Properties
user_id
string
Required
The unique ID of the user who last modified the brand.
username
string
Required
The username of the user who last modified the brand.
modified_on
string
The date and time when the brand was last modified.
verified_by
object
The user who verified the brand.
Properties
user_id
string
Required
The unique ID of the user who verified the brand.
username
string
Required
The username of the user who verified the brand.
verified_on
string
The date and time when the brand was verified.
_custom_json
object
Custom JSON data for the brand.
_locale_language
object
The language settings for the brand.
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      "required": [
69        "brand"
70      ],
71      "properties": {
72        "brand": {
73          "type": "object",
74          "required": [
75            "name",
76            "uid",
77            "company_id",
78            "slug_key",
79            "stage",
80            "logo"
81          ],
82          "properties": {
83            "id": {
84              "type": "string",
85              "description": "The unique ID of the brand."
86            },
87            "uid": {
88              "type": "integer",
89              "description": "The UID of the brand."
90            },
91            "_cls": {
92              "type": "string",
93              "description": "Class information of the brand."
94            },
95            "logo": {
96              "type": "string",
97              "description": "The URL of the brand's logo."
98            },
99            "mode": {
100              "type": "string",
101              "description": "The mode of the brand."
102            },
103            "name": {
104              "type": "string",
105              "description": "The name of the brand."
106            },
107            "stage": {
108              "type": "string",
109              "description": "The stage of the brand."
110            },
111            "banner": {
112              "type": "object",
113              "required": [],
114              "properties": {
115                "portrait": {
116                  "type": "string",
117                  "description": "The URL of the brand's portrait banner."
118                },
119                "landscape": {
120                  "type": "string",
121                  "description": "The URL of the brand's landscape banner."
122                }
123              },
124              "description": "The banner images of the brand."
125            },
126            "slug_key": {
127              "type": "string",
128              "description": "The slug key of the brand."
129            },
130            "synonyms": {
131              "type": "array",
132              "items": {
133                "type": "string"
134              },
135              "description": "A list of synonyms for the brand name."
136            },
137            "warnings": {
138              "type": "object",
139              "description": "A dictionary of warnings related to the brand."
140            },
141            "meta_json": {
142              "type": "object",
143              "properties": {
144                "company_id": {
145                  "type": "integer",
146                  "description": "The ID of the company associated with this meta data."
147                }
148              },
149              "description": "The meta data for the brand."
150            },
151            "company_id": {
152              "type": "integer",
153              "description": "The ID of the company the brand belongs to."
154            },
155            "created_by": {
156              "type": "object",
157              "required": [
158                "user_id",
159                "username"
160              ],
161              "properties": {
162                "user_id": {
163                  "type": "string",
164                  "description": "The unique ID of the user who created the brand."
165                },
166                "username": {
167                  "type": "string",
168                  "description": "The username of the user who created the brand."
169                }
170              },
171              "description": "The user who created the brand."
172            },
173            "created_on": {
174              "type": "string",
175              "description": "The date and time when the brand was created."
176            },
177            "description": {
178              "type": "string",
179              "description": "A description of the brand."
180            },
181            "modified_by": {
182              "type": "object",
183              "required": [
184                "user_id",
185                "username"
186              ],
187              "properties": {
188                "user_id": {
189                  "type": "string",
190                  "description": "The unique ID of the user who last modified the brand."
191                },
192                "username": {
193                  "type": "string",
194                  "description": "The username of the user who last modified the brand."
195                }
196              },
197              "description": "The user who last modified the brand."
198            },
199            "modified_on": {
200              "type": "string",
201              "description": "The date and time when the brand was last modified."
202            },
203            "verified_by": {
204              "type": "object",
205              "required": [
206                "user_id",
207                "username"
208              ],
209              "properties": {
210                "user_id": {
211                  "type": "string",
212                  "description": "The unique ID of the user who verified the brand."
213                },
214                "username": {
215                  "type": "string",
216                  "description": "The username of the user who verified the brand."
217                }
218              },
219              "description": "The user who verified the brand."
220            },
221            "verified_on": {
222              "type": "string",
223              "description": "The date and time when the brand was verified."
224            },
225            "_custom_json": {
226              "type": "object",
227              "description": "Custom JSON data for the brand."
228            },
229            "_locale_language": {
230              "type": "object",
231              "description": "The language settings for the brand."
232            }
233          },
234          "description": "Brand details."
235        }
236      }
237    }
238  }
239}
Payload Example
1{
2  "company_id": 61,
3  "contains": [
4    "brand"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1711688290399,
9    "id": "UZKh3R1YKpTUlQx5AL970V72Y2Z2bSwOIATEwLXAu6I=",
10    "name": "brand",
11    "trace_id": [
12      "WheelJack.f0a8c382-ed88-11ee-bea0-620952f5da1a"
13    ],
14    "type": "create",
15    "version": "1"
16  },
17  "payload": {
18    "brand": {
19      "_locale_language": {},
20      "banner": {
21        "landscape": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/landscape-banner/original/Cb_ArFhPE-Landsacpe-Banner.png",
22        "portrait": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/portrait-banner/original/k3ety-h39-Portrait-Banner.png"
23      },
24      "company_id": 61,
25      "description": "",
26      "id": "66064a624ebfdd9d40a91309",
27      "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/square-logo/original/Eg3oiR_bw-Logo.jpeg",
28      "mode": "live",
29      "name": "Mirraw",
30      "slug_key": "mirraw",
31      "stage": "complete",
32      "uid": 7990
33    }
34  }
35}

company/brand/update/v1

this event is triggered when brand is updated

Payload
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
id
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
brand
object
Required
Brand details.
Properties
uid
integer
Required
The UID of the brand.
name
string
Required
The name of the brand.
stage
string
Required
The stage of the brand.
logo
string
Required
The URL of the brand's logo.
banner
object
Required
The banner images of the brand.
Properties
portrait
string
Required
The URL of the brand's portrait banner.
landscape
string
Required
The URL of the brand's landscape banner.
description
string
A description of the brand.
_locale_language
object
The language settings for the brand.
company_id
integer
Required
The ID of the company the brand belongs to.
id
string
Required
The unique ID of the brand.
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        "brand": {
70          "type": "object",
71          "properties": {
72            "uid": {
73              "type": "integer",
74              "description": "The UID of the brand."
75            },
76            "name": {
77              "type": "string",
78              "description": "The name of the brand."
79            },
80            "stage": {
81              "type": "string",
82              "description": "The stage of the brand."
83            },
84            "logo": {
85              "type": "string",
86              "description": "The URL of the brand's logo."
87            },
88            "banner": {
89              "type": "object",
90              "properties": {
91                "portrait": {
92                  "type": "string",
93                  "description": "The URL of the brand's portrait banner."
94                },
95                "landscape": {
96                  "type": "string",
97                  "description": "The URL of the brand's landscape banner."
98                }
99              },
100              "required": [
101                "portrait",
102                "landscape"
103              ],
104              "description": "The banner images of the brand."
105            },
106            "description": {
107              "type": "string",
108              "description": "A description of the brand."
109            },
110            "_locale_language": {
111              "type": "object",
112              "description": "The language settings for the brand."
113            },
114            "company_id": {
115              "type": "integer",
116              "description": "The ID of the company the brand belongs to."
117            },
118            "id": {
119              "type": "string",
120              "description": "The unique ID of the brand."
121            }
122          },
123          "required": [
124            "uid",
125            "name",
126            "stage",
127            "logo",
128            "banner",
129            "company_id",
130            "id"
131          ],
132          "description": "Brand details."
133        }
134      },
135      "required": [
136        "brand"
137      ]
138    }
139  }
140}
Payload Example
1{
2  "company_id": 61,
3  "contains": [
4    "brand"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1711643753177,
9    "id": "RHL08gMG11SDwyix7lwCN1lMrRCVPbkv72mje0AOrXQ=",
10    "name": "brand",
11    "trace_id": [
12      "WheelJack.3e681ebe-ed21-11ee-aaad-9e29e151ef18"
13    ],
14    "type": "update",
15    "version": "1"
16  },
17  "payload": {
18    "brand": {
19      "_locale_language": {},
20      "banner": {
21        "landscape": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/landscape-banner/original/xS3yYSccB-3Y7m0I3J5-Landsacpe-Banner.jpeg",
22        "portrait": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/portrait-banner/original/kCTYrsIHp-0QOLHIHiT-Portrait-Banner.jpeg"
23      },
24      "company_id": 61,
25      "description": "",
26      "id": "65241a754c42bd82ac09e1bd",
27      "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/square-logo/original/LnJda98-q-juwas-TRj-Logo.png",
28      "name": "DIOR",
29      "stage": "complete",
30      "uid": 7392
31    }
32  }
33}

Company

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

Events
company/company/create/v1
# this event is triggered when company is created
company/company/update/v1
# this event is triggered when company is updated

company/company/create/v1

this event is triggered when company is created

Payload
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
id
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
company
object
Required
Properties
_id
string
The unique identifier of the company
uid
integer
The user ID associated with the company
mode
string
The mode of the company
Enum
name
string
Required
The name of the company
stage
string
The stage of the company
taxes
array of object
The list of taxes associated with the company.
Array of Properties
rate
number
The rate value.
enable
boolean
A boolean value indicating whether the rate is enabled or not.
effective_date
string
The effective date of the rate.
domain
string
The domain associated with the company
warnings
object
The warnings associated with the company ( can contain any key value pair )
addresses
array of object
Required
The list of addresses associated with the company.
Array of Properties
city
string
Required
The city of the address.
state
string
Required
The state of the address.
country
string
Required
The country of the address.
pincode
integer
Required
The pincode of the address.
address1
string
Required
The first line of the address.
address2
string
The second line of the address.
landmark
string
The landmark near the address.
latitude
number
Required
The latitude of the address.
longitude
number
Required
The longitude of the address.
address_type
string
The type of address.
country_code
string
The country code of the address.
documents
array of object
Required
The list of documents associated with the company
Array of Properties
url
string
The URL of the document.
type
string
Required
The type of the document.
value
string
Required
The value of the document.
verified
boolean
Indicates whether the document is verified.
legal_name
string
The legal name associated with the document.
created_by
object
The user who created the company
Properties
user_id
string
Required
User ID of the user who created the company
username
string
Required
Username of the user who created the company
created_on
string
The date and time when the company was created
modified_by
object
The user who last modified the company.
Properties
user_id
string
Required
User ID of the user who last modified the company
username
string
Required
Username of the user who last modified the company
modified_on
string
The date and time when the company was last modified
verified_by
object
The user who verified the brand.
Properties
user_id
string
Required
User ID of the user who verified the company
username
string
Required
Username of the user who verified the company
verified_on
string
The date and time when the company was verified
_custom_json
object
Custom JSON data associated with the company
company_type
string
The type of the company
marketplaces
array of string
The list of marketplaces associated with the company
business_info
string
The business information of the company
business_type
string
The business type of the company
referral_info
object
The referral information associated with the company
Properties
referral_code
string
Referral code for the user
reject_reason
string
The reason why the company was rejected
contact_details
object
The contact details associated with the company
Properties
phone
array of object
List of phone numbers.
Array of Properties
number
string
Required
The phone number for contact person.
country_code
integer
Required
The country code for the contact person.
emails
array of string
List of email addresses.
business_details
object
Additional business details
Properties
website
object
Required
Details about the website of the business.
Properties
url
string
The URL of the website.
franchise_enabled
boolean
Whether the company is a franchise
notification_emails
array of string
The list of email addresses for notifications
business_country_info
object
The country and country code of the company
Properties
country
string
The name of the country where the business operates
country_code
string
The ISO 3166-1 alpha-2 country code of the country where the business operates
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      "required": [
69        "company"
70      ],
71      "properties": {
72        "company": {
73          "type": "object",
74          "required": [
75            "name",
76            "addresses",
77            "documents"
78          ],
79          "properties": {
80            "_id": {
81              "type": "string",
82              "description": "The unique identifier of the company"
83            },
84            "uid": {
85              "type": "integer",
86              "description": "The user ID associated with the company"
87            },
88            "mode": {
89              "type": "string",
90              "enum": [
91                "live",
92                "development"
93              ],
94              "description": "The mode of the company"
95            },
96            "name": {
97              "type": "string",
98              "description": "The name of the company"
99            },
100            "stage": {
101              "type": "string",
102              "description": "The stage of the company"
103            },
104            "taxes": {
105              "type": "array",
106              "items": {
107                "type": "object",
108                "required": [],
109                "properties": {
110                  "rate": {
111                    "type": "number",
112                    "description": "The rate value."
113                  },
114                  "enable": {
115                    "type": "boolean",
116                    "description": "A boolean value indicating whether the rate is enabled or not."
117                  },
118                  "effective_date": {
119                    "type": "string",
120                    "description": "The effective date of the rate."
121                  }
122                }
123              },
124              "description": "The list of taxes associated with the company."
125            },
126            "domain": {
127              "type": "string",
128              "description": "The domain associated with the company"
129            },
130            "warnings": {
131              "type": "object",
132              "description": "The warnings associated with the company ( can contain any key value pair )"
133            },
134            "addresses": {
135              "type": "array",
136              "items": {
137                "type": "object",
138                "required": [
139                  "country",
140                  "state",
141                  "city",
142                  "pincode",
143                  "address1",
144                  "latitude",
145                  "longitude"
146                ],
147                "properties": {
148                  "city": {
149                    "type": "string",
150                    "description": "The city of the address."
151                  },
152                  "state": {
153                    "type": "string",
154                    "description": "The state of the address."
155                  },
156                  "country": {
157                    "type": "string",
158                    "description": "The country of the address."
159                  },
160                  "pincode": {
161                    "type": "integer",
162                    "description": "The pincode of the address."
163                  },
164                  "address1": {
165                    "type": "string",
166                    "description": "The first line of the address."
167                  },
168                  "address2": {
169                    "type": "string",
170                    "description": "The second line of the address."
171                  },
172                  "landmark": {
173                    "type": "string",
174                    "description": "The landmark near the address."
175                  },
176                  "latitude": {
177                    "type": "number",
178                    "description": "The latitude of the address."
179                  },
180                  "longitude": {
181                    "type": "number",
182                    "description": "The longitude of the address."
183                  },
184                  "address_type": {
185                    "type": "string",
186                    "description": "The type of address."
187                  },
188                  "country_code": {
189                    "type": "string",
190                    "description": "The country code of the address."
191                  }
192                }
193              },
194              "description": "The list of addresses associated with the company."
195            },
196            "documents": {
197              "type": "array",
198              "items": {
199                "type": "object",
200                "required": [
201                  "type",
202                  "value"
203                ],
204                "properties": {
205                  "url": {
206                    "type": "string",
207                    "description": "The URL of the document."
208                  },
209                  "type": {
210                    "type": "string",
211                    "description": "The type of the document."
212                  },
213                  "value": {
214                    "type": "string",
215                    "description": "The value of the document."
216                  },
217                  "verified": {
218                    "type": "boolean",
219                    "description": "Indicates whether the document is verified."
220                  },
221                  "legal_name": {
222                    "type": "string",
223                    "description": "The legal name associated with the document."
224                  }
225                }
226              },
227              "description": "The list of documents associated with the company"
228            },
229            "created_by": {
230              "type": "object",
231              "required": [
232                "user_id",
233                "username"
234              ],
235              "properties": {
236                "user_id": {
237                  "type": "string",
238                  "description": "User ID of the user who created the company"
239                },
240                "username": {
241                  "type": "string",
242                  "description": "Username of the user who created the company"
243                }
244              },
245              "description": "The user who created the company"
246            },
247            "created_on": {
248              "type": "string",
249              "description": "The date and time when the company was created"
250            },
251            "modified_by": {
252              "type": "object",
253              "required": [
254                "user_id",
255                "username"
256              ],
257              "properties": {
258                "user_id": {
259                  "type": "string",
260                  "description": "User ID of the user who last modified the company"
261                },
262                "username": {
263                  "type": "string",
264                  "description": "Username of the user who last modified the company"
265                }
266              },
267              "description": "The user who last modified the company."
268            },
269            "modified_on": {
270              "type": "string",
271              "description": "The date and time when the company was last modified"
272            },
273            "verified_by": {
274              "type": "object",
275              "required": [
276                "user_id",
277                "username"
278              ],
279              "properties": {
280                "user_id": {
281                  "type": "string",
282                  "description": "User ID of the user who verified the company"
283                },
284                "username": {
285                  "type": "string",
286                  "description": "Username of the user who verified the company"
287                }
288              },
289              "description": "The user who verified the brand."
290            },
291            "verified_on": {
292              "type": "string",
293              "description": "The date and time when the company was verified"
294            },
295            "_custom_json": {
296              "type": "object",
297              "description": "Custom JSON data associated with the company"
298            },
299            "company_type": {
300              "type": "string",
301              "description": "The type of the company"
302            },
303            "marketplaces": {
304              "type": "array",
305              "items": {
306                "type": "string"
307              },
308              "description": "The list of marketplaces associated with the company"
309            },
310            "business_info": {
311              "type": "string",
312              "description": "The business information of the company"
313            },
314            "business_type": {
315              "type": "string",
316              "description": "The business type of the company"
317            },
318            "referral_info": {
319              "type": "object",
320              "required": [],
321              "properties": {
322                "referral_code": {
323                  "type": "string",
324                  "description": "Referral code for the user"
325                }
326              },
327              "description": "The referral information associated with the company"
328            },
329            "reject_reason": {
330              "type": "string",
331              "description": "The reason why the company was rejected"
332            },
333            "contact_details": {
334              "type": "object",
335              "required": [],
336              "properties": {
337                "phone": {
338                  "type": "array",
339                  "items": {
340                    "type": "object",
341                    "required": [
342                      "number",
343                      "country_code"
344                    ],
345                    "properties": {
346                      "number": {
347                        "type": "string",
348                        "description": "The phone number for contact person."
349                      },
350                      "country_code": {
351                        "type": "integer",
352                        "description": "The country code for the contact person."
353                      }
354                    }
355                  },
356                  "description": "List of phone numbers."
357                },
358                "emails": {
359                  "type": "array",
360                  "items": {
361                    "type": "string"
362                  },
363                  "description": "List of email addresses."
364                }
365              },
366              "description": "The contact details associated with the company"
367            },
368            "business_details": {
369              "type": "object",
370              "required": [
371                "website"
372              ],
373              "properties": {
374                "website": {
375                  "type": "object",
376                  "required": [],
377                  "properties": {
378                    "url": {
379                      "type": "string",
380                      "description": "The URL of the website."
381                    }
382                  },
383                  "description": "Details about the website of the business."
384                }
385              },
386              "description": "Additional business details"
387            },
388            "franchise_enabled": {
389              "type": "boolean",
390              "description": "Whether the company is a franchise"
391            },
392            "notification_emails": {
393              "type": "array",
394              "items": {
395                "type": "string"
396              },
397              "description": "The list of email addresses for notifications"
398            },
399            "business_country_info": {
400              "type": "object",
401              "required": [],
402              "properties": {
403                "country": {
404                  "type": "string",
405                  "description": "The name of the country where the business operates"
406                },
407                "country_code": {
408                  "type": "string",
409                  "description": "The ISO 3166-1 alpha-2 country code of the country where the business operates"
410                }
411              },
412              "description": "The country and country code of the company"
413            }
414          },
415          "description": ""
416        }
417      }
418    }
419  }
420}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "WheelJack.797f1d88-f1a7-11ee-b6ea-debb6fb35f76"
5    ],
6    "name": "company",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712141209527,
10    "id": "xPc6LLIyH5FO3grgqrPAb4+AL+chQf4/yToehgQR9FE=",
11    "category": "company"
12  },
13  "company_id": 7186,
14  "contains": [
15    "company"
16  ],
17  "payload": {
18    "company": {
19      "_id": "660d339908dc8f964dbfd9e2",
20      "created_on": "2024-04-03T10:46:49.285851",
21      "modified_on": "2024-04-03T10:46:49.285857",
22      "created_by": {
23        "username": "admin_talkingsox_com_53765",
24        "user_id": "77b30e5ab43f62ce7e628a26"
25      },
26      "modified_by": {
27        "username": "admin_talkingsox_com_53765",
28        "user_id": "77b30e5ab43f62ce7e628a26"
29      },
30      "uid": 7186,
31      "name": "TALKING SOX PRIVATE LIMITED",
32      "addresses": [
33        {
34          "country": "INDIA",
35          "state": "DELHI",
36          "city": "EAST DELHI",
37          "pincode": 110096,
38          "address1": "dummy address",
39          "latitude": 19.0653252,
40          "longitude": 72.8423802,
41          "country_code": "IN",
42          "address_type": "office"
43        },
44        {
45          "country": "INDIA",
46          "state": "DELHI",
47          "city": "EAST DELHI",
48          "pincode": 110096,
49          "address1": "dummy address",
50          "latitude": 19.0653252,
51          "longitude": 72.8423802,
52          "country_code": "IN",
53          "address_type": "registered"
54        }
55      ],
56      "company_type": "mbo",
57      "stage": "complete",
58      "notification_emails": [
59        "[email protected]"
60      ],
61      "documents": [
62        {
63          "type": "pan",
64          "value": "xxxxxx",
65          "verified": true
66        }
67      ],
68      "business_country_info": {
69        "country": "India",
70        "country_code": "IN",
71        "currency": {
72          "code": "INR",
73          "symbol": "₹",
74          "name": "Indian Rupee"
75        },
76        "timezone": "Asia/Kolkata"
77      },
78      "franchise_enabled": false,
79      "warnings": {},
80      "marketplaces": [
81        "Ajio"
82      ],
83      "mode": "live"
84    }
85  }
86}

company/company/update/v1

this event is triggered when company is updated

Payload
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
id
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
company
object
Required
Properties
_id
string
The unique identifier of the company
uid
integer
Required
The user ID associated with the company
mode
Undefined Type
The mode of the company
Enum
name
string
The name of the company
stage
string
Required
The stage of the company
taxes
array of object
The list of taxes associated with the company.
Array of Properties
rate
number
The rate value.
enable
boolean
A boolean value indicating whether the rate is enabled or not.
effective_date
string
The effective date of the rate.
domain
string
The domain associated with the company
warnings
object
The warnings associated with the company ( can contain any key value pair )
addresses
array of object
The list of addresses associated with the company.
Array of Properties
city
string
Required
The city of the address.
state
string
Required
The state of the address.
country
string
Required
The country of the address.
pincode
integer
Required
The pincode of the address.
address1
string
Required
The first line of the address.
address2
string
The second line of the address.
landmark
string
The landmark near the address.
latitude
number
Required
The latitude of the address.
longitude
number
Required
The longitude of the address.
address_type
string
The type of address.
country_code
string
The country code of the address.
documents
array of object
The list of documents associated with the company
Array of Properties
url
string
The URL of the document.
type
string
Required
The type of the document.
value
string
Required
The value of the document.
verified
boolean
Indicates whether the document is verified.
legal_name
string
The legal name associated with the document.
created_by
object
The user who created the company
Properties
user_id
string
Required
User ID of the user who created the company
username
string
Required
Username of the user who created the company
created_on
string
The date and time when the company was created
modified_by
object
Required
The user who last modified the company.
Properties
user_id
string
Required
User ID of the user who last modified the company
username
string
Required
Username of the user who last modified the company
modified_on
string
Required
The date and time when the company was last modified
verified_by
object
The user who verified the brand.
Properties
user_id
string
Required
User ID of the user who verified the company
username
string
Required
Username of the user who verified the company
verified_on
string
The date and time when the company was verified
_custom_json
object
Custom JSON data associated with the company
company_type
string
The type of the company
marketplaces
array of string
The list of marketplaces associated with the company
business_info
string
The business information of the company
business_type
string
The business type of the company
referral_info
object
The referral information associated with the company
Properties
referral_code
string
Referral code for the user
reject_reason
string
The reason why the company was rejected
contact_details
object
The contact details associated with the company
Properties
phone
array of object
List of phone numbers.
Array of Properties
number
string
Required
country_code
integer
Required
emails
array of string
List of email addresses.
business_details
object
Additional business details
Properties
website
object
Required
Details about the website of the business.
Properties
url
string
The URL of the website.
franchise_enabled
boolean
Whether the company is a franchise
notification_emails
array of string
The list of email addresses for notifications
business_country_info
object
The country and country code of the company
Properties
country
string
The name of the country where the business operates
country_code
string
The ISO 3166-1 alpha-2 country code of the country where the business operates
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      "required": [
69        "company"
70      ],
71      "properties": {
72        "company": {
73          "type": "object",
74          "required": [
75            "uid",
76            "modified_by",
77            "modified_on",
78            "stage"
79          ],
80          "properties": {
81            "_id": {
82              "type": "string",
83              "description": "The unique identifier of the company"
84            },
85            "uid": {
86              "type": "integer",
87              "description": "The user ID associated with the company"
88            },
89            "mode": {
90              "enum": [
91                "live",
92                "development"
93              ],
94              "description": "The mode of the company"
95            },
96            "name": {
97              "type": "string",
98              "description": "The name of the company"
99            },
100            "stage": {
101              "type": "string",
102              "description": "The stage of the company"
103            },
104            "taxes": {
105              "type": "array",
106              "items": {
107                "type": "object",
108                "required": [],
109                "properties": {
110                  "rate": {
111                    "type": "number",
112                    "description": "The rate value."
113                  },
114                  "enable": {
115                    "type": "boolean",
116                    "description": "A boolean value indicating whether the rate is enabled or not."
117                  },
118                  "effective_date": {
119                    "type": "string",
120                    "description": "The effective date of the rate."
121                  }
122                }
123              },
124              "description": "The list of taxes associated with the company."
125            },
126            "domain": {
127              "type": "string",
128              "description": "The domain associated with the company"
129            },
130            "warnings": {
131              "type": "object",
132              "description": "The warnings associated with the company ( can contain any key value pair )"
133            },
134            "addresses": {
135              "type": "array",
136              "items": {
137                "type": "object",
138                "required": [
139                  "country",
140                  "state",
141                  "city",
142                  "pincode",
143                  "address1",
144                  "latitude",
145                  "longitude"
146                ],
147                "properties": {
148                  "city": {
149                    "type": "string",
150                    "description": "The city of the address."
151                  },
152                  "state": {
153                    "type": "string",
154                    "description": "The state of the address."
155                  },
156                  "country": {
157                    "type": "string",
158                    "description": "The country of the address."
159                  },
160                  "pincode": {
161                    "type": "integer",
162                    "description": "The pincode of the address."
163                  },
164                  "address1": {
165                    "type": "string",
166                    "description": "The first line of the address."
167                  },
168                  "address2": {
169                    "type": "string",
170                    "description": "The second line of the address."
171                  },
172                  "landmark": {
173                    "type": "string",
174                    "description": "The landmark near the address."
175                  },
176                  "latitude": {
177                    "type": "number",
178                    "description": "The latitude of the address."
179                  },
180                  "longitude": {
181                    "type": "number",
182                    "description": "The longitude of the address."
183                  },
184                  "address_type": {
185                    "type": "string",
186                    "description": "The type of address."
187                  },
188                  "country_code": {
189                    "type": "string",
190                    "description": "The country code of the address."
191                  }
192                }
193              },
194              "description": "The list of addresses associated with the company."
195            },
196            "documents": {
197              "type": "array",
198              "items": {
199                "type": "object",
200                "required": [
201                  "type",
202                  "value"
203                ],
204                "properties": {
205                  "url": {
206                    "type": "string",
207                    "description": "The URL of the document."
208                  },
209                  "type": {
210                    "type": "string",
211                    "description": "The type of the document."
212                  },
213                  "value": {
214                    "type": "string",
215                    "description": "The value of the document."
216                  },
217                  "verified": {
218                    "type": "boolean",
219                    "description": "Indicates whether the document is verified."
220                  },
221                  "legal_name": {
222                    "type": "string",
223                    "description": "The legal name associated with the document."
224                  }
225                }
226              },
227              "description": "The list of documents associated with the company"
228            },
229            "created_by": {
230              "type": "object",
231              "required": [
232                "user_id",
233                "username"
234              ],
235              "properties": {
236                "user_id": {
237                  "type": "string",
238                  "description": "User ID of the user who created the company"
239                },
240                "username": {
241                  "type": "string",
242                  "description": "Username of the user who created the company"
243                }
244              },
245              "description": "The user who created the company"
246            },
247            "created_on": {
248              "type": "string",
249              "description": "The date and time when the company was created"
250            },
251            "modified_by": {
252              "type": "object",
253              "required": [
254                "user_id",
255                "username"
256              ],
257              "properties": {
258                "user_id": {
259                  "type": "string",
260                  "description": "User ID of the user who last modified the company"
261                },
262                "username": {
263                  "type": "string",
264                  "description": "Username of the user who last modified the company"
265                }
266              },
267              "description": "The user who last modified the company."
268            },
269            "modified_on": {
270              "type": "string",
271              "description": "The date and time when the company was last modified"
272            },
273            "verified_by": {
274              "type": "object",
275              "required": [
276                "user_id",
277                "username"
278              ],
279              "properties": {
280                "user_id": {
281                  "type": "string",
282                  "description": "User ID of the user who verified the company"
283                },
284                "username": {
285                  "type": "string",
286                  "description": "Username of the user who verified the company"
287                }
288              },
289              "description": "The user who verified the brand."
290            },
291            "verified_on": {
292              "type": "string",
293              "description": "The date and time when the company was verified"
294            },
295            "_custom_json": {
296              "type": "object",
297              "description": "Custom JSON data associated with the company"
298            },
299            "company_type": {
300              "type": "string",
301              "description": "The type of the company"
302            },
303            "marketplaces": {
304              "type": "array",
305              "items": {
306                "type": "string"
307              },
308              "description": "The list of marketplaces associated with the company"
309            },
310            "business_info": {
311              "type": "string",
312              "description": "The business information of the company"
313            },
314            "business_type": {
315              "type": "string",
316              "description": "The business type of the company"
317            },
318            "referral_info": {
319              "type": "object",
320              "required": [],
321              "properties": {
322                "referral_code": {
323                  "type": "string",
324                  "description": "Referral code for the user"
325                }
326              },
327              "description": "The referral information associated with the company"
328            },
329            "reject_reason": {
330              "type": "string",
331              "description": "The reason why the company was rejected"
332            },
333            "contact_details": {
334              "type": "object",
335              "required": [],
336              "properties": {
337                "phone": {
338                  "type": "array",
339                  "items": {
340                    "type": "object",
341                    "required": [
342                      "number",
343                      "country_code"
344                    ],
345                    "properties": {
346                      "number": {
347                        "type": "string"
348                      },
349                      "country_code": {
350                        "type": "integer"
351                      }
352                    }
353                  },
354                  "description": "List of phone numbers."
355                },
356                "emails": {
357                  "type": "array",
358                  "items": {
359                    "type": "string"
360                  },
361                  "description": "List of email addresses."
362                }
363              },
364              "description": "The contact details associated with the company"
365            },
366            "business_details": {
367              "type": "object",
368              "required": [
369                "website"
370              ],
371              "properties": {
372                "website": {
373                  "type": "object",
374                  "required": [],
375                  "properties": {
376                    "url": {
377                      "type": "string",
378                      "description": "The URL of the website."
379                    }
380                  },
381                  "description": "Details about the website of the business."
382                }
383              },
384              "description": "Additional business details"
385            },
386            "franchise_enabled": {
387              "type": "boolean",
388              "description": "Whether the company is a franchise"
389            },
390            "notification_emails": {
391              "type": "array",
392              "items": {
393                "type": "string"
394              },
395              "description": "The list of email addresses for notifications"
396            },
397            "business_country_info": {
398              "type": "object",
399              "required": [],
400              "properties": {
401                "country": {
402                  "type": "string",
403                  "description": "The name of the country where the business operates"
404                },
405                "country_code": {
406                  "type": "string",
407                  "description": "The ISO 3166-1 alpha-2 country code of the country where the business operates"
408                }
409              },
410              "description": "The country and country code of the company"
411            }
412          },
413          "description": ""
414        }
415      }
416    }
417  }
418}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "WheelJack.7a9e835c-f1a7-11ee-bfd0-8e34926824aa"
5    ],
6    "name": "company",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712141211410,
10    "id": "/xQ2OXxIcI7BEDB6N2Pg0RAxuB5JQXSNn9V/FpsPju4=",
11    "category": "company"
12  },
13  "company_id": 7186,
14  "contains": [
15    "company"
16  ],
17  "payload": {
18    "company": {
19      "_id": "660d339908dc8f964dbfd9e2",
20      "created_on": "2024-04-03T10:46:49.285000",
21      "modified_on": "2024-04-03T10:46:49.285000",
22      "verified_on": "2024-04-03T10:46:50.756214",
23      "created_by": {
24        "username": "admin_talkingsox_com_53765",
25        "user_id": "77b30e5ab43f62ce7e628a26"
26      },
27      "modified_by": {
28        "username": "admin_talkingsox_com_53765",
29        "user_id": "77b30e5ab43f62ce7e628a26"
30      },
31      "verified_by": {
32        "username": "WheelJack",
33        "user_id": "0"
34      },
35      "uid": 7186,
36      "name": "TALKING SOX PRIVATE LIMITED",
37      "addresses": [
38        {
39          "country": "INDIA",
40          "state": "DELHI",
41          "city": "EAST DELHI",
42          "pincode": 110096,
43          "address1": "dummy address",
44          "latitude": 19.0653252,
45          "longitude": 72.8423802,
46          "country_code": "IN",
47          "address_type": "office"
48        },
49        {
50          "country": "INDIA",
51          "state": "DELHI",
52          "city": "EAST DELHI",
53          "pincode": 110096,
54          "address1": "dummy address",
55          "latitude": 19.0653252,
56          "longitude": 72.8423802,
57          "country_code": "IN",
58          "address_type": "registered"
59        }
60      ],
61      "company_type": "mbo",
62      "stage": "verified",
63      "notification_emails": [
64        "[email protected]"
65      ],
66      "documents": [
67        {
68          "type": "pan",
69          "value": "XXXXXXXX",
70          "verified": true
71        }
72      ],
73      "business_country_info": {
74        "country": "India",
75        "country_code": "IN",
76        "currency": {
77          "code": "INR",
78          "symbol": "₹",
79          "name": "Indian Rupee"
80        },
81        "timezone": "Asia/Kolkata"
82      },
83      "franchise_enabled": false,
84      "warnings": {},
85      "marketplaces": [
86        "Ajio"
87      ],
88      "mode": "live"
89    }
90  }
91}

Courier partner

This event will be generated where there is any action done on courier-partner

Events
company/courier-partner/account-status/v1
# this event is triggered when courier-partner is account-statused

company/courier-partner/account-status/v1

this event is triggered when courier-partner is account-statused

Payload
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
id
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
courier-partner
object
Required
Object containing the details for the courier partner including accouunt_id, extension id and such.
Properties
stage
string
Required
A string indicating current stage of account
scheme_id
string
Required
unique id of scheme
account_id
string
Required
unique id of account
extension_id
string
Required
extension api key
is_own_account
boolean
Required
Indicates whether the account belongs to the seller
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      "required": [
69        "courier-partner"
70      ],
71      "properties": {
72        "courier-partner": {
73          "type": "object",
74          "description": "Object containing the details for the courier partner including accouunt_id, extension id and such.",
75          "required": [
76            "extension_id",
77            "scheme_id",
78            "account_id",
79            "stage",
80            "is_own_account"
81          ],
82          "properties": {
83            "stage": {
84              "type": "string",
85              "description": "A string indicating current stage of account"
86            },
87            "scheme_id": {
88              "type": "string",
89              "description": "unique id of scheme"
90            },
91            "account_id": {
92              "type": "string",
93              "description": "unique id of account"
94            },
95            "extension_id": {
96              "type": "string",
97              "description": "extension api key"
98            },
99            "is_own_account": {
100              "type": "boolean",
101              "description": "Indicates whether the account belongs to the seller"
102            }
103          }
104        }
105      }
106    }
107  }
108}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "830da154-da02-40be-b062-580c52978885"
5    ],
6    "name": "courier-partner",
7    "type": "account-status",
8    "version": "1",
9    "created_timestamp": 1712041565,
10    "id": "WPITfT3LYD9cGByJjPbRLzDsJI8Z9JYXcTzzHfdtUfU=",
11    "category": "company"
12  },
13  "company_id": 327,
14  "contains": [
15    "courier-partner"
16  ],
17  "payload": {
18    "courier-partner": {
19      "extension_id": "656f1f18c24dabc79325b1ba",
20      "scheme_id": "65952a7b199ac0fd9537b1a7",
21      "account_id": "65a69abfbae4d80f1f4294ca",
22      "stage": "disabled",
23      "is_own_account": false
24    }
25  }
26}

Customfield definition

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

Events
company/customfield_definition/create/v1
# This event is triggered when a customfield definition is created
company/customfield_definition/delete/v1
# This event is triggered when a customfield definition is deleted
company/customfield_definition/update/v1
# This event is triggered when a customfield definition is updated

company/customfield_definition/create/v1

This event is triggered when a customfield definition is created

Payload
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
id
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
slug
string
Required
A unique identifier for the custom fields definition. Its required and will not be modified once created.
namespace
string
Required
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.
name
string
Required
Name of the custom fields. Its editable.
description
string
This is description about the custom field definition.
id
string
Required
Uniquely generated mongoId of custom field definition and its not editable.
type
string
Required
This is field_type of the custom field definition. Its non-editable
is_deleted
boolean
This indicates that this custom fields definition is deleted or not.
validations
array of Undefined Type
Validations array have supported validations for the custom field definition
multi_value
boolean
Required
This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value.
resource
string
Required
Resource indicate that this custom field is assosiated with this resource.This is non-editable
company_id
string
Required
This is company id where this custom fields created.
updated_by
string
The last user that edited this definition
required
boolean
This indicates whether the field is required or not
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        "slug": {
70          "type": "string",
71          "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
72        },
73        "namespace": {
74          "type": "string",
75          "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."
76        },
77        "name": {
78          "type": "string",
79          "description": "Name of the custom fields. Its editable."
80        },
81        "description": {
82          "type": "string",
83          "description": "This is description about the custom field definition."
84        },
85        "id": {
86          "type": "string",
87          "description": "Uniquely generated mongoId of custom field definition and its not editable."
88        },
89        "type": {
90          "type": "string",
91          "description": "This is field_type of the custom field definition. Its non-editable"
92        },
93        "is_deleted": {
94          "type": "boolean",
95          "description": "This indicates that this custom fields definition is deleted or not."
96        },
97        "validations": {
98          "type": "array",
99          "items": {},
100          "description": "Validations array have supported validations for the custom field definition"
101        },
102        "multi_value": {
103          "type": "boolean",
104          "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
105        },
106        "resource": {
107          "type": "string",
108          "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
109        },
110        "company_id": {
111          "type": "string",
112          "description": "This is company id where this custom fields created."
113        },
114        "updated_by": {
115          "type": "string",
116          "description": "The last user that edited this definition"
117        },
118        "required": {
119          "type": "boolean",
120          "description": "This indicates whether the field is required or not"
121        }
122      },
123      "required": [
124        "slug",
125        "namespace",
126        "name",
127        "type",
128        "id",
129        "multi_value",
130        "resource",
131        "company_id"
132      ]
133    }
134  }
135}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.d1c35cc8-57b7-43a6-9453-0129ab7242c0"
5    ],
6    "name": "customfield_definition",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712488632605,
10    "id": "dysGEBnlnRD6purMmL9tCi5ZN4Y78kjBxb7PUjN3O+o=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26518,
15  "contains": [
16    "resource",
17    "name",
18    "namespace",
19    "description",
20    "slug",
21    "type",
22    "multi_value",
23    "validations",
24    "company_id",
25    "required",
26    "is_deleted",
27    "id"
28  ],
29  "payload": {
30    "resource": "product",
31    "name": "pmwza",
32    "namespace": "ajddn",
33    "slug": "nfcnt",
34    "description": "kndnetfqozowndcsnsqsedjln",
35    "type": "string_single_line",
36    "multi_value": false,
37    "validations": [
38      {
39        "name": "min",
40        "type": "integer",
41        "value": 5
42      },
43      {
44        "name": "max",
45        "type": "integer",
46        "value": 6
47      }
48    ],
49    "company_id": "26518",
50    "required": false,
51    "is_deleted": false,
52    "id": "661280b811eefc90fd21fbb5"
53  }
54}

company/customfield_definition/delete/v1

This event is triggered when a customfield definition is deleted

Payload
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
id
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
slug
string
Required
A unique identifier for the custom fields definition. Its required and will not be modified once created.
namespace
string
Required
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.
name
string
Required
Name of the custom fields. Its editable.
description
string
This is description about the custom field definition.
id
string
Required
Uniquely generated mongoId of custom field definition and its not editable.
type
string
Required
This is field_type of the custom field definition. Its non-editable
is_deleted
boolean
Required
This indicates that this custom fields definition is deleted or not.
validations
array of Undefined Type
Validations array have supported validations for the custom field definition
multi_value
boolean
Required
This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value.
resource
string
Required
Resource indicate that this custom field is assosiated with this resource.This is non-editable
company_id
string
Required
This is company id where this custom fields created.
required
boolean
This indicates whether the field is required or not
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        "slug": {
70          "type": "string",
71          "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
72        },
73        "namespace": {
74          "type": "string",
75          "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."
76        },
77        "name": {
78          "type": "string",
79          "description": "Name of the custom fields. Its editable."
80        },
81        "description": {
82          "type": "string",
83          "description": "This is description about the custom field definition."
84        },
85        "id": {
86          "type": "string",
87          "description": "Uniquely generated mongoId of custom field definition and its not editable."
88        },
89        "type": {
90          "type": "string",
91          "description": "This is field_type of the custom field definition. Its non-editable"
92        },
93        "is_deleted": {
94          "type": "boolean",
95          "description": "This indicates that this custom fields definition is deleted or not."
96        },
97        "validations": {
98          "type": "array",
99          "items": {},
100          "description": "Validations array have supported validations for the custom field definition"
101        },
102        "multi_value": {
103          "type": "boolean",
104          "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
105        },
106        "resource": {
107          "type": "string",
108          "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
109        },
110        "company_id": {
111          "type": "string",
112          "description": "This is company id where this custom fields created."
113        },
114        "required": {
115          "type": "boolean",
116          "description": "This indicates whether the field is required or not"
117        }
118      },
119      "required": [
120        "slug",
121        "namespace",
122        "name",
123        "type",
124        "id",
125        "is_deleted",
126        "multi_value",
127        "resource",
128        "company_id"
129      ]
130    }
131  }
132}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.61dece8c-e8c9-43d0-af29-5d1d3daeef2c"
5    ],
6    "name": "customfield_definition",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712488634113,
10    "id": "+puowDa2Lp6dTntMMjNw4PUBKpJ4FsmynQEYporGxbY=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26518,
15  "contains": [
16    "id",
17    "resource",
18    "name",
19    "namespace",
20    "slug",
21    "description",
22    "type",
23    "multi_value",
24    "validations",
25    "company_id",
26    "required",
27    "is_deleted"
28  ],
29  "payload": {
30    "id": "661280b811eefc90fd21fbb5",
31    "resource": "product",
32    "name": "sicoenvqeu",
33    "namespace": "ajddn",
34    "slug": "nfcnt",
35    "description": "ljicgwvaypelmjhmjomhuwvzf",
36    "type": "string_single_line",
37    "multi_value": false,
38    "validations": [
39      {
40        "name": "min",
41        "type": "integer",
42        "value": 5
43      },
44      {
45        "name": "max",
46        "type": "integer",
47        "value": 6
48      }
49    ],
50    "company_id": "26518",
51    "required": false,
52    "is_deleted": true
53  }
54}

company/customfield_definition/update/v1

This event is triggered when a customfield definition is updated

Payload
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
id
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
slug
string
Required
A unique identifier for the custom fields definition. Its required and will not be modified once created.
namespace
string
Required
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.
name
string
Required
Name of the custom fields. Its editable.
description
string
This is description about the custom field definition.
id
string
Required
Uniquely generated mongoId of custom field definition and its not editable.
type
string
Required
This is field_type of the custom field definition. Its non-editable
is_deleted
boolean
This indicates that this custom fields definition is deleted or not.
validations
array of Undefined Type
Validations array have supported validations for the custom field definition
multi_value
boolean
Required
This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value.
resource
string
Required
Resource indicate that this custom field is assosiated with this resource.This is non-editable
company_id
string
Required
This is company id where this custom fields created.
required
boolean
This indicates whether the field is required or not
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        "slug": {
70          "type": "string",
71          "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
72        },
73        "namespace": {
74          "type": "string",
75          "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."
76        },
77        "name": {
78          "type": "string",
79          "description": "Name of the custom fields. Its editable."
80        },
81        "description": {
82          "type": "string",
83          "description": "This is description about the custom field definition."
84        },
85        "id": {
86          "type": "string",
87          "description": "Uniquely generated mongoId of custom field definition and its not editable."
88        },
89        "type": {
90          "type": "string",
91          "description": "This is field_type of the custom field definition. Its non-editable"
92        },
93        "is_deleted": {
94          "type": "boolean",
95          "description": "This indicates that this custom fields definition is deleted or not."
96        },
97        "validations": {
98          "type": "array",
99          "items": {},
100          "description": "Validations array have supported validations for the custom field definition"
101        },
102        "multi_value": {
103          "type": "boolean",
104          "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
105        },
106        "resource": {
107          "type": "string",
108          "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
109        },
110        "company_id": {
111          "type": "string",
112          "description": "This is company id where this custom fields created."
113        },
114        "required": {
115          "type": "boolean",
116          "description": "This indicates whether the field is required or not"
117        }
118      },
119      "required": [
120        "slug",
121        "namespace",
122        "name",
123        "type",
124        "id",
125        "multi_value",
126        "resource",
127        "company_id"
128      ]
129    }
130  }
131}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.72bfcadf-a2f9-4aa8-9ebb-0e7dc0036520"
5    ],
6    "name": "customfield_definition",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712488632881,
10    "id": "bL8DS0iVxJAWexpE+BNCaSkhGFkmZzh/FsBHMbWl2Kw=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26518,
15  "contains": [
16    "id",
17    "resource",
18    "name",
19    "namespace",
20    "slug",
21    "description",
22    "type",
23    "multi_value",
24    "validations",
25    "company_id",
26    "required",
27    "is_deleted"
28  ],
29  "payload": {
30    "id": "661280b811eefc90fd21fbb5",
31    "resource": "product",
32    "name": "sicoenvqeu",
33    "namespace": "ajddn",
34    "slug": "nfcnt",
35    "description": "ljicgwvaypelmjhmjomhuwvzf",
36    "type": "string_single_line",
37    "multi_value": false,
38    "validations": [
39      {
40        "name": "min",
41        "type": "integer",
42        "value": 5
43      },
44      {
45        "name": "max",
46        "type": "integer",
47        "value": 6
48      }
49    ],
50    "company_id": "26518",
51    "required": false,
52    "is_deleted": false
53  }
54}

Customfields

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

Events
company/customfields/inventory-delete/v1
# This event is triggered when a custom field from inventory is deleted
company/customfields/inventory-update/v1
# This event is triggered when a custom field from inventory is updated
company/customfields/product-delete/v1
# This event is triggered when a custom field from product is deleted
company/customfields/product-update/v1
# This event is triggered when a custom field from product is updated
company/customfields/product-size-delete/v1
# This event is triggered when a custom field from product size is deleted
company/customfields/product-size-update/v1
# This event is triggered when a custom field from product size is updated
company/customfields/selling-location-update/v1
# This event is triggered when a custom field from selling location is updated

company/customfields/inventory-delete/v1

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

Payload
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
id
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 object
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                "json",
105                "file",
106                "url",
107                "metaobject",
108                "product"
109              ]
110            },
111            "multi_value": {
112              "type": "boolean",
113              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
114            },
115            "company_id": {
116              "type": "string",
117              "description": "This is company id where this custom fields created."
118            },
119            "value": {
120              "type": "array",
121              "items": {
122                "type": [
123                  "string",
124                  "number",
125                  "object",
126                  "boolean"
127                ]
128              },
129              "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."
130            }
131          },
132          "required": [
133            "id",
134            "namespace",
135            "slug",
136            "resource",
137            "resource_slug",
138            "type",
139            "multi_value",
140            "company_id",
141            "value"
142          ]
143        }
144      ]
145    }
146  }
147}
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}

company/customfields/inventory-update/v1

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

Payload
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
id
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 object
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                "json",
105                "file",
106                "url",
107                "metaobject",
108                "product"
109              ]
110            },
111            "multi_value": {
112              "type": "boolean",
113              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
114            },
115            "company_id": {
116              "type": "string",
117              "description": "This is company id where this custom fields created."
118            },
119            "value": {
120              "type": "array",
121              "items": {
122                "type": [
123                  "string",
124                  "number",
125                  "object",
126                  "boolean"
127                ]
128              },
129              "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."
130            }
131          },
132          "required": [
133            "id",
134            "namespace",
135            "slug",
136            "resource",
137            "resource_slug",
138            "type",
139            "multi_value",
140            "company_id",
141            "value"
142          ]
143        }
144      ]
145    }
146  }
147}
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}

company/customfields/product-delete/v1

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

Payload
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
id
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 object
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                "json",
105                "file",
106                "url",
107                "metaobject",
108                "product"
109              ]
110            },
111            "multi_value": {
112              "type": "boolean",
113              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
114            },
115            "company_id": {
116              "type": "string",
117              "description": "This is company id where this custom fields created."
118            },
119            "value": {
120              "type": "array",
121              "items": {
122                "type": [
123                  "string",
124                  "number",
125                  "object",
126                  "boolean"
127                ]
128              },
129              "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."
130            }
131          },
132          "required": [
133            "id",
134            "namespace",
135            "slug",
136            "resource",
137            "resource_slug",
138            "type",
139            "multi_value",
140            "company_id",
141            "value"
142          ]
143        }
144      ]
145    }
146  }
147}
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}

company/customfields/product-update/v1

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

Payload
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
id
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 object
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                "json",
105                "file",
106                "url",
107                "metaobject",
108                "product"
109              ]
110            },
111            "multi_value": {
112              "type": "boolean",
113              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
114            },
115            "company_id": {
116              "type": "string",
117              "description": "This is company id where this custom fields created."
118            },
119            "value": {
120              "type": "array",
121              "items": {
122                "type": [
123                  "string",
124                  "number",
125                  "object",
126                  "boolean"
127                ]
128              },
129              "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."
130            }
131          },
132          "required": [
133            "id",
134            "namespace",
135            "slug",
136            "resource",
137            "resource_slug",
138            "type",
139            "multi_value",
140            "company_id",
141            "value"
142          ]
143        }
144      ]
145    }
146  }
147}
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}

company/customfields/product-size-delete/v1

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

Payload
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
id
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                "json",
105                "file",
106                "url",
107                "metaobject",
108                "product"
109              ]
110            },
111            "multi_value": {
112              "type": "boolean",
113              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
114            },
115            "company_id": {
116              "type": "string",
117              "description": "This is company id where this custom fields created."
118            },
119            "value": {
120              "type": "array",
121              "items": {
122                "type": [
123                  "string",
124                  "number",
125                  "object",
126                  "boolean"
127                ]
128              },
129              "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."
130            }
131          },
132          "required": [
133            "id",
134            "namespace",
135            "slug",
136            "resource",
137            "resource_slug",
138            "type",
139            "multi_value",
140            "company_id",
141            "value"
142          ]
143        }
144      ]
145    }
146  }
147}
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}

company/customfields/product-size-update/v1

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

Payload
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
id
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                "json",
105                "file",
106                "url",
107                "metaobject",
108                "product"
109              ]
110            },
111            "multi_value": {
112              "type": "boolean",
113              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
114            },
115            "company_id": {
116              "type": "string",
117              "description": "This is company id where this custom fields created."
118            },
119            "value": {
120              "type": "array",
121              "items": {
122                "type": [
123                  "string",
124                  "number",
125                  "object",
126                  "boolean"
127                ]
128              },
129              "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."
130            }
131          },
132          "required": [
133            "id",
134            "namespace",
135            "slug",
136            "resource",
137            "resource_slug",
138            "type",
139            "multi_value",
140            "company_id",
141            "value"
142          ]
143        }
144      ]
145    }
146  }
147}
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}

company/customfields/selling-location-update/v1

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

Payload
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
id
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 object
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                "json",
105                "file",
106                "url",
107                "metaobject",
108                "product"
109              ]
110            },
111            "multi_value": {
112              "type": "boolean",
113              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
114            },
115            "company_id": {
116              "type": "string",
117              "description": "This is company id where this custom fields created."
118            },
119            "value": {
120              "type": "array",
121              "items": {
122                "type": [
123                  "string",
124                  "number",
125                  "object",
126                  "boolean"
127                ]
128              },
129              "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."
130            }
131          },
132          "required": [
133            "id",
134            "namespace",
135            "slug",
136            "resource",
137            "resource_slug",
138            "type",
139            "multi_value",
140            "company_id",
141            "value"
142          ]
143        }
144      ]
145    }
146  }
147}
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}

Customobject definition

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

Events
company/customobject_definition/create/v1
# This event is triggered when customobject definition is created
company/customobject_definition/delete/v1
# This event is triggered when customobject definition is deleted"
company/customobject_definition/update/v1
# This event is triggered when customobject definition is updated

company/customobject_definition/create/v1

This event is triggered when customobject definition is created

Payload
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
id
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
id
string
Required
Uniquely generated mongoId of custom object definition and its not editable.
name
string
Required
Name is use for the custom object definition name
slug
string
Required
A unique identifier for the custom object definition. Its required and will not be modified once created.
field_definitions
array of Undefined Type
Required
This indicates all the custom field definitions part of the custom object
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 definition and its not editable."
72        },
73        "name": {
74          "type": "string",
75          "description": "Name is use for the custom object definition name"
76        },
77        "slug": {
78          "type": "string",
79          "description": "A unique identifier for the custom object definition. Its required and will not be modified once created."
80        },
81        "field_definitions": {
82          "type": "array",
83          "description": "This indicates all the custom field definitions part of the custom object",
84          "items": [
85            {
86              "type": "object",
87              "properties": {
88                "resource": {
89                  "type": "string",
90                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
91                },
92                "name": {
93                  "type": "string",
94                  "description": "Name of the custom fields. Its editable."
95                },
96                "namespace": {
97                  "type": "string",
98                  "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."
99                },
100                "slug": {
101                  "type": "string",
102                  "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
103                },
104                "type": {
105                  "type": "string",
106                  "description": "This is field_type of the custom field definition. Its non-editable"
107                },
108                "multi_value": {
109                  "type": "boolean",
110                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
111                },
112                "company_id": {
113                  "type": "string",
114                  "description": "This is company id where this custom fields created."
115                },
116                "required": {
117                  "type": "boolean",
118                  "description": "This indicates whether the field is required or not"
119                },
120                "is_deleted": {
121                  "type": "boolean",
122                  "description": "This indicates that this custom fields definition is deleted or not."
123                }
124              },
125              "required": [
126                "resource",
127                "name",
128                "slug",
129                "type",
130                "company_id"
131              ]
132            }
133          ]
134        }
135      },
136      "required": [
137        "id",
138        "name",
139        "slug",
140        "field_definitions"
141      ]
142    }
143  }
144}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.f00de8ea-426a-4c20-b786-c0fcce8689fb"
5    ],
6    "name": "customobject_definition",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1710313407546,
10    "id": "2+4TJIsF8RLLmR5718bbeaK3QT9c0mCPuNNt/WB3gF8=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 2,
15  "contains": [
16    "id",
17    "name",
18    "type",
19    "display_name_key",
20    "description",
21    "company_id",
22    "field_definitions"
23  ],
24  "payload": {
25    "id": "65f14fbf95ae139810b51b35",
26    "name": "testubg oibkject",
27    "slug": "testubg-oibkject",
28    "display_name_key": "name",
29    "description": "",
30    "company_id": "2",
31    "field_definitions": [
32      {
33        "resource": "metaobject",
34        "name": "name",
35        "namespace": "testubg-oibkject",
36        "slug": "name",
37        "description": "",
38        "type": "string_single_line",
39        "multi_value": false,
40        "validations": [],
41        "company_id": "2",
42        "required": false,
43        "is_deleted": false,
44        "id": "65f14fbf95ae139810b51b38"
45      },
46      {
47        "resource": "metaobject",
48        "name": "age",
49        "namespace": "testubg-oibkject",
50        "slug": "age",
51        "description": "",
52        "type": "string_single_line",
53        "multi_value": false,
54        "validations": [],
55        "company_id": "2",
56        "required": false,
57        "is_deleted": false,
58        "id": "65f14fbf95ae139810b51b39"
59      },
60      {
61        "resource": "metaobject",
62        "name": "mobile",
63        "namespace": "testubg-oibkject",
64        "slug": "mobile",
65        "description": "",
66        "type": "string_single_line",
67        "multi_value": false,
68        "validations": [],
69        "company_id": "2",
70        "required": false,
71        "is_deleted": false,
72        "id": "65f14fbf95ae139810b51b3a"
73      },
74      {
75        "resource": "metaobject",
76        "name": "p name",
77        "namespace": "testubg-oibkject",
78        "slug": "p-name",
79        "description": "",
80        "type": "string_single_line",
81        "multi_value": false,
82        "validations": [],
83        "company_id": "2",
84        "required": false,
85        "is_deleted": false,
86        "id": "65f14fbf95ae139810b51b3b"
87      }
88    ]
89  }
90}

company/customobject_definition/delete/v1

This event is triggered when customobject definition is deleted"

Payload
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
id
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
id
string
Required
Uniquely generated mongoId of custom object definition and its not editable.
name
string
Required
Name is use for the custom object definition name
slug
string
Required
A unique identifier for the custom object definition. Its required and will not be modified once created.
field_definitions
array of Undefined Type
Required
This indicates all the custom field definitions part of the custom object
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 definition and its not editable."
72        },
73        "name": {
74          "type": "string",
75          "description": "Name is use for the custom object definition name"
76        },
77        "slug": {
78          "type": "string",
79          "description": "A unique identifier for the custom object definition. Its required and will not be modified once created."
80        },
81        "field_definitions": {
82          "type": "array",
83          "description": "This indicates all the custom field definitions part of the custom object",
84          "items": [
85            {
86              "type": "object",
87              "properties": {
88                "resource": {
89                  "type": "string",
90                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
91                },
92                "name": {
93                  "type": "string",
94                  "description": "Name of the custom fields. Its editable."
95                },
96                "namespace": {
97                  "type": "string",
98                  "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."
99                },
100                "slug": {
101                  "type": "string",
102                  "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
103                },
104                "type": {
105                  "type": "string",
106                  "description": "This is field_type of the custom field definition. Its non-editable"
107                },
108                "multi_value": {
109                  "type": "boolean",
110                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
111                },
112                "company_id": {
113                  "type": "string",
114                  "description": "This is company id where this custom fields created."
115                },
116                "required": {
117                  "type": "boolean",
118                  "description": "This indicates whether the field is required or not"
119                },
120                "is_deleted": {
121                  "type": "boolean",
122                  "description": "This indicates that this custom fields definition is deleted or not."
123                }
124              },
125              "required": [
126                "resource",
127                "name",
128                "slug",
129                "type",
130                "company_id"
131              ]
132            }
133          ]
134        }
135      },
136      "required": [
137        "id",
138        "name",
139        "slug",
140        "field_definitions"
141      ]
142    }
143  }
144}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.24a0e0a8-9951-443c-b26f-1b2ffd6f3a0e"
5    ],
6    "name": "customobject_definition",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1709218134685,
10    "id": "lI2JDxvIxNFr/ahkmiASqjD6O6b4AAso1T8MH7QTEmk=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "contains": [
16    "id",
17    "name",
18    "slug",
19    "description",
20    "display_name_key",
21    "company_id",
22    "field_definitions",
23    "is_deleted"
24  ],
25  "payload": {
26    "id": "655c706ad5ff69fd3b95a1d9",
27    "name": "coCustomObject",
28    "slug": "cocustomobject",
29    "description": "",
30    "display_name_key": "coslt",
31    "company_id": "1",
32    "field_definitions": [
33      {
34        "id": "655c706ad5ff69fd3b95a1dd",
35        "resource": "metaobject",
36        "name": "coMLT",
37        "namespace": "cocustomobject",
38        "slug": "comlt",
39        "description": "custom object multi line text",
40        "type": "string_multi_line",
41        "multi_value": false,
42        "validations": [],
43        "company_id": "1",
44        "required": false,
45        "is_deleted": false
46      },
47      {
48        "id": "655c706ad5ff69fd3b95a1dc",
49        "resource": "metaobject",
50        "name": "coSLT",
51        "namespace": "cocustomobject",
52        "slugs": "coslt",
53        "description": "this is a custom object SLT",
54        "type": "string_single_line",
55        "multi_value": false,
56        "validations": [],
57        "company_id": "1",
58        "required": false,
59        "is_deleted": false
60      }
61    ],
62    "is_deleted": true
63  }
64}

company/customobject_definition/update/v1

This event is triggered when customobject definition is updated

Payload
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
id
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
id
string
Required
Uniquely generated mongoId of custom object definition and its not editable.
name
string
Required
Name is use for the custom object definition name
slug
string
Required
A unique identifier for the custom object definition. Its required and will not be modified once created.
field_definitions
array of Undefined Type
Required
This indicates all the custom field definitions part of the custom object
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 definition and its not editable."
72        },
73        "name": {
74          "type": "string",
75          "description": "Name is use for the custom object definition name"
76        },
77        "slug": {
78          "type": "string",
79          "description": "A unique identifier for the custom object definition. Its required and will not be modified once created."
80        },
81        "field_definitions": {
82          "type": "array",
83          "description": "This indicates all the custom field definitions part of the custom object",
84          "items": [
85            {
86              "type": "object",
87              "properties": {
88                "resource": {
89                  "type": "string",
90                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
91                },
92                "name": {
93                  "type": "string",
94                  "description": "Name of the custom fields. Its editable."
95                },
96                "namespace": {
97                  "type": "string",
98                  "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."
99                },
100                "slug": {
101                  "type": "string",
102                  "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
103                },
104                "type": {
105                  "type": "string",
106                  "description": "This is field_type of the custom field definition. Its non-editable"
107                },
108                "multi_value": {
109                  "type": "boolean",
110                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
111                },
112                "company_id": {
113                  "type": "string",
114                  "description": "This is company id where this custom fields created."
115                },
116                "required": {
117                  "type": "boolean",
118                  "description": "This indicates whether the field is required or not"
119                },
120                "is_deleted": {
121                  "type": "boolean",
122                  "description": "This indicates that this custom fields definition is deleted or not."
123                }
124              },
125              "required": [
126                "resource",
127                "name",
128                "slug",
129                "type",
130                "company_id"
131              ]
132            }
133          ]
134        }
135      },
136      "required": [
137        "id",
138        "name",
139        "slug",
140        "field_definitions"
141      ]
142    }
143  }
144}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.bb245540-b8be-4cba-a7c7-87c5fad817d0"
5    ],
6    "name": "customobject_definition",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1707717291057,
10    "id": "OMYai+tli6FE4357LlgYCy0QJDNeHrumddyzN9J8ims=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "contains": [
16    "id",
17    "name",
18    "slug",
19    "display_name_key",
20    "description",
21    "company_id",
22    "field_definitions"
23  ],
24  "payload": {
25    "id": "65b22d42ddb6c44d923e445f",
26    "name": "25 Jan Custom object 4",
27    "slug": "25-jan-custom-object-4",
28    "display_name_key": "",
29    "description": "25 Jan Custom object 4",
30    "company_id": "1",
31    "field_definitions": [
32      {
33        "resource": "metaobject",
34        "name": "25 Jan custom object created custom field 4",
35        "namespace": "25-jan-custom-object-4",
36        "slug": "25-jan-custom-object-created-custom-field-4",
37        "type": "integer",
38        "description": "",
39        "multi_value": false,
40        "validations": [],
41        "company_id": "1",
42        "required": false
43      }
44    ]
45  }
46}

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

company/customobjects/create/v1

This event is triggered when a custom object is created

Payload
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
id
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
id
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 object
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}

company/customobjects/update/v1

This event is triggered when a custom object is updated

Payload
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
id
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
id
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 object
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}

company/customobjects/delete/v1

This event is triggered when a custom object is deleted

Payload
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
id
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
id
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 object
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}

Location

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

Events
company/location/create/v1
# this event is triggered when location is created
company/location/update/v1
# this event is triggered when location is updated

company/location/create/v1

this event is triggered when location is created

Payload
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
id
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
location
object
Location Details.
Properties
product_return_config
object
Product return configuration for the location.
Properties
on_same_store
boolean
Whether return can be initiated at the same store.
contact_numbers
array of object
Contact numbers associated with the location.
Array of Properties
number
string
Contact number of the store.
country_code
integer
Country code for the contact number.
documents
array of
Documents associated with the location.
company
integer
Company associated with the location.
address
object
Address of the location.
Properties
address1
string
First line of the location address.
state
string
State or Province of the location address.
country_code
string
Country code of the location address.
city
string
City of the location address.
latitude
number
Latitude of the location address.
pincode
integer
Postal code of the location address.
longitude
number
Longitude of the location address.
country
string
Country of the location address.
manager
object
Manager of the location.
Properties
mobile_no
object
Mobile phone number of the location manager.
Properties
number
string
Phone number of the location manager.
country_code
integer
Country code for the mobile phone number of the location manager.
name
string
Name of the location manager.
email
string
Email address of the location manager.
avg_order_processing_time
object
Average order processing time for the location.
Properties
duration_type
string
Type of duration for the average order processing time.
duration
integer
Duration of the average order processing time.
gst_credentials
object
GST credentials for the location.
Properties
e_waybill
object
E-Waybill credentials for the location.
Properties
enabled
boolean
Flag indicating if E-Waybill is enabled for the location.
e_invoice
object
E-Invoice credentials for the location.
Properties
enabled
boolean
Flag indicating if E-Invoice is enabled for the location.
auto_assign_courier_partner
boolean
Flag indicating if auto-assignment of courier partner is enabled for the location.
auto_invoice
boolean
Flag indicating if auto invoice generation is enabled for the location.
modified_on
string
Timestamp for when the location was last modified.
created_by
object
User who created the location.
Properties
username
string
Username of the user who created the location.
user_id
string
User ID of the user who created the location.
timing
array of Undefined Type
Operational timings for the location.
name
string
Name of the location.
_id
string
Unique identifier for the location.
modified_by
object
User who last modified the location.
Properties
username
string
Username of the user who last modified the location.
user_id
string
User ID of the user who last modified the location.
uid
integer
Unique identifier for the location.
stage
string
Stage of the location.
display_name
string
Display name of the location.
credit_note
boolean
Flag indicating if credit note generation is enabled for the location.
code
string
Code for the location.
bulk_shipment
boolean
Flag indicating if bulk shipment is enabled for the location.
tags
array of
Tags associated with the location.
store_type
string
Type of the store.
created_on
string
Timestamp for when the location was created.
warnings
object
Warnings associated with the location.
order_acceptance_timing
array of object
Order acceptance timing for the location.
Array of Properties
open
boolean
weekday
string
closing
object
Properties
hour
integer
minute
integer
opening
object
Properties
hour
integer
minute
integer
default_order_acceptance_timing
boolean
Flag indicating if the default order acceptance timing is enabled for the location.
notification_emails
array of string
Email addresses for notifications related to the location.
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        "location": {
70          "type": "object",
71          "properties": {
72            "product_return_config": {
73              "type": "object",
74              "properties": {
75                "on_same_store": {
76                  "type": "boolean",
77                  "description": "Whether return can be initiated at the same store."
78                }
79              },
80              "description": "Product return configuration for the location."
81            },
82            "contact_numbers": {
83              "type": "array",
84              "items": {
85                "type": "object",
86                "properties": {
87                  "number": {
88                    "type": "string",
89                    "description": "Contact number of the store."
90                  },
91                  "country_code": {
92                    "type": "integer",
93                    "description": "Country code for the contact number."
94                  }
95                }
96              },
97              "description": "Contact numbers associated with the location."
98            },
99            "documents": {
100              "type": "array",
101              "description": "Documents associated with the location."
102            },
103            "company": {
104              "type": "integer",
105              "description": "Company associated with the location."
106            },
107            "address": {
108              "type": "object",
109              "properties": {
110                "address1": {
111                  "type": "string",
112                  "description": "First line of the location address."
113                },
114                "state": {
115                  "type": "string",
116                  "description": "State or Province of the location address."
117                },
118                "country_code": {
119                  "type": "string",
120                  "description": "Country code of the location address."
121                },
122                "city": {
123                  "type": "string",
124                  "description": "City of the location address."
125                },
126                "latitude": {
127                  "type": "number",
128                  "description": "Latitude of the location address."
129                },
130                "pincode": {
131                  "type": "integer",
132                  "description": "Postal code of the location address."
133                },
134                "longitude": {
135                  "type": "number",
136                  "description": "Longitude of the location address."
137                },
138                "country": {
139                  "type": "string",
140                  "description": "Country of the location address."
141                }
142              },
143              "description": "Address of the location."
144            },
145            "manager": {
146              "type": "object",
147              "properties": {
148                "mobile_no": {
149                  "type": "object",
150                  "properties": {
151                    "number": {
152                      "type": "string",
153                      "description": "Phone number of the location manager."
154                    },
155                    "country_code": {
156                      "type": "integer",
157                      "description": "Country code for the mobile phone number of the location manager."
158                    }
159                  },
160                  "description": "Mobile phone number of the location manager."
161                },
162                "name": {
163                  "type": "string",
164                  "description": "Name of the location manager."
165                },
166                "email": {
167                  "type": "string",
168                  "description": "Email address of the location manager."
169                }
170              },
171              "description": "Manager of the location."
172            },
173            "avg_order_processing_time": {
174              "type": "object",
175              "properties": {
176                "duration_type": {
177                  "type": "string",
178                  "description": "Type of duration for the average order processing time."
179                },
180                "duration": {
181                  "type": "integer",
182                  "description": "Duration of the average order processing time."
183                }
184              },
185              "description": "Average order processing time for the location."
186            },
187            "gst_credentials": {
188              "type": "object",
189              "properties": {
190                "e_waybill": {
191                  "type": "object",
192                  "properties": {
193                    "enabled": {
194                      "type": "boolean",
195                      "description": "Flag indicating if E-Waybill is enabled for the location."
196                    }
197                  },
198                  "description": "E-Waybill credentials for the location."
199                },
200                "e_invoice": {
201                  "type": "object",
202                  "properties": {
203                    "enabled": {
204                      "type": "boolean",
205                      "description": "Flag indicating if E-Invoice is enabled for the location."
206                    }
207                  },
208                  "description": "E-Invoice credentials for the location."
209                }
210              },
211              "description": "GST credentials for the location."
212            },
213            "auto_assign_courier_partner": {
214              "type": "boolean",
215              "description": "Flag indicating if auto-assignment of courier partner is enabled for the location."
216            },
217            "auto_invoice": {
218              "type": "boolean",
219              "description": "Flag indicating if auto invoice generation is enabled for the location."
220            },
221            "modified_on": {
222              "type": "string",
223              "description": "Timestamp for when the location was last modified."
224            },
225            "created_by": {
226              "type": "object",
227              "properties": {
228                "username": {
229                  "type": "string",
230                  "description": "Username of the user who created the location."
231                },
232                "user_id": {
233                  "type": "string",
234                  "description": "User ID of the user who created the location."
235                }
236              },
237              "description": "User who created the location."
238            },
239            "timing": {
240              "type": "array",
241              "items": [
242                {
243                  "type": "object",
244                  "properties": {
245                    "open": {
246                      "type": "boolean"
247                    },
248                    "weekday": {
249                      "type": "string"
250                    },
251                    "closing": {
252                      "type": "object",
253                      "properties": {
254                        "hour": {
255                          "type": "integer"
256                        },
257                        "minute": {
258                          "type": "integer"
259                        }
260                      }
261                    },
262                    "opening": {
263                      "type": "object",
264                      "properties": {
265                        "hour": {
266                          "type": "integer"
267                        },
268                        "minute": {
269                          "type": "integer"
270                        }
271                      }
272                    }
273                  }
274                }
275              ],
276              "description": "Operational timings for the location."
277            },
278            "name": {
279              "type": "string",
280              "description": "Name of the location."
281            },
282            "_id": {
283              "type": "string",
284              "description": "Unique identifier for the location."
285            },
286            "modified_by": {
287              "type": "object",
288              "properties": {
289                "username": {
290                  "type": "string",
291                  "description": "Username of the user who last modified the location."
292                },
293                "user_id": {
294                  "type": "string",
295                  "description": "User ID of the user who last modified the location."
296                }
297              },
298              "description": "User who last modified the location."
299            },
300            "uid": {
301              "type": "integer",
302              "description": "Unique identifier for the location."
303            },
304            "stage": {
305              "type": "string",
306              "description": "Stage of the location."
307            },
308            "display_name": {
309              "type": "string",
310              "description": "Display name of the location."
311            },
312            "credit_note": {
313              "type": "boolean",
314              "description": "Flag indicating if credit note generation is enabled for the location."
315            },
316            "code": {
317              "type": "string",
318              "description": "Code for the location."
319            },
320            "bulk_shipment": {
321              "type": "boolean",
322              "description": "Flag indicating if bulk shipment is enabled for the location."
323            },
324            "tags": {
325              "type": "array",
326              "description": "Tags associated with the location."
327            },
328            "store_type": {
329              "type": "string",
330              "description": "Type of the store."
331            },
332            "created_on": {
333              "type": "string",
334              "description": "Timestamp for when the location was created."
335            },
336            "warnings": {
337              "type": "object",
338              "description": "Warnings associated with the location."
339            },
340            "order_acceptance_timing": {
341              "type": "array",
342              "items": {
343                "type": "object",
344                "properties": {
345                  "open": {
346                    "type": "boolean"
347                  },
348                  "weekday": {
349                    "type": "string"
350                  },
351                  "closing": {
352                    "type": "object",
353                    "properties": {
354                      "hour": {
355                        "type": "integer"
356                      },
357                      "minute": {
358                        "type": "integer"
359                      }
360                    }
361                  },
362                  "opening": {
363                    "type": "object",
364                    "properties": {
365                      "hour": {
366                        "type": "integer"
367                      },
368                      "minute": {
369                        "type": "integer"
370                      }
371                    }
372                  }
373                }
374              },
375              "description": "Order acceptance timing for the location."
376            },
377            "default_order_acceptance_timing": {
378              "type": "boolean",
379              "description": "Flag indicating if the default order acceptance timing is enabled for the location."
380            },
381            "notification_emails": {
382              "type": "array",
383              "items": {
384                "type": "string"
385              },
386              "description": "Email addresses for notifications related to the location."
387            }
388          },
389          "description": "Location Details."
390        }
391      }
392    }
393  }
394}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "viking-utils.90aa0b6e-f308-11ee-a983-46abbc8259d6"
5    ],
6    "name": "location",
7    "type": "create",
8    "version": "2",
9    "created_timestamp": 1712292860741,
10    "id": "yi3B3NvHmHP0ac+g4YpCdyU1uPExMbGrK7AF3lzS5ws=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26167,
15  "contains": [
16    "location"
17  ],
18  "payload": {
19    "location": {
20      "avg_order_processing_time": {
21        "duration_type": "days",
22        "duration": 1
23      },
24      "_id": "660f83fce6f80b332fd6c9e7",
25      "contact_numbers": [
26        {
27          "country_code": 971,
28          "number": "1111111111"
29        }
30      ],
31      "display_name": "Brunt Test Company - 1712292860463",
32      "tags": [],
33      "manager": {
34        "mobile_no": {
35          "country_code": 971,
36          "number": "1111111111"
37        },
38        "name": "sandbox user",
39        "email": "[email protected]"
40      },
41      "stage": "complete",
42      "default_order_acceptance_timing": true,
43      "store_type": "high_street",
44      "created_on": "2024-04-05T04:54:20.679256",
45      "name": "Brunt Test Company - 1712292860463",
46      "modified_by": {
47        "user_id": "9759643b65ebc6bacb5275f5",
48        "username": "[email protected]"
49      },
50      "bulk_shipment": false,
51      "order_acceptance_timing": [
52        {
53          "closing": {
54            "minute": 30,
55            "hour": 21
56          },
57          "weekday": "monday",
58          "open": true,
59          "opening": {
60            "minute": 0,
61            "hour": 11
62          }
63        },
64        {
65          "closing": {
66            "minute": 30,
67            "hour": 21
68          },
69          "weekday": "tuesday",
70          "open": true,
71          "opening": {
72            "minute": 0,
73            "hour": 11
74          }
75        },
76        {
77          "closing": {
78            "minute": 30,
79            "hour": 21
80          },
81          "weekday": "wednesday",
82          "open": true,
83          "opening": {
84            "minute": 0,
85            "hour": 11
86          }
87        },
88        {
89          "closing": {
90            "minute": 30,
91            "hour": 21
92          },
93          "weekday": "thursday",
94          "open": true,
95          "opening": {
96            "minute": 0,
97            "hour": 11
98          }
99        },
100        {
101          "closing": {
102            "minute": 30,
103            "hour": 21
104          },
105          "weekday": "friday",
106          "open": true,
107          "opening": {
108            "minute": 0,
109            "hour": 11
110          }
111        },
112        {
113          "closing": {
114            "minute": 30,
115            "hour": 21
116          },
117          "weekday": "saturday",
118          "open": true,
119          "opening": {
120            "minute": 0,
121            "hour": 11
122          }
123        },
124        {
125          "closing": {
126            "minute": 30,
127            "hour": 21
128          },
129          "weekday": "sunday",
130          "open": true,
131          "opening": {
132            "minute": 0,
133            "hour": 11
134          }
135        }
136      ],
137      "auto_invoice": false,
138      "created_by": {
139        "user_id": "9759643b65ebc6bacb5275f5",
140        "username": "[email protected]"
141      },
142      "company": 26167,
143      "modified_on": "2024-04-05T04:54:20.679265",
144      "gst_credentials": {
145        "e_waybill": {
146          "enabled": false
147        },
148        "e_invoice": {
149          "enabled": false
150        }
151      },
152      "warnings": {},
153      "uid": 55905,
154      "product_return_config": {
155        "on_same_store": true
156      },
157      "credit_note": false,
158      "address": {
159        "address1": "POLARIS",
160        "latitude": 19.0653252,
161        "longitude": 72.8423802,
162        "country_code": "AE",
163        "country": "UNITED ARAB EMIRATES",
164        "sector": "AL AAHAD AREA",
165        "city": "SHARJAH"
166      },
167      "documents": [],
168      "notification_emails": [
169        "[email protected]"
170      ],
171      "auto_assign_courier_partner": true,
172      "timing": [
173        {
174          "closing": {
175            "minute": 30,
176            "hour": 21
177          },
178          "weekday": "monday",
179          "open": true,
180          "opening": {
181            "minute": 0,
182            "hour": 11
183          }
184        },
185        {
186          "closing": {
187            "minute": 30,
188            "hour": 21
189          },
190          "weekday": "tuesday",
191          "open": true,
192          "opening": {
193            "minute": 0,
194            "hour": 11
195          }
196        },
197        {
198          "closing": {
199            "minute": 30,
200            "hour": 21
201          },
202          "weekday": "wednesday",
203          "open": true,
204          "opening": {
205            "minute": 0,
206            "hour": 11
207          }
208        },
209        {
210          "closing": {
211            "minute": 30,
212            "hour": 21
213          },
214          "weekday": "thursday",
215          "open": true,
216          "opening": {
217            "minute": 0,
218            "hour": 11
219          }
220        },
221        {
222          "closing": {
223            "minute": 30,
224            "hour": 21
225          },
226          "weekday": "friday",
227          "open": true,
228          "opening": {
229            "minute": 0,
230            "hour": 11
231          }
232        },
233        {
234          "closing": {
235            "minute": 30,
236            "hour": 21
237          },
238          "weekday": "saturday",
239          "open": true,
240          "opening": {
241            "minute": 0,
242            "hour": 11
243          }
244        },
245        {
246          "closing": {
247            "minute": 30,
248            "hour": 21
249          },
250          "weekday": "sunday",
251          "open": true,
252          "opening": {
253            "minute": 0,
254            "hour": 11
255          }
256        }
257      ],
258      "code": "HS-d4ab1"
259    }
260  }
261}

company/location/update/v1

this event is triggered when location is updated

Payload
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
id
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
location
object
Location Details.
Properties
_id
string
Unique identifier for the location.
modified_by
object
User who last modified the location.
Properties
username
string
Username of the user who last modified the location.
user_id
string
User ID of the user who last modified the location.
created_on
string
Timestamp for when the location was created.
product_return_config
object
Product return configuration for the location.
Properties
on_same_store
boolean
Whether return can be initiated at the same store.
warnings
object
Warnings associated with the location.
Properties
store_address
string
Address-related warnings associated with the location.
manager
object
Manager of the location.
Properties
mobile_no
object
Mobile phone number of the location manager.
Properties
country_code
integer
Country code for the mobile phone number of the location manager.
number
string
Phone number of the location manager.
email
string
Email address of the location manager.
name
string
Name of the location manager.
uid
integer
Unique identifier for the location.
order_acceptance_timing
array of object
Order acceptance timing for the location.
Array of Properties
closing
object
Closing time of the store for a specific day.
Properties
minute
integer
Closing minute of the store's operational hours.
hour
integer
Closing hour of the store's operational hours.
opening
object
Opening time of the store for a specific day.
Properties
minute
integer
Opening minute of the store's operational hours.
hour
integer
Opening hour of the store's operational hours.
open
boolean
Flag indicating if the store is open on a specific day.
weekday
string
Specific day of the week.
bulk_shipment
boolean
Flag indicating if bulk shipment is enabled for the location.
auto_invoice
boolean
Flag indicating if auto invoice generation is enabled for the location.
modified_on
string
Timestamp for when the location was last modified.
credit_note
boolean
Flag indicating if credit note generation is enabled for the location.
avg_order_processing_time
object
Average order processing time for the location.
Properties
duration_type
string
Type of duration for the average order processing time.
duration
integer
Duration of the average order processing time.
documents
array of Undefined Type
Documents associated with the location.
default_order_acceptance_timing
boolean
Flag indicating if the default order acceptance timing is enabled for the location.
auto_assign_courier_partner
boolean
Flag indicating if auto-assignment of courier partner is enabled for the location.
address
object
Address of the location.
Properties
pincode
integer
Postal code of the location address.
latitude
number
Latitude of the location address.
country_code
string
Country code of the location address.
country
string
Country of the location address.
address1
string
First line of the location address.
longitude
number
Longitude of the location address.
city
string
City of the location address.
state
string
State or Province of the location address.
notification_emails
array of string
Email addresses for notifications related to the location.
company
integer
Company associated with the location.
created_by
object
User who created the location.
Properties
username
string
Username of the user who created the location.
user_id
string
User ID of the user who created the location.
display_name
string
Display name of the location.
store_type
string
Type of the store.
stage
string
Stage of the location.
name
string
Name of the location.
code
string
Code for the location.
contact_numbers
array of Undefined Type
Contact numbers associated with the location.
gst_credentials
object
GST credentials for the location.
Properties
e_invoice
object
E-Invoice credentials for the location.
Properties
enabled
boolean
Flag indicating if E-Invoice is enabled for the location.
e_waybill
object
E-Waybill credentials for the location.
Properties
enabled
boolean
Flag indicating if E-Waybill is enabled for the location.
timing
array of Undefined Type
Operational timings for the location.
tags
array of string
Tags associated with the location.
verified_on
string
Timestamp for when the location was verified.
verified_by
object
User who verified the location.
Properties
username
string
Username of the user who verified the location.
user_id
string
User ID of the user who verified the location.
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        "location": {
70          "type": "object",
71          "properties": {
72            "_id": {
73              "type": "string",
74              "description": "Unique identifier for the location."
75            },
76            "modified_by": {
77              "type": "object",
78              "properties": {
79                "username": {
80                  "type": "string",
81                  "description": "Username of the user who last modified the location."
82                },
83                "user_id": {
84                  "type": "string",
85                  "description": "User ID of the user who last modified the location."
86                }
87              },
88              "description": "User who last modified the location."
89            },
90            "created_on": {
91              "type": "string",
92              "description": "Timestamp for when the location was created."
93            },
94            "product_return_config": {
95              "type": "object",
96              "properties": {
97                "on_same_store": {
98                  "type": "boolean",
99                  "description": "Whether return can be initiated at the same store."
100                }
101              },
102              "description": "Product return configuration for the location."
103            },
104            "warnings": {
105              "type": "object",
106              "properties": {
107                "store_address": {
108                  "type": "string",
109                  "description": "Address-related warnings associated with the location."
110                }
111              },
112              "description": "Warnings associated with the location."
113            },
114            "manager": {
115              "type": "object",
116              "properties": {
117                "mobile_no": {
118                  "type": "object",
119                  "properties": {
120                    "country_code": {
121                      "type": "integer",
122                      "description": "Country code for the mobile phone number of the location manager."
123                    },
124                    "number": {
125                      "type": "string",
126                      "description": "Phone number of the location manager."
127                    }
128                  },
129                  "description": "Mobile phone number of the location manager."
130                },
131                "email": {
132                  "type": "string",
133                  "description": "Email address of the location manager."
134                },
135                "name": {
136                  "type": "string",
137                  "description": "Name of the location manager."
138                }
139              },
140              "description": "Manager of the location."
141            },
142            "uid": {
143              "type": "integer",
144              "description": "Unique identifier for the location."
145            },
146            "order_acceptance_timing": {
147              "type": "array",
148              "items": {
149                "type": "object",
150                "properties": {
151                  "closing": {
152                    "type": "object",
153                    "properties": {
154                      "minute": {
155                        "type": "integer",
156                        "description": "Closing minute of the store's operational hours."
157                      },
158                      "hour": {
159                        "type": "integer",
160                        "description": "Closing hour of the store's operational hours."
161                      }
162                    },
163                    "description": "Closing time of the store for a specific day."
164                  },
165                  "opening": {
166                    "type": "object",
167                    "properties": {
168                      "minute": {
169                        "type": "integer",
170                        "description": "Opening minute of the store's operational hours."
171                      },
172                      "hour": {
173                        "type": "integer",
174                        "description": "Opening hour of the store's operational hours."
175                      }
176                    },
177                    "description": "Opening time of the store for a specific day."
178                  },
179                  "open": {
180                    "type": "boolean",
181                    "description": "Flag indicating if the store is open on a specific day."
182                  },
183                  "weekday": {
184                    "type": "string",
185                    "description": "Specific day of the week."
186                  }
187                },
188                "description": "Describes the store's operational hours for each day of the week."
189              },
190              "description": "Order acceptance timing for the location."
191            },
192            "bulk_shipment": {
193              "type": "boolean",
194              "description": "Flag indicating if bulk shipment is enabled for the location."
195            },
196            "auto_invoice": {
197              "type": "boolean",
198              "description": "Flag indicating if auto invoice generation is enabled for the location."
199            },
200            "modified_on": {
201              "type": "string",
202              "description": "Timestamp for when the location was last modified."
203            },
204            "credit_note": {
205              "type": "boolean",
206              "description": "Flag indicating if credit note generation is enabled for the location."
207            },
208            "avg_order_processing_time": {
209              "type": "object",
210              "properties": {
211                "duration_type": {
212                  "type": "string",
213                  "description": "Type of duration for the average order processing time."
214                },
215                "duration": {
216                  "type": "integer",
217                  "description": "Duration of the average order processing time."
218                }
219              },
220              "description": "Average order processing time for the location."
221            },
222            "documents": {
223              "type": "array",
224              "items": {},
225              "description": "Documents associated with the location."
226            },
227            "default_order_acceptance_timing": {
228              "type": "boolean",
229              "description": "Flag indicating if the default order acceptance timing is enabled for the location."
230            },
231            "auto_assign_courier_partner": {
232              "type": "boolean",
233              "description": "Flag indicating if auto-assignment of courier partner is enabled for the location."
234            },
235            "address": {
236              "type": "object",
237              "properties": {
238                "pincode": {
239                  "type": "integer",
240                  "description": "Postal code of the location address."
241                },
242                "latitude": {
243                  "type": "number",
244                  "description": "Latitude of the location address."
245                },
246                "country_code": {
247                  "type": "string",
248                  "description": "Country code of the location address."
249                },
250                "country": {
251                  "type": "string",
252                  "description": "Country of the location address."
253                },
254                "address1": {
255                  "type": "string",
256                  "description": "First line of the location address."
257                },
258                "longitude": {
259                  "type": "number",
260                  "description": "Longitude of the location address."
261                },
262                "city": {
263                  "type": "string",
264                  "description": "City of the location address."
265                },
266                "state": {
267                  "type": "string",
268                  "description": "State or Province of the location address."
269                }
270              },
271              "description": "Address of the location."
272            },
273            "notification_emails": {
274              "type": "array",
275              "items": {
276                "type": "string"
277              },
278              "description": "Email addresses for notifications related to the location."
279            },
280            "company": {
281              "type": "integer",
282              "description": "Company associated with the location."
283            },
284            "created_by": {
285              "type": "object",
286              "properties": {
287                "username": {
288                  "type": "string",
289                  "description": "Username of the user who created the location."
290                },
291                "user_id": {
292                  "type": "string",
293                  "description": "User ID of the user who created the location."
294                }
295              },
296              "description": "User who created the location."
297            },
298            "display_name": {
299              "type": "string",
300              "description": "Display name of the location."
301            },
302            "store_type": {
303              "type": "string",
304              "description": "Type of the store."
305            },
306            "stage": {
307              "type": "string",
308              "description": "Stage of the location."
309            },
310            "name": {
311              "type": "string",
312              "description": "Name of the location."
313            },
314            "code": {
315              "type": "string",
316              "description": "Code for the location."
317            },
318            "contact_numbers": {
319              "type": "array",
320              "items": [
321                {
322                  "type": "object",
323                  "properties": {
324                    "country_code": {
325                      "type": "integer"
326                    },
327                    "number": {
328                      "type": "string"
329                    }
330                  }
331                }
332              ],
333              "description": "Contact numbers associated with the location."
334            },
335            "gst_credentials": {
336              "type": "object",
337              "properties": {
338                "e_invoice": {
339                  "type": "object",
340                  "properties": {
341                    "enabled": {
342                      "type": "boolean",
343                      "description": "Flag indicating if E-Invoice is enabled for the location."
344                    }
345                  },
346                  "description": "E-Invoice credentials for the location."
347                },
348                "e_waybill": {
349                  "type": "object",
350                  "properties": {
351                    "enabled": {
352                      "type": "boolean",
353                      "description": "Flag indicating if E-Waybill is enabled for the location."
354                    }
355                  },
356                  "description": "E-Waybill credentials for the location."
357                }
358              },
359              "description": "GST credentials for the location."
360            },
361            "timing": {
362              "type": "array",
363              "items": [
364                {
365                  "type": "object",
366                  "properties": {
367                    "closing": {
368                      "type": "object",
369                      "properties": {
370                        "minute": {
371                          "type": "integer"
372                        },
373                        "hour": {
374                          "type": "integer"
375                        }
376                      }
377                    },
378                    "opening": {
379                      "type": "object",
380                      "properties": {
381                        "minute": {
382                          "type": "integer"
383                        },
384                        "hour": {
385                          "type": "integer"
386                        }
387                      }
388                    },
389                    "open": {
390                      "type": "boolean"
391                    },
392                    "weekday": {
393                      "type": "string"
394                    }
395                  }
396                }
397              ],
398              "description": "Operational timings for the location."
399            },
400            "tags": {
401              "type": "array",
402              "items": {
403                "type": "string"
404              },
405              "description": "Tags associated with the location."
406            },
407            "verified_on": {
408              "type": "string",
409              "description": "Timestamp for when the location was verified."
410            },
411            "verified_by": {
412              "type": "object",
413              "properties": {
414                "username": {
415                  "type": "string",
416                  "description": "Username of the user who verified the location."
417                },
418                "user_id": {
419                  "type": "string",
420                  "description": "User ID of the user who verified the location."
421                }
422              },
423              "description": "User who verified the location."
424            }
425          },
426          "description": "Location Details."
427        }
428      }
429    }
430  }
431}
Payload Example
1{
2  "company_id": 680,
3  "contains": [
4    "location"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1712296806094,
9    "id": "TmmvBJ5721ruRBSryU9pJnW9I/I76uDnFcA5Kwv73vk=",
10    "name": "location",
11    "trace_id": [
12      "WheelJack.c04725e2-f311-11ee-8496-f67d79aa4477"
13    ],
14    "type": "update",
15    "version": "1"
16  },
17  "payload": {
18    "location": {
19      "_id": "656d9de2c2938b090d12c40b",
20      "address": {
21        "address1": "dummy address",
22        "city": "West Delhi",
23        "country": "India",
24        "country_code": "IN",
25        "latitude": 19.0653252,
26        "longitude": 72.8423802,
27        "pincode": 110041,
28        "state": "Delhi"
29      },
30      "auto_assign_courier_partner": false,
31      "auto_invoice": true,
32      "avg_order_processing_time": {
33        "duration": 48,
34        "duration_type": "hours"
35      },
36      "bulk_shipment": true,
37      "code": "CAPL68003",
38      "company": 680,
39      "contact_numbers": [
40        {
41          "country_code": 91,
42          "number": "1111111111"
43        }
44      ],
45      "created_by": {
46        "user_id": "2dcda33fde32f3c983f3f24e",
47        "username": "sayaliwaingankar_gofynd_com_30521"
48      },
49      "created_on": "2023-12-04T09:37:38.329000",
50      "credit_note": true,
51      "default_order_acceptance_timing": true,
52      "display_name": "Mundka1",
53      "documents": [
54        {
55          "legal_name": "CAMPUS ACTIVEWEAR LIMITED",
56          "type": "gst",
57          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/680/stores/all/legal/documents/free/original/67hihLcgh-GST.pdf",
58          "value": "07AAHCA3072C1Z3",
59          "verified": true
60        }
61      ],
62      "gst_credentials": {
63        "e_invoice": {
64          "enabled": false
65        },
66        "e_waybill": {
67          "enabled": false
68        }
69      },
70      "holiday": [],
71      "manager": {
72        "email": "[email protected]",
73        "mobile_no": {
74          "country_code": 91,
75          "number": "1111111111"
76        },
77        "name": "AJAY"
78      },
79      "modified_by": {
80        "user_id": "456be36cadd7cc7973e80257",
81        "username": "sunilyadav_gofynd_com_94976"
82      },
83      "modified_on": "2024-04-05T06:00:05.144000",
84      "name": "Mundka1",
85      "notification_emails": [
86        "[email protected]"
87      ],
88      "order_acceptance_timing": [
89        {
90          "closing": {
91            "hour": 22,
92            "minute": 0
93          },
94          "open": true,
95          "opening": {
96            "hour": 11,
97            "minute": 0
98          },
99          "weekday": "monday"
100        },
101        {
102          "closing": {
103            "hour": 22,
104            "minute": 0
105          },
106          "open": true,
107          "opening": {
108            "hour": 11,
109            "minute": 0
110          },
111          "weekday": "tuesday"
112        },
113        {
114          "closing": {
115            "hour": 22,
116            "minute": 0
117          },
118          "open": true,
119          "opening": {
120            "hour": 11,
121            "minute": 0
122          },
123          "weekday": "wednesday"
124        },
125        {
126          "closing": {
127            "hour": 22,
128            "minute": 0
129          },
130          "open": true,
131          "opening": {
132            "hour": 11,
133            "minute": 0
134          },
135          "weekday": "thursday"
136        },
137        {
138          "closing": {
139            "hour": 22,
140            "minute": 0
141          },
142          "open": true,
143          "opening": {
144            "hour": 11,
145            "minute": 0
146          },
147          "weekday": "friday"
148        },
149        {
150          "closing": {
151            "hour": 22,
152            "minute": 0
153          },
154          "open": true,
155          "opening": {
156            "hour": 11,
157            "minute": 0
158          },
159          "weekday": "saturday"
160        },
161        {
162          "closing": {
163            "hour": 22,
164            "minute": 0
165          },
166          "open": false,
167          "opening": {
168            "hour": 11,
169            "minute": 0
170          },
171          "weekday": "sunday"
172        }
173      ],
174      "product_return_config": {
175        "on_same_store": true
176      },
177      "stage": "verified",
178      "store_type": "warehouse",
179      "tags": [],
180      "timing": [
181        {
182          "closing": {
183            "hour": 22,
184            "minute": 0
185          },
186          "open": true,
187          "opening": {
188            "hour": 11,
189            "minute": 0
190          },
191          "weekday": "monday"
192        },
193        {
194          "closing": {
195            "hour": 22,
196            "minute": 0
197          },
198          "open": true,
199          "opening": {
200            "hour": 11,
201            "minute": 0
202          },
203          "weekday": "tuesday"
204        },
205        {
206          "closing": {
207            "hour": 22,
208            "minute": 0
209          },
210          "open": true,
211          "opening": {
212            "hour": 11,
213            "minute": 0
214          },
215          "weekday": "wednesday"
216        },
217        {
218          "closing": {
219            "hour": 22,
220            "minute": 0
221          },
222          "open": true,
223          "opening": {
224            "hour": 11,
225            "minute": 0
226          },
227          "weekday": "thursday"
228        },
229        {
230          "closing": {
231            "hour": 22,
232            "minute": 0
233          },
234          "open": true,
235          "opening": {
236            "hour": 11,
237            "minute": 0
238          },
239          "weekday": "friday"
240        },
241        {
242          "closing": {
243            "hour": 22,
244            "minute": 0
245          },
246          "open": true,
247          "opening": {
248            "hour": 11,
249            "minute": 0
250          },
251          "weekday": "saturday"
252        },
253        {
254          "closing": {
255            "hour": 22,
256            "minute": 0
257          },
258          "open": false,
259          "opening": {
260            "hour": 11,
261            "minute": 0
262          },
263          "weekday": "sunday"
264        }
265      ],
266      "uid": 22619,
267      "verified_by": {
268        "user_id": "0",
269        "username": "WheelJack"
270      },
271      "verified_on": "2024-04-05T06:00:05.938631",
272      "warnings": {
273        "store_address": "Address seems to be inappropriate this might affect the delivery."
274      }
275    }
276  }
277}

Logistics configuration

This event will be generated where there is any logistics as per actual change in billing plan

Events
company/logistics-configuration/update/v1
# this event is triggered when logistics-configuration is updated

company/logistics-configuration/update/v1

this event is triggered when logistics-configuration is updated

Payload
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
id
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
logistics
object
Required
Properties
uid
integer
Required
company unique id
logistics_as_actual
string
Required
Indicates the commercial type for logistics, i.e Admin-controlled/Self-controlled/Self-ship
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      "required": [
69        "logistics"
70      ],
71      "properties": {
72        "logistics": {
73          "type": "object",
74          "required": [
75            "uid",
76            "logistics_as_actual"
77          ],
78          "properties": {
79            "uid": {
80              "type": "integer",
81              "description": "company unique id"
82            },
83            "logistics_as_actual": {
84              "type": "string",
85              "description": "Indicates the commercial type for logistics, i.e Admin-controlled/Self-controlled/Self-ship"
86            }
87          }
88        }
89      }
90    }
91  }
92}
Payload Example
1{
2  "company_id": 3875,
3  "contains": [
4    "logistics"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1710770247,
9    "id": "SZ1niYdOONKXCx2AGs1NtQMReFnFT1SEV7BsJpY6tOw=",
10    "name": "logistics-configuration",
11    "trace_id": [
12      "5ceaa595-d387-47c1-8b40-02a9c7e46415"
13    ],
14    "type": "update",
15    "version": "1"
16  },
17  "payload": {
18    "logistics": {
19      "logistics_as_actual": "self-ship",
20      "uid": 3875
21    }
22  }
23}

Product size

This event will be generated where there is any action done on product-size

Events
company/product-size/create/v1
# this event is triggered when product-size is created
company/product-size/update/v1
# this event is triggered when product-size is updated
company/product-size/create/v2
# this event is triggered when product-size is created
company/product-size/delete/v2
# this event is triggered when product-size is deleted
company/product-size/update/v2
# this event is triggered when product-size is updated

company/product-size/create/v1

this event is triggered when product-size is created

Payload
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
id
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
product-size
array of object
Required
Product size event.
Array of Properties
seller_identifier
string
Required
The identifier of the seller for the product
brand_uid
integer
Required
The ID of the brand the product belongs to
item_code
string
Required
The unique item code of the product
price
number
Required
Price of the item
price_transfer
number
Transfer price of the item
identifiers
array of object
Required
List of identifiers for this product
is_set
boolean
Whether the product is a set of multiple items or not
size
string
Required
Size of the item
track_inventory
boolean
Whether to track inventory for the product or not
price_effective
number
Effective price of the item
company_id
integer
Required
The ID of the company the product belongs to
currency
string
Required
The currency used for pricing the product
return_config
object
Return configuration for the product
Properties
returnable
boolean
Required
Indicates whether the product is returnable or not
time
integer
Time duration for returns
unit
string
Unit of time for return duration
is_active
boolean
Whether the product is currently active or not
trader
array of object
Trader information.
Array of Properties
address
array of string
Required
The address of the trader.
type
string
Required
The type of trader.
name
string
Required
The name of the trader.
item_id
integer
ID of the item
dimensions
object
Dimensions of the item.
Properties
item_length
number
Length of the item in centimeters.
item_width
number
Width of the item in centimeters.
item_height
number
Height of the item in centimeters.
item_weight
number
Weight of the item in grams.
item_weight_unit_of_measure
string
Unit of measure for the item's weight (e.g., "gram").
item_dimensions_unit_of_measure
string
Unit of measure for the item's dimensions (e.g., "cm").
tax_identifier
object
Tax identifier for the product.
Properties
hsn_code_id
string
The ID of the HSN code associated with the tax.
_custom_json
object
Custom JSON data for the product ( can contain any key value pair )
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      "required": [
69        "product-size"
70      ],
71      "properties": {
72        "product-size": {
73          "description": "Product size event.",
74          "type": "array",
75          "items": {
76            "type": "object",
77            "required": [
78              "seller_identifier",
79              "item_code",
80              "price",
81              "identifiers",
82              "size",
83              "company_id",
84              "currency",
85              "brand_uid"
86            ],
87            "properties": {
88              "seller_identifier": {
89                "type": "string",
90                "description": "The identifier of the seller for the product"
91              },
92              "brand_uid": {
93                "type": "integer",
94                "description": "The ID of the brand the product belongs to"
95              },
96              "item_code": {
97                "type": "string",
98                "description": "The unique item code of the product"
99              },
100              "price": {
101                "type": "number",
102                "description": "Price of the item"
103              },
104              "price_transfer": {
105                "type": "number",
106                "description": "Transfer price of the item"
107              },
108              "identifiers": {
109                "type": "array",
110                "items": {
111                  "type": "object"
112                },
113                "description": "List of identifiers for this product"
114              },
115              "is_set": {
116                "type": "boolean",
117                "description": "Whether the product is a set of multiple items or not"
118              },
119              "size": {
120                "type": "string",
121                "description": "Size of the item"
122              },
123              "track_inventory": {
124                "type": "boolean",
125                "description": "Whether to track inventory for the product or not"
126              },
127              "price_effective": {
128                "type": "number",
129                "description": "Effective price of the item"
130              },
131              "company_id": {
132                "type": "integer",
133                "description": "The ID of the company the product belongs to"
134              },
135              "currency": {
136                "type": "string",
137                "description": "The currency used for pricing the product"
138              },
139              "return_config": {
140                "type": "object",
141                "required": [
142                  "returnable"
143                ],
144                "properties": {
145                  "returnable": {
146                    "type": "boolean",
147                    "description": "Indicates whether the product is returnable or not"
148                  },
149                  "time": {
150                    "type": "integer",
151                    "description": "Time duration for returns"
152                  },
153                  "unit": {
154                    "type": "string",
155                    "description": "Unit of time for return duration"
156                  }
157                },
158                "description": "Return configuration for the product"
159              },
160              "is_active": {
161                "type": "boolean",
162                "description": "Whether the product is currently active or not"
163              },
164              "trader": {
165                "type": "array",
166                "description": "Trader information.",
167                "items": {
168                  "type": "object",
169                  "required": [
170                    "address",
171                    "type",
172                    "name"
173                  ],
174                  "properties": {
175                    "address": {
176                      "type": "array",
177                      "items": {
178                        "type": "string"
179                      },
180                      "description": "The address of the trader."
181                    },
182                    "type": {
183                      "type": "string",
184                      "description": "The type of trader."
185                    },
186                    "name": {
187                      "type": "string",
188                      "description": "The name of the trader."
189                    }
190                  }
191                }
192              },
193              "item_id": {
194                "type": "integer",
195                "description": "ID of the item"
196              },
197              "dimensions": {
198                "type": "object",
199                "description": "Dimensions of the item.",
200                "properties": {
201                  "item_length": {
202                    "type": "number",
203                    "description": "Length of the item in centimeters."
204                  },
205                  "item_width": {
206                    "type": "number",
207                    "description": "Width of the item in centimeters."
208                  },
209                  "item_height": {
210                    "type": "number",
211                    "description": "Height of the item in centimeters."
212                  },
213                  "item_weight": {
214                    "type": "number",
215                    "description": "Weight of the item in grams."
216                  },
217                  "item_weight_unit_of_measure": {
218                    "type": "string",
219                    "description": "Unit of measure for the item's weight (e.g., \"gram\")."
220                  },
221                  "item_dimensions_unit_of_measure": {
222                    "type": "string",
223                    "description": "Unit of measure for the item's dimensions (e.g., \"cm\")."
224                  }
225                }
226              },
227              "tax_identifier": {
228                "type": "object",
229                "description": "Tax identifier for the product.",
230                "properties": {
231                  "hsn_code_id": {
232                    "type": "string",
233                    "description": "The ID of the HSN code associated with the tax."
234                  }
235                }
236              },
237              "_custom_json": {
238                "type": "object",
239                "description": "Custom JSON data for the product ( can contain any key value pair )"
240              }
241            }
242          }
243        }
244      }
245    }
246  }
247}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3afc6620-efe4-11ee-9015-8a013da727dd"
5    ],
6    "name": "product-size",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711947401626,
10    "id": "P1XbOICHyopayZMdHB2UKNCNqw6OIfYLEnOfoo52O90=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 24565,
15  "contains": [
16    "product-size"
17  ],
18  "payload": {
19    "product-size": [
20      {
21        "price_transfer": 0,
22        "_custom_json": {},
23        "track_inventory": true,
24        "size": "OS",
25        "company_id": 24565,
26        "price": 234,
27        "price_effective": 23,
28        "is_set": false,
29        "item_code": "BRUNT-1711947390342",
30        "seller_identifier": "1711947390342",
31        "modified_on": "2024-04-01T04:56:41.424682",
32        "currency": "INR",
33        "created_on": "2024-04-01T04:56:41.424677",
34        "brand_uid": 72946,
35        "identifiers": [
36          {
37            "gtin_type": "ean",
38            "primary": true,
39            "gtin_value": "1711947390342"
40          }
41        ],
42        "_id": "660a3e89777eb6ac7352565a",
43        "return_config": {
44          "time": 10,
45          "returnable": true,
46          "unit": "days"
47        },
48        "is_active": true,
49        "trader": [
50          {
51            "type": "Manufacturer",
52            "name": "random",
53            "address": [
54              "random"
55            ]
56          }
57        ],
58        "item_id": 7671044,
59        "modified_by": {
60          "username": "sushantkadam_gofynd_com_02917",
61          "user_id": "5dfeaec7cb2f2ec075546dc0",
62          "super_user": false
63        },
64        "dimensions": {
65          "item_length": 234,
66          "item_width": 234,
67          "item_height": 234,
68          "item_weight": 2344,
69          "item_weight_unit_of_measure": "gram",
70          "item_dimensions_unit_of_measure": "cm"
71        },
72        "tax_identifier": {
73          "hsn_code_id": "66050e177425e7ce771def36"
74        }
75      }
76    ]
77  }
78}

company/product-size/update/v1

this event is triggered when product-size is updated

Payload
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
id
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
product-size
array of object
Required
Product size event.
Array of Properties
seller_identifier
string
Required
The identifier of the seller for the product
brand_uid
integer
Required
The ID of the brand the product belongs to
item_code
string
Required
The unique item code of the product
price
number
Required
Price of the item
price_transfer
number
Transfer price of the item
identifiers
array of object
Required
List of identifiers for this product
is_set
boolean
Whether the product is a set of multiple items or not
size
string
Required
Size of the item
track_inventory
boolean
Whether to track inventory for the product or not
price_effective
number
Effective price of the item
company_id
integer
Required
The ID of the company the product belongs to
currency
string
Required
The currency used for pricing the product
return_config
object
Return configuration for the product
Properties
returnable
boolean
Required
Indicates whether the product is returnable or not
time
integer
Time duration for returns
unit
string
Unit of time for return duration
is_active
boolean
Whether the product is currently active or not
trader
array of object
Trader information.
Array of Properties
address
array of string
Required
The address of the trader.
type
string
Required
The type of trader.
name
string
Required
The name of the trader.
item_id
integer
ID of the item
dimensions
object
Dimensions of the item.
Properties
item_length
number
Length of the item in centimeters.
item_width
number
Width of the item in centimeters.
item_height
number
Height of the item in centimeters.
item_weight
number
Weight of the item in grams.
item_weight_unit_of_measure
string
Unit of measure for the item's weight (e.g., "gram").
item_dimensions_unit_of_measure
string
Unit of measure for the item's dimensions (e.g., "cm").
tax_identifier
object
Tax identifier for the product.
Properties
hsn_code_id
string
The ID of the HSN code associated with the tax.
_custom_json
object
Custom JSON data for the product ( can contain any key value pair )
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      "required": [
69        "product-size"
70      ],
71      "properties": {
72        "product-size": {
73          "description": "Product size event.",
74          "type": "array",
75          "items": {
76            "type": "object",
77            "required": [
78              "seller_identifier",
79              "item_code",
80              "price",
81              "identifiers",
82              "size",
83              "company_id",
84              "currency",
85              "brand_uid"
86            ],
87            "properties": {
88              "seller_identifier": {
89                "type": "string",
90                "description": "The identifier of the seller for the product"
91              },
92              "brand_uid": {
93                "type": "integer",
94                "description": "The ID of the brand the product belongs to"
95              },
96              "item_code": {
97                "type": "string",
98                "description": "The unique item code of the product"
99              },
100              "price": {
101                "type": "number",
102                "description": "Price of the item"
103              },
104              "price_transfer": {
105                "type": "number",
106                "description": "Transfer price of the item"
107              },
108              "identifiers": {
109                "type": "array",
110                "items": {
111                  "type": "object"
112                },
113                "description": "List of identifiers for this product"
114              },
115              "is_set": {
116                "type": "boolean",
117                "description": "Whether the product is a set of multiple items or not"
118              },
119              "size": {
120                "type": "string",
121                "description": "Size of the item"
122              },
123              "track_inventory": {
124                "type": "boolean",
125                "description": "Whether to track inventory for the product or not"
126              },
127              "price_effective": {
128                "type": "number",
129                "description": "Effective price of the item"
130              },
131              "company_id": {
132                "type": "integer",
133                "description": "The ID of the company the product belongs to"
134              },
135              "currency": {
136                "type": "string",
137                "description": "The currency used for pricing the product"
138              },
139              "return_config": {
140                "type": "object",
141                "required": [
142                  "returnable"
143                ],
144                "properties": {
145                  "returnable": {
146                    "type": "boolean",
147                    "description": "Indicates whether the product is returnable or not"
148                  },
149                  "time": {
150                    "type": "integer",
151                    "description": "Time duration for returns"
152                  },
153                  "unit": {
154                    "type": "string",
155                    "description": "Unit of time for return duration"
156                  }
157                },
158                "description": "Return configuration for the product"
159              },
160              "is_active": {
161                "type": "boolean",
162                "description": "Whether the product is currently active or not"
163              },
164              "trader": {
165                "type": "array",
166                "description": "Trader information.",
167                "items": {
168                  "type": "object",
169                  "required": [
170                    "address",
171                    "type",
172                    "name"
173                  ],
174                  "properties": {
175                    "address": {
176                      "type": "array",
177                      "items": {
178                        "type": "string"
179                      },
180                      "description": "The address of the trader."
181                    },
182                    "type": {
183                      "type": "string",
184                      "description": "The type of trader."
185                    },
186                    "name": {
187                      "type": "string",
188                      "description": "The name of the trader."
189                    }
190                  }
191                }
192              },
193              "item_id": {
194                "type": "integer",
195                "description": "ID of the item"
196              },
197              "dimensions": {
198                "type": "object",
199                "description": "Dimensions of the item.",
200                "properties": {
201                  "item_length": {
202                    "type": "number",
203                    "description": "Length of the item in centimeters."
204                  },
205                  "item_width": {
206                    "type": "number",
207                    "description": "Width of the item in centimeters."
208                  },
209                  "item_height": {
210                    "type": "number",
211                    "description": "Height of the item in centimeters."
212                  },
213                  "item_weight": {
214                    "type": "number",
215                    "description": "Weight of the item in grams."
216                  },
217                  "item_weight_unit_of_measure": {
218                    "type": "string",
219                    "description": "Unit of measure for the item's weight (e.g., \"gram\")."
220                  },
221                  "item_dimensions_unit_of_measure": {
222                    "type": "string",
223                    "description": "Unit of measure for the item's dimensions (e.g., \"cm\")."
224                  }
225                }
226              },
227              "tax_identifier": {
228                "type": "object",
229                "description": "Tax identifier for the product.",
230                "properties": {
231                  "hsn_code_id": {
232                    "type": "string",
233                    "description": "The ID of the HSN code associated with the tax."
234                  }
235                }
236              },
237              "_custom_json": {
238                "type": "object",
239                "description": "Custom JSON data for the product ( can contain any key value pair )"
240              }
241            }
242          }
243        }
244      }
245    }
246  }
247}
Payload Example
1{
2  "company_id": 42,
3  "contains": [
4    "product-size"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1709196406313,
9    "id": "/OXaCsd6hdi/SUREK/19T1u1wNDtM658MC3J40ykyvk=",
10    "name": "product-size",
11    "trace_id": [
12      "silverbolt.12007c02-d6df-11ee-acd9-5a7806a5a426"
13    ],
14    "type": "update",
15    "version": "1"
16  },
17  "payload": {
18    "product-size": [
19      {
20        "_id": "65604051f50ddd0b7df5ec60",
21        "brand_uid": 61,
22        "company_id": 42,
23        "currency": "INR",
24        "dimensions": {
25          "item_dimensions_unit_of_measure": "cm",
26          "item_height": 32,
27          "item_length": 12,
28          "item_weight": 2000,
29          "item_weight_unit_of_measure": "gram",
30          "item_width": 23
31        },
32        "identifiers": [
33          {
34            "gtin_type": "ean",
35            "gtin_value": "5050409522028",
36            "primary": true
37          }
38        ],
39        "is_active": true,
40        "is_set": false,
41        "item_code": "26140139",
42        "item_id": 7817584,
43        "modified_by": {
44          "super_user": false,
45          "user_id": "5eb2fca2e72f8a243fbfd696",
46          "username": "bijal_thakker_clarks_in_56048"
47        },
48        "price": 7499,
49        "price_effective": 7499,
50        "price_transfer": 0,
51        "return_config": {
52          "returnable": true,
53          "time": 15,
54          "unit": "days"
55        },
56        "seller_identifier": "5050409522028",
57        "size": "9",
58        "tax_identifier": {
59          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
60        },
61        "track_inventory": true,
62        "trader": [
63          {
64            "address": [
65              "dummy data"
66            ],
67            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
68            "type": "Importer"
69          }
70        ]
71      },
72      {
73        "_id": "65604051f50ddd0b7df5ec5a",
74        "brand_uid": 61,
75        "company_id": 42,
76        "currency": "INR",
77        "dimensions": {
78          "item_dimensions_unit_of_measure": "cm",
79          "item_height": 32,
80          "item_length": 12,
81          "item_weight": 2000,
82          "item_weight_unit_of_measure": "gram",
83          "item_width": 22
84        },
85        "identifiers": [
86          {
87            "gtin_type": "ean",
88            "gtin_value": "5050409521960",
89            "primary": true
90          }
91        ],
92        "is_active": true,
93        "is_set": false,
94        "item_code": "26140139",
95        "item_id": 7817584,
96        "modified_by": {
97          "super_user": false,
98          "user_id": "5eb2fca2e72f8a243fbfd696",
99          "username": "bijal_thakker_clarks_in_56048"
100        },
101        "price": 7499,
102        "price_effective": 7499,
103        "price_transfer": 0,
104        "return_config": {
105          "returnable": true,
106          "time": 15,
107          "unit": "days"
108        },
109        "seller_identifier": "5050409521960",
110        "size": "6",
111        "tax_identifier": {
112          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
113        },
114        "track_inventory": true,
115        "trader": [
116          {
117            "address": [
118              "dummy data"
119            ],
120            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
121            "type": "Importer"
122          }
123        ]
124      },
125      {
126        "_id": "65604051f50ddd0b7df5ec5c",
127        "brand_uid": 61,
128        "company_id": 42,
129        "currency": "INR",
130        "dimensions": {
131          "item_dimensions_unit_of_measure": "cm",
132          "item_height": 32,
133          "item_length": 12,
134          "item_weight": 2000,
135          "item_weight_unit_of_measure": "gram",
136          "item_width": 23
137        },
138        "identifiers": [
139          {
140            "gtin_type": "ean",
141            "gtin_value": "5050409521984",
142            "primary": true
143          }
144        ],
145        "is_active": true,
146        "is_set": false,
147        "item_code": "26140139",
148        "item_id": 7817584,
149        "modified_by": {
150          "super_user": false,
151          "user_id": "5eb2fca2e72f8a243fbfd696",
152          "username": "bijal_thakker_clarks_in_56048"
153        },
154        "price": 7499,
155        "price_effective": 7499,
156        "price_transfer": 0,
157        "return_config": {
158          "returnable": true,
159          "time": 15,
160          "unit": "days"
161        },
162        "seller_identifier": "5050409521984",
163        "size": "7",
164        "tax_identifier": {
165          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
166        },
167        "track_inventory": true,
168        "trader": [
169          {
170            "address": [
171              "dummy data"
172            ],
173            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
174            "type": "Importer"
175          }
176        ]
177      },
178      {
179        "_id": "65604051f50ddd0b7df5ec64",
180        "brand_uid": 61,
181        "company_id": 42,
182        "currency": "INR",
183        "dimensions": {
184          "item_dimensions_unit_of_measure": "cm",
185          "item_height": 32,
186          "item_length": 12,
187          "item_weight": 2000,
188          "item_weight_unit_of_measure": "gram",
189          "item_width": 22
190        },
191        "identifiers": [
192          {
193            "gtin_type": "ean",
194            "gtin_value": "5050409522066",
195            "primary": true
196          }
197        ],
198        "is_active": true,
199        "is_set": false,
200        "item_code": "26140139",
201        "item_id": 7817584,
202        "modified_by": {
203          "super_user": false,
204          "user_id": "5eb2fca2e72f8a243fbfd696",
205          "username": "bijal_thakker_clarks_in_56048"
206        },
207        "price": 7499,
208        "price_effective": 7499,
209        "price_transfer": 0,
210        "return_config": {
211          "returnable": true,
212          "time": 15,
213          "unit": "days"
214        },
215        "seller_identifier": "5050409522066",
216        "size": "11",
217        "tax_identifier": {
218          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
219        },
220        "track_inventory": true,
221        "trader": [
222          {
223            "address": [
224              "dummy data"
225            ],
226            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
227            "type": "Importer"
228          }
229        ]
230      },
231      {
232        "_id": "65604051f50ddd0b7df5ec5b",
233        "brand_uid": 61,
234        "company_id": 42,
235        "currency": "INR",
236        "dimensions": {
237          "item_dimensions_unit_of_measure": "cm",
238          "item_height": 32,
239          "item_length": 12,
240          "item_weight": 2000,
241          "item_weight_unit_of_measure": "gram",
242          "item_width": 22
243        },
244        "identifiers": [
245          {
246            "gtin_type": "ean",
247            "gtin_value": "5050409521977",
248            "primary": true
249          }
250        ],
251        "is_active": true,
252        "is_set": false,
253        "item_code": "26140139",
254        "item_id": 7817584,
255        "modified_by": {
256          "super_user": false,
257          "user_id": "5eb2fca2e72f8a243fbfd696",
258          "username": "bijal_thakker_clarks_in_56048"
259        },
260        "price": 7499,
261        "price_effective": 7499,
262        "price_transfer": 0,
263        "return_config": {
264          "returnable": true,
265          "time": 15,
266          "unit": "days"
267        },
268        "seller_identifier": "5050409521977",
269        "size": "6.5",
270        "tax_identifier": {
271          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
272        },
273        "track_inventory": true,
274        "trader": [
275          {
276            "address": [
277              "dummy data"
278            ],
279            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
280            "type": "Importer"
281          }
282        ]
283      },
284      {
285        "_id": "65604051f50ddd0b7df5ec5d",
286        "brand_uid": 61,
287        "company_id": 42,
288        "currency": "INR",
289        "dimensions": {
290          "item_dimensions_unit_of_measure": "cm",
291          "item_height": 32,
292          "item_length": 12,
293          "item_weight": 2000,
294          "item_weight_unit_of_measure": "gram",
295          "item_width": 22
296        },
297        "identifiers": [
298          {
299            "gtin_type": "ean",
300            "gtin_value": "5050409521991",
301            "primary": true
302          }
303        ],
304        "is_active": true,
305        "is_set": false,
306        "item_code": "26140139",
307        "item_id": 7817584,
308        "modified_by": {
309          "super_user": false,
310          "user_id": "5eb2fca2e72f8a243fbfd696",
311          "username": "bijal_thakker_clarks_in_56048"
312        },
313        "price": 7499,
314        "price_effective": 7499,
315        "price_transfer": 0,
316        "return_config": {
317          "returnable": true,
318          "time": 15,
319          "unit": "days"
320        },
321        "seller_identifier": "5050409521991",
322        "size": "7.5",
323        "tax_identifier": {
324          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
325        },
326        "track_inventory": true,
327        "trader": [
328          {
329            "address": [
330              "dummy data"
331            ],
332            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
333            "type": "Importer"
334          }
335        ]
336      },
337      {
338        "_id": "65604051f50ddd0b7df5ec61",
339        "brand_uid": 61,
340        "company_id": 42,
341        "currency": "INR",
342        "dimensions": {
343          "item_dimensions_unit_of_measure": "cm",
344          "item_height": 32,
345          "item_length": 12,
346          "item_weight": 2000,
347          "item_weight_unit_of_measure": "gram",
348          "item_width": 22
349        },
350        "identifiers": [
351          {
352            "gtin_type": "ean",
353            "gtin_value": "5050409522035",
354            "primary": true
355          }
356        ],
357        "is_active": true,
358        "is_set": false,
359        "item_code": "26140139",
360        "item_id": 7817584,
361        "modified_by": {
362          "super_user": false,
363          "user_id": "5eb2fca2e72f8a243fbfd696",
364          "username": "bijal_thakker_clarks_in_56048"
365        },
366        "price": 7499,
367        "price_effective": 7499,
368        "price_transfer": 0,
369        "return_config": {
370          "returnable": true,
371          "time": 15,
372          "unit": "days"
373        },
374        "seller_identifier": "5050409522035",
375        "size": "9.5",
376        "tax_identifier": {
377          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
378        },
379        "track_inventory": true,
380        "trader": [
381          {
382            "address": [
383              "dummy data"
384            ],
385            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
386            "type": "Importer"
387          }
388        ]
389      },
390      {
391        "_id": "65604051f50ddd0b7df5ec5e",
392        "brand_uid": 61,
393        "company_id": 42,
394        "currency": "INR",
395        "dimensions": {
396          "item_dimensions_unit_of_measure": "cm",
397          "item_height": 32,
398          "item_length": 12,
399          "item_weight": 2000,
400          "item_weight_unit_of_measure": "gram",
401          "item_width": 22
402        },
403        "identifiers": [
404          {
405            "gtin_type": "ean",
406            "gtin_value": "5050409522004",
407            "primary": true
408          }
409        ],
410        "is_active": true,
411        "is_set": false,
412        "item_code": "26140139",
413        "item_id": 7817584,
414        "modified_by": {
415          "super_user": false,
416          "user_id": "5eb2fca2e72f8a243fbfd696",
417          "username": "bijal_thakker_clarks_in_56048"
418        },
419        "price": 7499,
420        "price_effective": 7499,
421        "price_transfer": 0,
422        "return_config": {
423          "returnable": true,
424          "time": 15,
425          "unit": "days"
426        },
427        "seller_identifier": "5050409522004",
428        "size": "8",
429        "tax_identifier": {
430          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
431        },
432        "track_inventory": true,
433        "trader": [
434          {
435            "address": [
436              "dummy data"
437            ],
438            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
439            "type": "Importer"
440          }
441        ]
442      },
443      {
444        "_id": "65604051f50ddd0b7df5ec63",
445        "brand_uid": 61,
446        "company_id": 42,
447        "currency": "INR",
448        "dimensions": {
449          "item_dimensions_unit_of_measure": "cm",
450          "item_height": 32,
451          "item_length": 12,
452          "item_weight": 2000,
453          "item_weight_unit_of_measure": "gram",
454          "item_width": 22
455        },
456        "identifiers": [
457          {
458            "gtin_type": "ean",
459            "gtin_value": "5050409522059",
460            "primary": true
461          }
462        ],
463        "is_active": true,
464        "is_set": false,
465        "item_code": "26140139",
466        "item_id": 7817584,
467        "modified_by": {
468          "super_user": false,
469          "user_id": "5eb2fca2e72f8a243fbfd696",
470          "username": "bijal_thakker_clarks_in_56048"
471        },
472        "price": 7499,
473        "price_effective": 7499,
474        "price_transfer": 0,
475        "return_config": {
476          "returnable": true,
477          "time": 15,
478          "unit": "days"
479        },
480        "seller_identifier": "5050409522059",
481        "size": "10.5",
482        "tax_identifier": {
483          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
484        },
485        "track_inventory": true,
486        "trader": [
487          {
488            "address": [
489              "dummy data"
490            ],
491            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
492            "type": "Importer"
493          }
494        ]
495      },
496      {
497        "_id": "65604051f50ddd0b7df5ec65",
498        "brand_uid": 61,
499        "company_id": 42,
500        "currency": "INR",
501        "dimensions": {
502          "item_dimensions_unit_of_measure": "cm",
503          "item_height": 32,
504          "item_length": 12,
505          "item_weight": 2000,
506          "item_weight_unit_of_measure": "gram",
507          "item_width": 22
508        },
509        "identifiers": [
510          {
511            "gtin_type": "ean",
512            "gtin_value": "5050409522073",
513            "primary": true
514          }
515        ],
516        "is_active": true,
517        "is_set": false,
518        "item_code": "26140139",
519        "item_id": 7817584,
520        "modified_by": {
521          "super_user": false,
522          "user_id": "5eb2fca2e72f8a243fbfd696",
523          "username": "bijal_thakker_clarks_in_56048"
524        },
525        "price": 7499,
526        "price_effective": 7499,
527        "price_transfer": 0,
528        "return_config": {
529          "returnable": true,
530          "time": 15,
531          "unit": "days"
532        },
533        "seller_identifier": "5050409522073",
534        "size": "12",
535        "tax_identifier": {
536          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
537        },
538        "track_inventory": true,
539        "trader": [
540          {
541            "address": [
542              "dummy data"
543            ],
544            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
545            "type": "Importer"
546          }
547        ]
548      },
549      {
550        "_id": "65604051f50ddd0b7df5ec5f",
551        "brand_uid": 61,
552        "company_id": 42,
553        "currency": "INR",
554        "dimensions": {
555          "item_dimensions_unit_of_measure": "cm",
556          "item_height": 32,
557          "item_length": 12,
558          "item_weight": 2000,
559          "item_weight_unit_of_measure": "gram",
560          "item_width": 22
561        },
562        "identifiers": [
563          {
564            "gtin_type": "ean",
565            "gtin_value": "5050409522011",
566            "primary": true
567          }
568        ],
569        "is_active": true,
570        "is_set": false,
571        "item_code": "26140139",
572        "item_id": 7817584,
573        "modified_by": {
574          "super_user": false,
575          "user_id": "5eb2fca2e72f8a243fbfd696",
576          "username": "bijal_thakker_clarks_in_56048"
577        },
578        "price": 7499,
579        "price_effective": 7499,
580        "price_transfer": 0,
581        "return_config": {
582          "returnable": true,
583          "time": 15,
584          "unit": "days"
585        },
586        "seller_identifier": "5050409522011",
587        "size": "8.5",
588        "tax_identifier": {
589          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
590        },
591        "track_inventory": true,
592        "trader": [
593          {
594            "address": [
595              "dummy data"
596            ],
597            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
598            "type": "Importer"
599          }
600        ]
601      },
602      {
603        "_id": "65604051f50ddd0b7df5ec62",
604        "brand_uid": 61,
605        "company_id": 42,
606        "currency": "INR",
607        "dimensions": {
608          "item_dimensions_unit_of_measure": "cm",
609          "item_height": 32,
610          "item_length": 12,
611          "item_weight": 2000,
612          "item_weight_unit_of_measure": "gram",
613          "item_width": 21
614        },
615        "identifiers": [
616          {
617            "gtin_type": "ean",
618            "gtin_value": "5050409522042",
619            "primary": true
620          }
621        ],
622        "is_active": true,
623        "is_set": false,
624        "item_code": "26140139",
625        "item_id": 7817584,
626        "modified_by": {
627          "super_user": false,
628          "user_id": "5eb2fca2e72f8a243fbfd696",
629          "username": "bijal_thakker_clarks_in_56048"
630        },
631        "price": 7499,
632        "price_effective": 7499,
633        "price_transfer": 0,
634        "return_config": {
635          "returnable": true,
636          "time": 15,
637          "unit": "days"
638        },
639        "seller_identifier": "5050409522042",
640        "size": "10",
641        "tax_identifier": {
642          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
643        },
644        "track_inventory": true,
645        "trader": [
646          {
647            "address": [
648              "dummy data"
649            ],
650            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
651            "type": "Importer"
652          }
653        ]
654      }
655    ]
656  }
657}

company/product-size/create/v2

this event is triggered when product-size is created

Payload
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
id
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
product-size
array of object (ProductSizeItemsCreate)
Required
Product size event.
Array of ProductSizeItemsCreate
seller_identifier
string
Required
The identifier of the seller for the product
brand_uid
integer
Required
The ID of the brand the product belongs to
item_code
string
Required
The unique item code of the product
price
number
Required
Price of the item
price_transfer
number
Transfer price of the item
identifiers
array of object
Required
List of identifiers for this product
is_set
boolean
Whether the product is a set of multiple items or not
size
string
Required
Size of the item
track_inventory
boolean
Whether to track inventory for the product or not
price_effective
number
Effective price of the item
company_id
integer
Required
The ID of the company the product belongs to
currency
string
Required
The currency used for pricing the product
return_config
object
Return configuration for the product
Properties
returnable
boolean
Required
Indicates whether the product is returnable or not
time
integer
Time duration for returns
unit
string
Unit of time for return duration
is_active
boolean
Whether the product is currently active or not
trader
array of object
Trader information.
Array of Properties
address
array of string
Required
The address of the trader.
type
string
Required
The type of trader.
name
string
Required
item_id
integer
ID of the item
dimensions
object
Dimensions of the item.
Properties
item_length
number
Length of the item in centimeters.
item_width
number
Width of the item in centimeters.
item_height
number
Height of the item in centimeters.
item_weight
number
Weight of the item in grams.
item_weight_unit_of_measure
string
Unit of measure for the item's weight (e.g., "gram").
item_dimensions_unit_of_measure
string
Unit of measure for the item's dimensions (e.g., "cm").
tax_identifier
object
Tax identifier for the product
_custom_json
object
Custom JSON data for the product
examples
Undefined Type
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      "required": [
69        "product-size"
70      ],
71      "properties": {
72        "product-size": {
73          "description": "Product size event.",
74          "type": "array",
75          "items": {
76            "$ref": "#/components/schemas/ProductSizeItemsCreate"
77          }
78        }
79      }
80    },
81    "examples": [
82      {
83        "company_id": 1202,
84        "contains": [
85          "product-size"
86        ],
87        "event": {
88          "category": "company",
89          "created_timestamp": 1712153363458,
90          "id": "LwLNywt40aw0FZSrK9CdnSo35J/3EWZnxnFT93dNyI8=",
91          "name": "product-size",
92          "trace_id": [
93            "silverbolt.c5cde860-f1c3-11ee-8e32-1670e4e67cd9"
94          ],
95          "type": "create",
96          "version": "2"
97        },
98        "payload": {
99          "product-size": [
100            {
101              "_custom_json": {},
102              "_id": "660d63135ae21da9bedc046f",
103              "brand_uid": 6828,
104              "company_id": 1202,
105              "created_on": "2024-04-03T14:09:23.026532",
106              "currency": "INR",
107              "dimensions": {
108                "item_dimensions_unit_of_measure": "cm",
109                "item_height": 10,
110                "item_length": 10,
111                "item_weight": 200,
112                "item_weight_unit_of_measure": "gram",
113                "item_width": 10
114              },
115              "identifiers": [
116                {
117                  "gtin_type": "sku_code",
118                  "gtin_value": "ABCROHINI",
119                  "primary": true
120                }
121              ],
122              "is_active": true,
123              "is_set": false,
124              "item_code": "ITEM123",
125              "item_id": 10242321,
126              "modified_by": {
127                "super_user": false,
128                "user_id": "c068a675de437e48d5db3537",
129                "username": "rohinipawar_gofynd_com_33829"
130              },
131              "modified_on": "2024-04-03T14:09:23.026537",
132              "price": 1,
133              "price_effective": 1,
134              "price_transfer": 0,
135              "return_config": {
136                "returnable": false,
137                "time": 0,
138                "unit": "days"
139              },
140              "seller_identifier": "ABCROHINI",
141              "size": "L",
142              "tax_identifier": {
143                "hsn_code_id": "65fd783dc528d7515782df49"
144              },
145              "track_inventory": true,
146              "trader": [
147                {
148                  "address": [
149                    "ABc"
150                  ],
151                  "name": "ABC",
152                  "type": "Manufacturer"
153                }
154              ]
155            }
156          ]
157        }
158      }
159    ]
160  }
161}
Payload Example
1{}

company/product-size/delete/v2

this event is triggered when product-size is deleted

Payload
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
id
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
product-size
array of object
Required
Product size event.
Array of Properties
seller_identifier
string
Required
The identifier of the seller for the product
brand_uid
integer
Required
The ID of the brand the product belongs to
item_code
string
Required
The unique item code of the product
price
number
Required
Price of the item
price_transfer
number
Transfer price of the item
identifiers
array of object
Required
List of identifiers for this product
is_set
boolean
Whether the product is a set of multiple items or not
size
string
Required
Size of the item
track_inventory
boolean
Whether to track inventory for the product or not
price_effective
number
Effective price of the item
company_id
integer
Required
The ID of the company the product belongs to
currency
string
Required
The currency used for pricing the product
dimensions
object
Dimensions of the item.
Properties
item_length
number
Length of the item in centimeters.
item_width
number
Width of the item in centimeters.
item_height
number
Height of the item in centimeters.
item_weight
number
Weight of the item in grams.
item_weight_unit_of_measure
string
Unit of measure for the item's weight (e.g., "gram").
item_dimensions_unit_of_measure
string
Unit of measure for the item's dimensions (e.g., "cm").
_custom_json
object
Custom JSON data for the product ( can contain any key value pair )
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      "required": [
69        "product-size"
70      ],
71      "properties": {
72        "product-size": {
73          "description": "Product size event.",
74          "type": "array",
75          "items": {
76            "type": "object",
77            "required": [
78              "seller_identifier",
79              "item_code",
80              "price",
81              "identifiers",
82              "size",
83              "company_id",
84              "currency",
85              "brand_uid"
86            ],
87            "properties": {
88              "seller_identifier": {
89                "type": "string",
90                "description": "The identifier of the seller for the product"
91              },
92              "brand_uid": {
93                "type": "integer",
94                "description": "The ID of the brand the product belongs to"
95              },
96              "item_code": {
97                "type": "string",
98                "description": "The unique item code of the product"
99              },
100              "price": {
101                "type": "number",
102                "description": "Price of the item"
103              },
104              "price_transfer": {
105                "type": "number",
106                "description": "Transfer price of the item"
107              },
108              "identifiers": {
109                "type": "array",
110                "items": {
111                  "type": "object"
112                },
113                "description": "List of identifiers for this product"
114              },
115              "is_set": {
116                "type": "boolean",
117                "description": "Whether the product is a set of multiple items or not"
118              },
119              "size": {
120                "type": "string",
121                "description": "Size of the item"
122              },
123              "track_inventory": {
124                "type": "boolean",
125                "description": "Whether to track inventory for the product or not"
126              },
127              "price_effective": {
128                "type": "number",
129                "description": "Effective price of the item"
130              },
131              "company_id": {
132                "type": "integer",
133                "description": "The ID of the company the product belongs to"
134              },
135              "currency": {
136                "type": "string",
137                "description": "The currency used for pricing the product"
138              },
139              "dimensions": {
140                "type": "object",
141                "description": "Dimensions of the item.",
142                "properties": {
143                  "item_length": {
144                    "type": "number",
145                    "description": "Length of the item in centimeters."
146                  },
147                  "item_width": {
148                    "type": "number",
149                    "description": "Width of the item in centimeters."
150                  },
151                  "item_height": {
152                    "type": "number",
153                    "description": "Height of the item in centimeters."
154                  },
155                  "item_weight": {
156                    "type": "number",
157                    "description": "Weight of the item in grams."
158                  },
159                  "item_weight_unit_of_measure": {
160                    "type": "string",
161                    "description": "Unit of measure for the item's weight (e.g., \"gram\")."
162                  },
163                  "item_dimensions_unit_of_measure": {
164                    "type": "string",
165                    "description": "Unit of measure for the item's dimensions (e.g., \"cm\")."
166                  }
167                }
168              },
169              "_custom_json": {
170                "type": "object",
171                "description": "Custom JSON data for the product ( can contain any key value pair )"
172              }
173            }
174          }
175        }
176      }
177    }
178  }
179}
Payload Example
1{
2  "company_id": 1202,
3  "contains": [
4    "product-size"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1712153387199,
9    "id": "OmEm07QXl8nfqOvqB5KLTpmVjBQ7CzoT8q3FULcyqhU=",
10    "name": "product-size",
11    "trace_id": [
12      "silverbolt.d3f47256-f1c3-11ee-b8a2-2aedd5776368"
13    ],
14    "type": "delete",
15    "version": "2"
16  },
17  "payload": {
18    "product-size": [
19      {
20        "_custom_json": {},
21        "_id": "660d63135ae21da9bedc046f",
22        "brand_uid": 6828,
23        "company_id": 1202,
24        "created_on": "2024-04-03T14:09:23.026000",
25        "currency": "INR",
26        "dimensions": {
27          "item_dimensions_unit_of_measure": "cm",
28          "item_height": 10,
29          "item_length": 10,
30          "item_weight": 200,
31          "item_weight_unit_of_measure": "gram",
32          "item_width": 10
33        },
34        "identifiers": [
35          {
36            "gtin_type": "sku_code",
37            "gtin_value": "ABCROHINI",
38            "primary": true
39          }
40        ],
41        "is_set": false,
42        "item_code": "ITEM123",
43        "modified_on": "2024-04-03T14:09:23.026000",
44        "price": 1,
45        "price_effective": 1,
46        "price_transfer": 0,
47        "seller_identifier": "ABCROHINI",
48        "size": "L",
49        "track_inventory": true
50      }
51    ]
52  }
53}

company/product-size/update/v2

this event is triggered when product-size is updated

Payload
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
id
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
product-size
array of object (ProductSizeItemsUpdate)
Required
Product size event.
Array of ProductSizeItemsUpdate
seller_identifier
string
Required
The identifier of the seller for the product
brand_uid
integer
Required
The ID of the brand the product belongs to
item_code
string
Required
The unique item code of the product
price
number
Required
Price of the item
price_transfer
number
Transfer price of the item
identifiers
array of object
Required
List of identifiers for this product
is_set
boolean
Whether the product is a set of multiple items or not
size
string
Required
Size of the item
track_inventory
boolean
Whether to track inventory for the product or not
price_effective
number
Effective price of the item
company_id
integer
Required
The ID of the company the product belongs to
currency
string
Required
The currency used for pricing the product
return_config
object
Return configuration for the product
Properties
returnable
boolean
Required
Indicates whether the product is returnable or not
time
integer
Time duration for returns
unit
string
Unit of time for return duration
is_active
boolean
Whether the product is currently active or not
trader
array of object
Trader information.
Array of Properties
address
array of string
Required
The address of the trader.
type
string
Required
The type of trader.
name
string
Required
The name of the trader.
item_id
integer
ID of the item
dimensions
object
Dimensions of the item.
Properties
item_length
number
Length of the item in centimeters.
item_width
number
Width of the item in centimeters.
item_height
number
Height of the item in centimeters.
item_weight
number
Weight of the item in grams.
item_weight_unit_of_measure
string
Unit of measure for the item's weight (e.g., "gram").
item_dimensions_unit_of_measure
string
Unit of measure for the item's dimensions (e.g., "cm").
tax_identifier
object
Tax identifier for the product.
Properties
hsn_code_id
string
The ID of the HSN code associated with the tax.
_custom_json
object
Custom JSON data for the product ( can contain any key value pair )
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      "required": [
69        "product-size"
70      ],
71      "properties": {
72        "product-size": {
73          "description": "Product size event.",
74          "type": "array",
75          "items": {
76            "$ref": "#/components/schemas/ProductSizeItemsUpdate"
77          }
78        }
79      }
80    }
81  }
82}
Payload Example
1{
2  "company_id": 61,
3  "contains": [
4    "product-size"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1712154264754,
9    "id": "jacASbiBamNt03oJY8fhPR3jldli6MvEKUI4V7BuF0s=",
10    "name": "product-size",
11    "trace_id": [
12      "silverbolt.df04b82a-f1c5-11ee-9e4c-763a730613a4"
13    ],
14    "type": "update",
15    "version": "2"
16  },
17  "payload": {
18    "product-size": [
19      {
20        "_id": "632b032b75cc43f40b76dd09",
21        "brand_uid": 9,
22        "company_id": 61,
23        "currency": "INR",
24        "dimensions": {
25          "item_dimensions_unit_of_measure": "cm",
26          "item_height": 10,
27          "item_length": 25,
28          "item_weight": 999,
29          "item_weight_unit_of_measure": "gram",
30          "item_width": 15
31        },
32        "identifiers": [
33          {
34            "gtin_type": "upc",
35            "gtin_value": "4062449708363",
36            "primary": true
37          }
38        ],
39        "is_active": false,
40        "is_set": false,
41        "item_code": "59647801",
42        "item_id": 1166914,
43        "modified_by": {
44          "super_user": false,
45          "user_id": "2a47b6bea80fa72b90894a6f",
46          "username": "ravindrasinghr_gofynd_com_33020"
47        },
48        "price": 1999,
49        "price_effective": 999.5,
50        "price_transfer": 0,
51        "return_config": {
52          "returnable": true,
53          "time": 7,
54          "unit": "days"
55        },
56        "seller_identifier": "4062449708363",
57        "size": "S",
58        "tax_identifier": {
59          "hsn_code_id": "6277837c5e4c6fdbc8be3e93"
60        },
61        "track_inventory": true,
62        "trader": [
63          {
64            "address": [
65              "dummy data"
66            ],
67            "name": "PUMA Sports India Private Limited",
68            "type": "Manufacturer"
69          }
70        ]
71      },
72      {
73        "_id": "632b032b75cc43f40b76dd0a",
74        "brand_uid": 9,
75        "company_id": 61,
76        "currency": "INR",
77        "dimensions": {
78          "item_dimensions_unit_of_measure": "cm",
79          "item_height": 10,
80          "item_length": 25,
81          "item_weight": 999,
82          "item_weight_unit_of_measure": "gram",
83          "item_width": 15
84        },
85        "identifiers": [
86          {
87            "gtin_type": "upc",
88            "gtin_value": "4062449708370",
89            "primary": true
90          }
91        ],
92        "is_active": false,
93        "is_set": false,
94        "item_code": "59647801",
95        "item_id": 1166914,
96        "modified_by": {
97          "super_user": false,
98          "user_id": "2a47b6bea80fa72b90894a6f",
99          "username": "ravindrasinghr_gofynd_com_33020"
100        },
101        "price": 1999,
102        "price_effective": 999.5,
103        "price_transfer": 0,
104        "return_config": {
105          "returnable": true,
106          "time": 7,
107          "unit": "days"
108        },
109        "seller_identifier": "4062449708370",
110        "size": "M",
111        "tax_identifier": {
112          "hsn_code_id": "6277837c5e4c6fdbc8be3e93"
113        },
114        "track_inventory": true,
115        "trader": [
116          {
117            "address": [
118              "dummy data"
119            ],
120            "name": "PUMA Sports India Private Limited",
121            "type": "Manufacturer"
122          }
123        ]
124      },
125      {
126        "_id": "632b032b75cc43f40b76dd0b",
127        "brand_uid": 9,
128        "company_id": 61,
129        "currency": "INR",
130        "dimensions": {
131          "item_dimensions_unit_of_measure": "cm",
132          "item_height": 10,
133          "item_length": 25,
134          "item_weight": 999,
135          "item_weight_unit_of_measure": "gram",
136          "item_width": 15
137        },
138        "identifiers": [
139          {
140            "gtin_type": "upc",
141            "gtin_value": "4062449708332",
142            "primary": true
143          }
144        ],
145        "is_active": false,
146        "is_set": false,
147        "item_code": "59647801",
148        "item_id": 1166914,
149        "modified_by": {
150          "super_user": false,
151          "user_id": "2a47b6bea80fa72b90894a6f",
152          "username": "ravindrasinghr_gofynd_com_33020"
153        },
154        "price": 1999,
155        "price_effective": 999.5,
156        "price_transfer": 0,
157        "return_config": {
158          "returnable": true,
159          "time": 7,
160          "unit": "days"
161        },
162        "seller_identifier": "4062449708332",
163        "size": "L",
164        "tax_identifier": {
165          "hsn_code_id": "6277837c5e4c6fdbc8be3e93"
166        },
167        "track_inventory": true,
168        "trader": [
169          {
170            "address": [
171              "dummy data"
172            ],
173            "name": "PUMA Sports India Private Limited",
174            "type": "Manufacturer"
175          }
176        ]
177      },
178      {
179        "_id": "632b032b75cc43f40b76dd0c",
180        "brand_uid": 9,
181        "company_id": 61,
182        "currency": "INR",
183        "dimensions": {
184          "item_dimensions_unit_of_measure": "cm",
185          "item_height": 10,
186          "item_length": 25,
187          "item_weight": 999,
188          "item_weight_unit_of_measure": "gram",
189          "item_width": 15
190        },
191        "identifiers": [
192          {
193            "gtin_type": "upc",
194            "gtin_value": "4062449708349",
195            "primary": true
196          }
197        ],
198        "is_active": false,
199        "is_set": false,
200        "item_code": "59647801",
201        "item_id": 1166914,
202        "modified_by": {
203          "super_user": false,
204          "user_id": "2a47b6bea80fa72b90894a6f",
205          "username": "ravindrasinghr_gofynd_com_33020"
206        },
207        "price": 1999,
208        "price_effective": 999.5,
209        "price_transfer": 0,
210        "return_config": {
211          "returnable": true,
212          "time": 7,
213          "unit": "days"
214        },
215        "seller_identifier": "4062449708349",
216        "size": "XL",
217        "tax_identifier": {
218          "hsn_code_id": "6277837c5e4c6fdbc8be3e93"
219        },
220        "track_inventory": true,
221        "trader": [
222          {
223            "address": [
224              "dummy data"
225            ],
226            "name": "PUMA Sports India Private Limited",
227            "type": "Manufacturer"
228          }
229        ]
230      }
231    ]
232  }
233}

Product

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

Events
company/product/delete/v1
# this event is triggered when product is deleted
company/product/create/v2
# this event is triggered when product is created
company/product/delete/v2
# this event is triggered when product is deleted
company/product/update/v2
# this event is triggered when product is updated
company/product/create/v3
# this event is triggered when product is created
company/product/delete/v3
# this event is triggered when product is deleted
company/product/update/v3
# this event is triggered when product is updated

company/product/delete/v1

this event is triggered when product is deleted

Payload
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
id
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
product
object
Required
Information about a product.
Properties
uid
integer
Required
The unique identifier of the product.
company_id
integer
Required
ID of the company associated with the product.
archived_by
object
Information about the user who archived the product.
Properties
username
string
Username of the user who archived the product.
user_id
string
Unique identifier of the user who archived the product.
brand_uid
integer
Required
Unique ID of the brand associated with the product.
item_code
string
Required
Item code for the product.
archived_on
string
timestamp indicating the date and time when the product was archived.
trader
array of object
Trader associated with the product.
Array of Properties
address
array of string
Address of the trader
name
string
Name of the trader
type
string
Type of the trader
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      "required": [
69        "product"
70      ],
71      "properties": {
72        "product": {
73          "type": "object",
74          "required": [
75            "uid",
76            "company_id",
77            "brand_uid",
78            "item_code"
79          ],
80          "properties": {
81            "uid": {
82              "type": "integer",
83              "description": "The unique identifier of the product."
84            },
85            "company_id": {
86              "type": "integer",
87              "description": "ID of the company associated with the product."
88            },
89            "archived_by": {
90              "type": "object",
91              "properties": {
92                "username": {
93                  "type": "string",
94                  "description": "Username of the user who archived the product."
95                },
96                "user_id": {
97                  "type": "string",
98                  "description": "Unique identifier of the user who archived the product."
99                }
100              },
101              "description": "Information about the user who archived the product."
102            },
103            "brand_uid": {
104              "type": "integer",
105              "description": "Unique ID of the brand associated with the product."
106            },
107            "item_code": {
108              "type": "string",
109              "description": "Item code for the product."
110            },
111            "archived_on": {
112              "type": "string",
113              "description": "timestamp indicating the date and time when the product was archived."
114            },
115            "trader": {
116              "type": "array",
117              "description": "Trader associated with the product.",
118              "items": {
119                "type": "object",
120                "properties": {
121                  "address": {
122                    "type": "array",
123                    "items": {
124                      "type": "string"
125                    },
126                    "description": "Address of the trader"
127                  },
128                  "name": {
129                    "type": "string",
130                    "description": "Name of the trader"
131                  },
132                  "type": {
133                    "type": "string",
134                    "description": "Type of the trader"
135                  }
136                }
137              }
138            }
139          },
140          "description": "Information about a product."
141        }
142      }
143    }
144  }
145}
Payload Example
1{
2  "company_id": 4783,
3  "contains": [
4    "product"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1711783668305,
9    "id": "EhVZ51QLyjt9/uu8Pvr6xpxkocJgfqwnAeNESC7D6HA=",
10    "name": "product",
11    "trace_id": [
12      "silverbolt.0252455c-ee67-11ee-acfd-9a2d2b7b7bb5"
13    ],
14    "type": "delete",
15    "version": "1"
16  },
17  "payload": {
18    "product": {
19      "action": "delete",
20      "all_company_ids": [
21        4783
22      ],
23      "all_identifiers": [
24        "00154GR_41"
25      ],
26      "all_sizes": [
27        {
28          "identifiers": [
29            {
30              "gtin_type": "sku_code",
31              "gtin_value": "00154GR_41",
32              "primary": true
33            }
34          ],
35          "item_dimensions_unit_of_measure": "cm",
36          "item_height": 10,
37          "item_length": 27,
38          "item_weight": 400,
39          "item_weight_unit_of_measure": "gram",
40          "item_width": 14,
41          "size": "41"
42        }
43      ],
44      "arch_type": "Medium",
45      "archived_by": {
46        "super_user": false,
47        "user_id": "3778a7cea3f9b623335768bd",
48        "username": "adilsayyed1348_gmail_com_02751"
49      },
50      "archived_on": "2024-03-30T07:27:48.298070Z",
51      "batch_id": "6607be3e50ec55c7b12d81b4",
52      "brand_uid": 5981,
53      "category_slug": "flat-slip-ons",
54      "category_uid": 292,
55      "closure_type": "Slip On",
56      "command": "delete",
57      "company_id": 4783,
58      "country_of_origin": "India",
59      "currency": "INR",
60      "custom_order": {
61        "is_custom_order": false,
62        "manufacturing_time": 0,
63        "manufacturing_time_unit": "days"
64      },
65      "departments": [
66        21
67      ],
68      "description": "",
69      "essential": "No",
70      "gender": [
71        "Women"
72      ],
73      "is_active": true,
74      "is_bulk": true,
75      "is_dependent": false,
76      "is_image_less_product": true,
77      "is_set": false,
78      "item_code": "00154GR_41",
79      "item_type": "standard",
80      "marketer-address": "address",
81      "marketer-name": "Ritebrand",
82      "multi_size": true,
83      "name": "Sawadi Chappals for Women",
84      "net-quantity": "1 N",
85      "net_quantity": {
86        "unit": "pack",
87        "value": 1
88      },
89      "no_of_boxes": 1,
90      "packaging-type": "Brand Box",
91      "primary_color": "Grey",
92      "primary_material": "Synthetic",
93      "product_publish": {
94        "is_set": false,
95        "product_online_date": "2024-03-27T11:14:57.096000"
96      },
97      "return_config": {
98        "returnable": false,
99        "time": 0,
100        "unit": "days"
101      },
102      "sizes": [],
103      "slug": "sawadi-chappals-for-women-10198392",
104      "stage": "pending",
105      "tags": [],
106      "tax_identifier": {
107        "hsn_code": "64041110",
108        "hsn_code_id": "627783935e4c6fdbc8be40e1",
109        "reporting_hsn": "64041110H1"
110      },
111      "template_tag": "footwear",
112      "trader": [
113        {
114          "address": [
115            "Address"
116          ],
117          "name": "Address",
118          "type": "Importer"
119        }
120      ],
121      "uid": 10198392,
122      "variants": {}
123    }
124  }
125}

company/product/create/v2

this event is triggered when product is created

Payload
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
id
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
product
object
Required
Information about a product.
Properties
currency
string
Currency of the product.
product_group_tag
array of string
Tag associated with the product group.
name
string
Required
Name of the product.
tags
array of string
List of tags associated with the product.
slug
string
Required
Unique slug for the product.
variant_media
object
A dictionary of media files associated with each variant of the product.
teaser_tag
object
Teaser tag for the product.
trader
array|object
Trader associated with the product.
trader_type
string
The type of trader associated with the product.
description
string
Description of the product.
return_config
object
Required
Return policy information for the product.
Properties
returnable
boolean
Required
Flag indicating if the product is returnable or not.
time
integer
The time within which the product can be returned, in the specified time unit.
unit
string
The unit of time used to measure the time within which the product can be returned.
departments
array of integer
Required
List of department IDs associated with the product.
product_publish
object
Required
Information about the product publication status.
Properties
product_online_date
string
Required
Unix timestamp indicating the date and time when the product was published online.
is_set
boolean
Required
Flag to indicate if the product is published online or not.
is_dependent
boolean
Required
Flag to indicate if the product is dependent on other products or not.
highlights
array of string
A list of highlights or special features associated with the product.
size_guide
string
URL to the size guide for the product.
no_of_boxes
integer
Required
Number of boxes containing the product.
company_id
integer
Required
ID of the company associated with the product.
variants
object
A dictionary of product variants, where the keys are variant names and the values are variant details.
category_slug
string
Slug of the category associated with the product.
media
array of object
List of media information associated with the product.
Array of Properties
type
string
url
string
uid
integer
Required
The unique identifier of the product.
template_tag
string
Required
The tag used for the product template.
short_description
string
A short description of the product, limited to 50 characters.
category_uid
integer
Required
The unique identifier of the category that the product belongs to.
item_code
string
Required
Item code for the product.
multi_size
boolean
Required
Flag to indicate if the product has multiple sizes or not.
is_set
boolean
Required
Flag to indicate if the product is a set or not.
net_quantity
object
A nested object representing the net quantity of the product.
brand_uid
integer
Required
Unique ID of the brand associated with the product.
is_active
boolean
Required
A boolean indicating whether the product is currently active or not.
is_image_less_product
boolean
Required
Flag to indicate if the product has no image or not.
custom_order
object
Required
Custom order information for the product.
Properties
manufacturing_time_unit
string
Required
The unit of time used to measure the time required to manufacture the product.
is_custom_order
boolean
Required
Flag indicating if the product is a custom order or not.
manufacturing_time
integer
Required
The time required to manufacture the product, in the specified time unit.
tax_identifier
object
Required
Tax identifier for the product.
Properties
hsn_code
string
Required
The HSN (Harmonized System of Nomenclature) code associated with the product.
hsn_code_id
string
Required
ID of the HSN code associated with the product.
reporting_hsn
string
Required
Reporting HSN for the product.
country_of_origin
string
Required
Country of origin for the product.
item_type
string
Required
Type of the product.
_custom_json
object
A dictionary of custom JSON data associated with the product.
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      "required": [
69        "product"
70      ],
71      "properties": {
72        "product": {
73          "type": "object",
74          "required": [
75            "name",
76            "return_config",
77            "product_publish",
78            "is_dependent",
79            "no_of_boxes",
80            "company_id",
81            "uid",
82            "template_tag",
83            "category_uid",
84            "item_code",
85            "multi_size",
86            "is_set",
87            "brand_uid",
88            "is_active",
89            "is_image_less_product",
90            "custom_order",
91            "tax_identifier",
92            "country_of_origin",
93            "item_type",
94            "departments",
95            "slug"
96          ],
97          "properties": {
98            "currency": {
99              "type": "string",
100              "description": "Currency of the product."
101            },
102            "product_group_tag": {
103              "type": "array",
104              "description": "Tag associated with the product group.",
105              "items": {
106                "type": "string"
107              }
108            },
109            "name": {
110              "type": "string",
111              "description": "Name of the product."
112            },
113            "tags": {
114              "type": "array",
115              "description": "List of tags associated with the product.",
116              "items": {
117                "type": "string"
118              }
119            },
120            "slug": {
121              "type": "string",
122              "description": "Unique slug for the product."
123            },
124            "variant_media": {
125              "type": "object",
126              "description": "A dictionary of media files associated with each variant of the product."
127            },
128            "teaser_tag": {
129              "type": "object",
130              "description": "Teaser tag for the product."
131            },
132            "trader": {
133              "type": [
134                "array",
135                "object"
136              ],
137              "description": "Trader associated with the product."
138            },
139            "trader_type": {
140              "type": "string",
141              "description": "The type of trader associated with the product."
142            },
143            "description": {
144              "type": "string",
145              "description": "Description of the product."
146            },
147            "return_config": {
148              "type": "object",
149              "required": [
150                "returnable"
151              ],
152              "properties": {
153                "returnable": {
154                  "type": "boolean",
155                  "description": "Flag indicating if the product is returnable or not."
156                },
157                "time": {
158                  "type": "integer",
159                  "description": "The time within which the product can be returned, in the specified time unit."
160                },
161                "unit": {
162                  "type": "string",
163                  "description": "The unit of time used to measure the time within which the product can be returned."
164                }
165              },
166              "description": "Return policy information for the product."
167            },
168            "departments": {
169              "type": "array",
170              "items": {
171                "type": "integer",
172                "description": "Departments associated with the product"
173              },
174              "description": "List of department IDs associated with the product."
175            },
176            "product_publish": {
177              "type": "object",
178              "required": [
179                "product_online_date",
180                "is_set"
181              ],
182              "properties": {
183                "product_online_date": {
184                  "type": "string",
185                  "description": "Unix timestamp indicating the date and time when the product was published online."
186                },
187                "is_set": {
188                  "type": "boolean",
189                  "description": "Flag to indicate if the product is published online or not."
190                }
191              },
192              "description": "Information about the product publication status."
193            },
194            "is_dependent": {
195              "type": "boolean",
196              "description": "Flag to indicate if the product is dependent on other products or not."
197            },
198            "highlights": {
199              "type": "array",
200              "items": {
201                "type": "string",
202                "description": "Highlights or features of the product"
203              },
204              "description": "A list of highlights or special features associated with the product."
205            },
206            "size_guide": {
207              "type": "string",
208              "description": "URL to the size guide for the product."
209            },
210            "no_of_boxes": {
211              "type": "integer",
212              "description": "Number of boxes containing the product."
213            },
214            "company_id": {
215              "type": "integer",
216              "description": "ID of the company associated with the product."
217            },
218            "variants": {
219              "type": "object",
220              "description": "A dictionary of product variants, where the keys are variant names and the values are variant details."
221            },
222            "category_slug": {
223              "type": "string",
224              "description": "Slug of the category associated with the product."
225            },
226            "media": {
227              "type": "array",
228              "items": {
229                "type": "object",
230                "properties": {
231                  "type": {
232                    "type": "string"
233                  },
234                  "url": {
235                    "type": "string"
236                  }
237                },
238                "description": "Media URLs associated with the product"
239              },
240              "description": "List of media information associated with the product."
241            },
242            "uid": {
243              "type": "integer",
244              "description": "The unique identifier of the product."
245            },
246            "template_tag": {
247              "type": "string",
248              "description": "The tag used for the product template."
249            },
250            "short_description": {
251              "type": "string",
252              "description": "A short description of the product, limited to 50 characters."
253            },
254            "category_uid": {
255              "type": "integer",
256              "description": "The unique identifier of the category that the product belongs to."
257            },
258            "item_code": {
259              "type": "string",
260              "description": "Item code for the product."
261            },
262            "multi_size": {
263              "type": "boolean",
264              "description": "Flag to indicate if the product has multiple sizes or not."
265            },
266            "is_set": {
267              "type": "boolean",
268              "description": "Flag to indicate if the product is a set or not."
269            },
270            "net_quantity": {
271              "type": "object",
272              "description": "A nested object representing the net quantity of the product."
273            },
274            "brand_uid": {
275              "type": "integer",
276              "description": "Unique ID of the brand associated with the product."
277            },
278            "is_active": {
279              "type": "boolean",
280              "description": "A boolean indicating whether the product is currently active or not."
281            },
282            "is_image_less_product": {
283              "type": "boolean",
284              "description": "Flag to indicate if the product has no image or not."
285            },
286            "custom_order": {
287              "type": "object",
288              "required": [
289                "manufacturing_time_unit",
290                "is_custom_order",
291                "manufacturing_time"
292              ],
293              "properties": {
294                "manufacturing_time_unit": {
295                  "type": "string",
296                  "description": "The unit of time used to measure the time required to manufacture the product."
297                },
298                "is_custom_order": {
299                  "type": "boolean",
300                  "description": "Flag indicating if the product is a custom order or not."
301                },
302                "manufacturing_time": {
303                  "type": "integer",
304                  "description": "The time required to manufacture the product, in the specified time unit."
305                }
306              },
307              "description": "Custom order information for the product."
308            },
309            "tax_identifier": {
310              "type": "object",
311              "required": [
312                "hsn_code",
313                "hsn_code_id",
314                "reporting_hsn"
315              ],
316              "properties": {
317                "hsn_code": {
318                  "type": "string",
319                  "description": "The HSN (Harmonized System of Nomenclature) code associated with the product."
320                },
321                "hsn_code_id": {
322                  "type": "string",
323                  "description": "ID of the HSN code associated with the product."
324                },
325                "reporting_hsn": {
326                  "type": "string",
327                  "description": "Reporting HSN for the product."
328                }
329              },
330              "description": "Tax identifier for the product."
331            },
332            "country_of_origin": {
333              "type": "string",
334              "description": "Country of origin for the product."
335            },
336            "item_type": {
337              "type": "string",
338              "description": "Type of the product."
339            },
340            "_custom_json": {
341              "type": "object",
342              "description": "A dictionary of custom JSON data associated with the product."
343            }
344          },
345          "description": "Information about a product."
346        }
347      }
348    }
349  }
350}
Payload Example
1{
2  "company_id": 870,
3  "contains": [
4    "product"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1712233141003,
9    "id": "9VyIIXlQBs9TUeOweV5cWlrKtaFONuxxbmZ4W9TzJxs=",
10    "name": "product",
11    "trace_id": [
12      "silverbolt.84ed2de6-f27d-11ee-8212-4a604ef2479a"
13    ],
14    "type": "create",
15    "version": "2"
16  },
17  "payload": {
18    "product": {
19      "action": "upsert",
20      "adjustable": null,
21      "body-type": null,
22      "brand_uid": 51,
23      "capacity": null,
24      "care_instructions": null,
25      "category_slug": "sling-bags",
26      "category_uid": 352,
27      "clasp_type": null,
28      "closure_type": null,
29      "color": null,
30      "company_id": 870,
31      "compartments": null,
32      "country_of_origin": "India",
33      "currency": "INR",
34      "custom-attribute-1": null,
35      "custom-attribute-2": null,
36      "custom-attribute-3": null,
37      "custom-attribute-4": null,
38      "custom-attribute-5": null,
39      "custom_order": {
40        "is_custom_order": false,
41        "manufacturing_time": 0,
42        "manufacturing_time_unit": "days"
43      },
44      "departments": [
45        21
46      ],
47      "essential": "No",
48      "features": null,
49      "gender": [
50        "Men"
51      ],
52      "generic-name": null,
53      "handles-type": null,
54      "import-month-and-year": null,
55      "inner_material": null,
56      "internal-pocket": null,
57      "is_active": true,
58      "is_dependent": false,
59      "is_image_less_product": true,
60      "is_set": false,
61      "item-details": null,
62      "item-dimension-depth-value": null,
63      "item-dimension-height-value": null,
64      "item-dimension-width-value": null,
65      "item_code": "SB-0019FOLIVEWAX",
66      "item_type": "standard",
67      "lifestyle": null,
68      "lock-type": null,
69      "marketer-address": "dummy data",
70      "marketer-name": "Da Milano Leathers Pvt Ltd",
71      "material": null,
72      "multi_size": true,
73      "name": "Da Milano Genuine Leather Green Sling Bags Mens",
74      "net-quantity": "1 N",
75      "no_of_boxes": 1,
76      "occasion": null,
77      "outer_material": null,
78      "package_contents": null,
79      "padded-shoulder-strap": null,
80      "pattern": null,
81      "primary-colour-hex-code": null,
82      "primary_color": "Green",
83      "primary_material": "Leather",
84      "product-dimensions": null,
85      "product_publish": {
86        "is_set": false,
87        "product_online_date": "2024-04-04T12:18:47.192000+00:00"
88      },
89      "return_config": {
90        "returnable": true,
91        "time": 15,
92        "unit": "days"
93      },
94      "season": null,
95      "side-pocket": null,
96      "slug": "da-milano-genuine-leather-green-sling-bags-mens",
97      "strap_type": null,
98      "style": null,
99      "sustainable": null,
100      "tags": [],
101      "tax_identifier": {
102        "hsn_code": "42021190",
103        "hsn_code_id": "6277846d5e4c6fdbc8be5478",
104        "reporting_hsn": "42021190H1"
105      },
106      "template_tag": "bags",
107      "trader": [
108        {
109          "address": [
110            "Plot No.- 86, Phase- 1, Udyog Vihar, Gurgaon, Haryana- 122016"
111          ],
112          "name": "The Craftmode",
113          "type": "Manufacturer"
114        }
115      ],
116      "trends": null,
117      "uid": 10244513,
118      "variants": {},
119      "warranty": null,
120      "warranty-domestic-international": null,
121      "warranty_type": null,
122      "water_resistant": null,
123      "wheels": null
124    }
125  }
126}

company/product/delete/v2

this event is triggered when product is deleted

Payload
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
id
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
product
object
Required
Information about a product.
Properties
uid
integer
Required
The unique identifier of the product.
company_id
integer
Required
ID of the company associated with the product.
archived_by
object
Information about the user who archived the product.
Properties
username
string
Username of the user who archived the product.
user_id
string
Unique identifier of the user who archived the product.
brand_uid
integer
Required
Unique ID of the brand associated with the product.
item_code
string
Required
Item code for the product.
archived_on
string
timestamp indicating the date and time when the product was archived.
trader
array|object
Trader associated with the product.
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      "required": [
69        "product"
70      ],
71      "properties": {
72        "product": {
73          "type": "object",
74          "required": [
75            "uid",
76            "company_id",
77            "brand_uid",
78            "item_code"
79          ],
80          "properties": {
81            "uid": {
82              "type": "integer",
83              "description": "The unique identifier of the product."
84            },
85            "company_id": {
86              "type": "integer",
87              "description": "ID of the company associated with the product."
88            },
89            "archived_by": {
90              "type": "object",
91              "properties": {
92                "username": {
93                  "type": "string",
94                  "description": "Username of the user who archived the product."
95                },
96                "user_id": {
97                  "type": "string",
98                  "description": "Unique identifier of the user who archived the product."
99                }
100              },
101              "description": "Information about the user who archived the product."
102            },
103            "brand_uid": {
104              "type": "integer",
105              "description": "Unique ID of the brand associated with the product."
106            },
107            "item_code": {
108              "type": "string",
109              "description": "Item code for the product."
110            },
111            "archived_on": {
112              "type": "string",
113              "description": "timestamp indicating the date and time when the product was archived."
114            },
115            "trader": {
116              "type": [
117                "array",
118                "object"
119              ],
120              "description": "Trader associated with the product."
121            }
122          },
123          "description": "Information about a product."
124        }
125      }
126    }
127  }
128}
Payload Example
1{
2  "company_id": 3874,
3  "contains": [
4    "product"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1711617459833,
9    "id": "VmvuZVgOdmeQQUY1jB3w4Edaw9tK3c3vzhP5W8WhRIs=",
10    "name": "product",
11    "trace_id": [
12      "silverbolt.065a23b0-ece4-11ee-89ab-82eef758c83a"
13    ],
14    "type": "delete",
15    "version": "2"
16  },
17  "payload": {
18    "product": {
19      "archived_by": {
20        "user_id": "07a2eaa6e940f674a92ba0f2",
21        "username": "akhileshashok_gofynd_com_15007"
22      },
23      "archived_on": "2024-03-28T09:17:39.829738Z",
24      "brand_uid": 6123,
25      "company_id": 3874,
26      "item_code": "TESTBAG",
27      "trader": [
28        {
29          "address": [
30            "Address"
31          ],
32          "name": "Address",
33          "type": "Importer"
34        }
35      ],
36      "uid": 10199729
37    }
38  }
39}

company/product/update/v2

this event is triggered when product is updated

Payload
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
id
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
product
object
Required
Properties
currency
string
Currency used for pricing
product_group_tag
array of string
Tags for grouping products
name
string
Required
Name of the product
tags
array of string
Additional tags for the product
slug
string
Required
Slug for the product
variant_media
object
Media related to product variants
teaser_tag
object
Tag for teaser related to the product
trader
array|object
Information about traders associated with the product
trader_type
string
Type of trader
description
string
Complete description of the product
return_config
object
Required
Configuration for product returns
Properties
returnable
boolean
Required
Whether the product is returnable
time
integer
Time period for returns
unit
string
Unit of time for returns
departments
array of integer
Required
Departments associated with the product
product_publish
object
Required
Publishing information for the product
Properties
product_online_date
string
Required
Date when the product goes online
is_set
boolean
Required
Whether the product is a set
is_dependent
boolean
Required
Whether the product is dependent and cannot be sold separately
highlights
array of string
Highlights or key features of the product
size_guide
string
Size guide information for the product
no_of_boxes
integer
Required
Number of boxes the product contains
company_id
integer
Required
Identifier for the company
variants
object
Variants of the product
category_slug
string
Slug for the product category
media
array of object
Media related to the product
Array of Properties
type
string
url
string
uid
integer
Required
Unique identifier for the product
template_tag
string
Required
Tag for product template
short_description
string
Brief description of the product
category_uid
integer
Required
Identifier for the product category
item_code
string
Required
Unique code assigned to the product
multi_size
boolean
Required
Whether the product contains multiple sizes
is_set
boolean
Required
Whether the product is a set
net_quantity
object
Net quantity information for the product
brand_uid
integer
Required
Identifier for the brand or manufacturer of the product
is_active
boolean
Required
Active status of the product
is_image_less_product
boolean
Required
Whether the product has no image
custom_order
object
Required
Custom order details for the product
Properties
manufacturing_time_unit
string
Required
Unit of manufacturing time
is_custom_order
boolean
Required
Whether the product is a custom order
manufacturing_time
integer
Required
Manufacturing time for the product
tax_identifier
object
Required
Tax identifier details for the product
Properties
hsn_code
string
Required
HSN code for taxation purpose
hsn_code_id
string
Required
ID for the HSN code
reporting_hsn
string
Required
Reporting HSN code
country_of_origin
string
Required
Country where the product was manufactured
item_type
string
Required
Type of the product
_custom_json
object
Custom JSON data for the product
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      "required": [
69        "product"
70      ],
71      "properties": {
72        "product": {
73          "type": "object",
74          "required": [
75            "name",
76            "return_config",
77            "product_publish",
78            "is_dependent",
79            "no_of_boxes",
80            "company_id",
81            "uid",
82            "template_tag",
83            "category_uid",
84            "item_code",
85            "multi_size",
86            "is_set",
87            "brand_uid",
88            "is_active",
89            "is_image_less_product",
90            "custom_order",
91            "tax_identifier",
92            "country_of_origin",
93            "item_type",
94            "departments",
95            "slug"
96          ],
97          "properties": {
98            "currency": {
99              "type": "string",
100              "description": "Currency used for pricing"
101            },
102            "product_group_tag": {
103              "type": "array",
104              "description": "Tags for grouping products",
105              "items": {
106                "type": "string"
107              }
108            },
109            "name": {
110              "type": "string",
111              "description": "Name of the product"
112            },
113            "tags": {
114              "type": "array",
115              "description": "Additional tags for the product",
116              "items": {
117                "type": "string"
118              }
119            },
120            "slug": {
121              "type": "string",
122              "description": "Slug for the product"
123            },
124            "variant_media": {
125              "type": "object",
126              "description": "Media related to product variants"
127            },
128            "teaser_tag": {
129              "type": "object",
130              "description": "Tag for teaser related to the product"
131            },
132            "trader": {
133              "type": [
134                "array",
135                "object"
136              ],
137              "description": "Information about traders associated with the product"
138            },
139            "trader_type": {
140              "type": "string",
141              "description": "Type of trader"
142            },
143            "description": {
144              "type": "string",
145              "description": "Complete description of the product"
146            },
147            "return_config": {
148              "type": "object",
149              "description": "Configuration for product returns",
150              "required": [
151                "returnable"
152              ],
153              "properties": {
154                "returnable": {
155                  "type": "boolean",
156                  "description": "Whether the product is returnable"
157                },
158                "time": {
159                  "type": "integer",
160                  "description": "Time period for returns"
161                },
162                "unit": {
163                  "type": "string",
164                  "description": "Unit of time for returns"
165                }
166              }
167            },
168            "departments": {
169              "type": "array",
170              "description": "Departments associated with the product",
171              "items": {
172                "type": "integer"
173              }
174            },
175            "product_publish": {
176              "type": "object",
177              "description": "Publishing information for the product",
178              "required": [
179                "product_online_date",
180                "is_set"
181              ],
182              "properties": {
183                "product_online_date": {
184                  "type": "string",
185                  "description": "Date when the product goes online"
186                },
187                "is_set": {
188                  "type": "boolean",
189                  "description": "Whether the product is a set"
190                }
191              }
192            },
193            "is_dependent": {
194              "type": "boolean",
195              "description": "Whether the product is dependent and cannot be sold separately"
196            },
197            "highlights": {
198              "type": "array",
199              "description": "Highlights or key features of the product",
200              "items": {
201                "type": "string"
202              }
203            },
204            "size_guide": {
205              "type": "string",
206              "description": "Size guide information for the product"
207            },
208            "no_of_boxes": {
209              "type": "integer",
210              "description": "Number of boxes the product contains"
211            },
212            "company_id": {
213              "type": "integer",
214              "description": "Identifier for the company"
215            },
216            "variants": {
217              "type": "object",
218              "description": "Variants of the product"
219            },
220            "category_slug": {
221              "type": "string",
222              "description": "Slug for the product category"
223            },
224            "media": {
225              "type": "array",
226              "description": "Media related to the product",
227              "items": {
228                "type": "object",
229                "properties": {
230                  "type": {
231                    "type": "string"
232                  },
233                  "url": {
234                    "type": "string"
235                  }
236                }
237              }
238            },
239            "uid": {
240              "type": "integer",
241              "description": "Unique identifier for the product"
242            },
243            "template_tag": {
244              "type": "string",
245              "description": "Tag for product template"
246            },
247            "short_description": {
248              "type": "string",
249              "description": "Brief description of the product"
250            },
251            "category_uid": {
252              "type": "integer",
253              "description": "Identifier for the product category"
254            },
255            "item_code": {
256              "type": "string",
257              "description": "Unique code assigned to the product"
258            },
259            "multi_size": {
260              "type": "boolean",
261              "description": "Whether the product contains multiple sizes"
262            },
263            "is_set": {
264              "type": "boolean",
265              "description": "Whether the product is a set"
266            },
267            "net_quantity": {
268              "type": "object",
269              "description": "Net quantity information for the product"
270            },
271            "brand_uid": {
272              "type": "integer",
273              "description": "Identifier for the brand or manufacturer of the product"
274            },
275            "is_active": {
276              "type": "boolean",
277              "description": "Active status of the product"
278            },
279            "is_image_less_product": {
280              "type": "boolean",
281              "description": "Whether the product has no image"
282            },
283            "custom_order": {
284              "type": "object",
285              "description": "Custom order details for the product",
286              "required": [
287                "manufacturing_time_unit",
288                "is_custom_order",
289                "manufacturing_time"
290              ],
291              "properties": {
292                "manufacturing_time_unit": {
293                  "type": "string",
294                  "description": "Unit of manufacturing time"
295                },
296                "is_custom_order": {
297                  "type": "boolean",
298                  "description": "Whether the product is a custom order"
299                },
300                "manufacturing_time": {
301                  "type": "integer",
302                  "description": "Manufacturing time for the product"
303                }
304              }
305            },
306            "tax_identifier": {
307              "type": "object",
308              "description": "Tax identifier details for the product",
309              "required": [
310                "hsn_code",
311                "hsn_code_id",
312                "reporting_hsn"
313              ],
314              "properties": {
315                "hsn_code": {
316                  "type": "string",
317                  "description": "HSN code for taxation purpose"
318                },
319                "hsn_code_id": {
320                  "type": "string",
321                  "description": "ID for the HSN code"
322                },
323                "reporting_hsn": {
324                  "type": "string",
325                  "description": "Reporting HSN code"
326                }
327              }
328            },
329            "country_of_origin": {
330              "type": "string",
331              "description": "Country where the product was manufactured"
332            },
333            "item_type": {
334              "type": "string",
335              "description": "Type of the product"
336            },
337            "_custom_json": {
338              "type": "object",
339              "description": "Custom JSON data for the product"
340            }
341          }
342        }
343      }
344    }
345  }
346}
Payload Example
1{
2  "company_id": 517,
3  "contains": [
4    "product"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1712234127495,
9    "id": "uKbYRM0194XpCKxWD1eaLHVdwS2Q5mdGXxGDQfX5G9Q=",
10    "name": "product",
11    "trace_id": [
12      "silverbolt.d0ebeb9a-f27f-11ee-981c-beb2969f85b4"
13    ],
14    "type": "update",
15    "version": "2"
16  },
17  "payload": {
18    "product": {
19      "_custom_json": {},
20      "age-group": "Adults",
21      "brand_uid": 774,
22      "care_instructions": "Use a clean brush to Remove dust and dirt from the leather and apply Neutral shoe cream only on the leather surface in a circular motion and buff the leather for shine.",
23      "category_slug": "casual-slip-ons",
24      "category_uid": 416,
25      "color": "BLACK",
26      "company_id": 517,
27      "country_of_origin": "India",
28      "currency": "INR",
29      "custom_order": {
30        "is_custom_order": false,
31        "manufacturing_time": 0,
32        "manufacturing_time_unit": "days"
33      },
34      "departments": [
35        21
36      ],
37      "description": "Experience elevated style and comfort with Ruosh loafers, featuring a unique digital print on the upper. Combined with a comfortable footbed and durable sole, these loafers offer a perfect blend of fashion and functionality.",
38      "essential": "No",
39      "gender": [
40        "Men"
41      ],
42      "highlights": [],
43      "is_active": true,
44      "is_dependent": false,
45      "is_image_less_product": false,
46      "is_set": false,
47      "item_code": "1201062110",
48      "item_type": "standard",
49      "marketer-address": "dummy data",
50      "marketer-name": "Sara Suole Pvt. Ltd.",
51      "material": "Printed Leather",
52      "media": [
53        {
54          "type": "image",
55          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/ruosh/1201062110/0/HN401b-ddN-1201062110_1.jpg"
56        },
57        {
58          "type": "image",
59          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/ruosh/1201062110/1/VajpVNlcy7-1201062110_10.jpg"
60        },
61        {
62          "type": "image",
63          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/ruosh/1201062110/2/bVNEr3qoy_-1201062110_11.jpg"
64        },
65        {
66          "type": "image",
67          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/ruosh/1201062110/3/NzXG4r9S6n-1201062110_2.jpg"
68        },
69        {
70          "type": "image",
71          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/ruosh/1201062110/4/7jbHdmYGQO-1201062110_3.jpg"
72        },
73        {
74          "type": "image",
75          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/ruosh/1201062110/5/dJ46T5yD3l-1201062110_4.jpg"
76        },
77        {
78          "type": "image",
79          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/ruosh/1201062110/6/aWI2PnuqOt-1201062110_5.jpg"
80        },
81        {
82          "type": "image",
83          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/ruosh/1201062110/7/qXoh7uAghh-1201062110_6.jpg"
84        },
85        {
86          "type": "image",
87          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/ruosh/1201062110/8/UZMueSwY_l-1201062110_7.jpg"
88        },
89        {
90          "type": "image",
91          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/ruosh/1201062110/9/fcczvl47zf-1201062110_8.jpg"
92        },
93        {
94          "type": "image",
95          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/ruosh/1201062110/10/IMDrtryLcW-1201062110_9.jpg"
96        }
97      ],
98      "multi_size": true,
99      "name": "The Severo Black Men Penny Drivers Ruosh",
100      "net-quantity": "1 N",
101      "net_quantity": {},
102      "no_of_boxes": 1,
103      "outer_material": "Printed Leather",
104      "primary_color": "Black",
105      "primary_material": "Leather",
106      "product_group_tag": [],
107      "product_publish": {
108        "is_set": false,
109        "product_online_date": "2024-04-04T12:35:26.392000+00:00"
110      },
111      "return_config": {
112        "returnable": true,
113        "time": 15,
114        "unit": "days"
115      },
116      "season": "SS24",
117      "short_description": "",
118      "size_guide": "",
119      "slug": "the-severo-black-men-penny-drivers-ruosh-10205117",
120      "sole-material": "Rubber",
121      "sustainable": "Regular",
122      "tags": [],
123      "tax_identifier": {
124        "hsn_code": "64035910",
125        "hsn_code_id": "6277839f5e4c6fdbc8be41dc",
126        "reporting_hsn": "64035910H1"
127      },
128      "teaser_tag": {},
129      "template_tag": "footwear",
130      "trader": [
131        {
132          "address": [
133            "Sara Suole Pvt. Ltd., 192/1/2/3, B-2, C.K.Palya, Sakalawara Post,Bannerghatta Road,Bangalore - 560083."
134          ],
135          "name": "Sara Suole Pvt. Ltd.",
136          "type": "Manufacturer"
137        }
138      ],
139      "uid": 10205117,
140      "variant_media": {},
141      "variants": {}
142    }
143  }
144}

company/product/create/v3

this event is triggered when product is created

Payload
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
id
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 (ProductCreateSchema)
Required
ProductCreateSchema
product
object
Required
Information about a product.
Properties
currency
string
Currency of the product.
product_group_tag
array of string
Tag associated with the product group.
name
string
Required
Name of the product.
tags
array of string
List of tags associated with the product.
slug
string
Required
Unique slug for the product.
variant_media
object
A dictionary of media files associated with each variant of the product.
teaser_tag
object
Teaser tag for the product.
trader
array of object
Trader associated with the product.
Array of Properties
address
array of string
Required
type
string
Required
Type of trader (e.g., Manufacturer, Importer, Packer)
name
string
Required
Name of the trader
description
string
Description of the product.
return_config
object
Required
Return policy information for the product.
Properties
returnable
boolean
Required
Flag indicating if the product is returnable or not.
time
integer
The time within which the product can be returned, in the specified time unit.
unit
string
The unit of time used to measure the time within which the product can be returned.
departments
array of integer
Required
List of department IDs associated with the product.
product_publish
object
Required
Information about the product publication status.
Properties
product_online_date
string
Required
Unix timestamp indicating the date and time when the product was published online.
is_set
boolean
Required
Flag to indicate if the product is published online or not.
is_dependent
boolean
Required
Flag to indicate if the product is dependent on other products or not.
highlights
array of string
A list of highlights or special features associated with the product.
size_guide
string
URL to the size guide for the product.
no_of_boxes
integer
Required
Number of boxes containing the product.
company_id
integer
Required
ID of the company associated with the product.
category_slug
string
Slug of the category associated with the product.
media
array of object
List of media information associated with the product.
Array of Properties
type
string
url
string
uid
integer
Required
The unique identifier of the product.
template_tag
string
Required
The tag used for the product template.
short_description
string
A short description of the product, limited to 50 characters.
category_uid
integer
Required
The unique identifier of the category that the product belongs to.
item_code
string
Required
Item code for the product.
multi_size
boolean
Required
Flag to indicate if the product has multiple sizes or not.
is_set
boolean
Required
Flag to indicate if the product is a set or not.
net_quantity
object
A nested object representing the net quantity of the product.
brand_uid
integer
Required
Unique ID of the brand associated with the product.
is_active
boolean
Required
A boolean indicating whether the product is currently active or not.
is_image_less_product
boolean
Required
Flag to indicate if the product has no image or not.
attributes
object
Attributes of the product.
custom_order
object
Required
Custom order information for the product.
Properties
manufacturing_time_unit
string
Required
The unit of time used to measure the time required to manufacture the product.
is_custom_order
boolean
Required
Flag indicating if the product is a custom order or not.
manufacturing_time
integer
Required
The time required to manufacture the product, in the specified time unit.
tax_identifier
object
Required
Tax identifier for the product.
Properties
hsn_code
string
Required
The HSN (Harmonized System of Nomenclature) code associated with the product.
hsn_code_id
string
Required
ID of the HSN code associated with the product.
reporting_hsn
string
Required
Reporting HSN for the product.
country_of_origin
string
Required
Country of origin for the product.
item_type
string
Required
Type of the product.
_custom_json
object
A dictionary of custom JSON data associated with the product.
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      "$ref": "#/components/schemas/ProductCreateSchema"
68    }
69  }
70}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.e5d3d4ae-f23a-11ee-8e32-1670e4e67cd9"
5    ],
6    "name": "product",
7    "type": "create",
8    "version": "3",
9    "created_timestamp": 1712204527295,
10    "id": "IzF6aoBVaTMBlGX+k1wGXf0ZVwfcSY5I9BYU8X0VGEA=",
11    "category": "company"
12  },
13  "company_id": 7053,
14  "contains": [
15    "product"
16  ],
17  "payload": {
18    "product": {
19      "media": [
20        {
21          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/Lgc3jeZ-H-Hanging_Light.jpeg",
22          "type": "image"
23        }
24      ],
25      "trader": [
26        {
27          "address": [
28            "TEST"
29          ],
30          "type": "Manufacturer",
31          "name": "TEST"
32        }
33      ],
34      "item_code": "HANGI_001NG",
35      "is_active": true,
36      "name": "Hanging_Light",
37      "currency": "INR",
38      "short_description": "",
39      "custom_order": {
40        "is_custom_order": false,
41        "manufacturing_time_unit": "days",
42        "manufacturing_time": 0
43      },
44      "company_id": 7053,
45      "template_tag": "led-lights",
46      "size_guide": "",
47      "attributes": {},
48      "description": "",
49      "_custom_json": {},
50      "no_of_boxes": 1,
51      "teaser_tag": {},
52      "product_publish": {
53        "product_online_date": "2024-04-04T04:22:05.148000+00:00",
54        "is_set": false
55      },
56      "uid": 10242364,
57      "is_dependent": false,
58      "item_type": "standard",
59      "variants": {},
60      "return_config": {
61        "returnable": false,
62        "unit": "days",
63        "time": 0
64      },
65      "slug": "hanginglight",
66      "departments": [
67        32
68      ],
69      "tags": [],
70      "product_group_tag": [],
71      "is_set": false,
72      "country_of_origin": "India",
73      "is_image_less_product": false,
74      "category_slug": "Hanging--Light",
75      "highlights": [],
76      "multi_size": false,
77      "category_uid": 3750,
78      "brand_uid": 5989,
79      "variant_media": {},
80      "tax_identifier": {
81        "hsn_code_id": "64e8aa91d87af8902bc12c0b",
82        "hsn_code": "94051900",
83        "reporting_hsn": "94051900H1"
84      },
85      "net_quantity": {}
86    }
87  }
88}

company/product/delete/v3

this event is triggered when product is deleted

Payload
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
id
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
product
object
Required
Information about a product.
Properties
uid
integer
Required
The unique identifier of the product.
company_id
integer
Required
ID of the company associated with the product.
archived_by
object
Information about the user who archived the product.
Properties
username
string
Username of the user who archived the product.
user_id
string
Unique identifier of the user who archived the product.
brand_uid
integer
Required
Unique ID of the brand associated with the product.
item_code
string
Required
Item code for the product.
archived_on
string
timestamp indicating the date and time when the product was archived.
trader
array of object
Trader associated with the product.
Array of Properties
address
array of string
name
string
Name of the trader
type
string
Type of trader (e.g., Manufacturer, Importer, Packer)
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      "required": [
69        "product"
70      ],
71      "properties": {
72        "product": {
73          "type": "object",
74          "required": [
75            "uid",
76            "company_id",
77            "brand_uid",
78            "item_code"
79          ],
80          "properties": {
81            "uid": {
82              "type": "integer",
83              "description": "The unique identifier of the product."
84            },
85            "company_id": {
86              "type": "integer",
87              "description": "ID of the company associated with the product."
88            },
89            "archived_by": {
90              "type": "object",
91              "properties": {
92                "username": {
93                  "type": "string",
94                  "description": "Username of the user who archived the product."
95                },
96                "user_id": {
97                  "type": "string",
98                  "description": "Unique identifier of the user who archived the product."
99                }
100              },
101              "description": "Information about the user who archived the product."
102            },
103            "brand_uid": {
104              "type": "integer",
105              "description": "Unique ID of the brand associated with the product."
106            },
107            "item_code": {
108              "type": "string",
109              "description": "Item code for the product."
110            },
111            "archived_on": {
112              "type": "string",
113              "description": "timestamp indicating the date and time when the product was archived."
114            },
115            "trader": {
116              "type": "array",
117              "items": {
118                "type": "object",
119                "properties": {
120                  "address": {
121                    "type": "array",
122                    "items": {
123                      "type": "string"
124                    }
125                  },
126                  "name": {
127                    "type": "string",
128                    "description": "Name of the trader"
129                  },
130                  "type": {
131                    "type": "string",
132                    "description": "Type of trader (e.g., Manufacturer, Importer, Packer)"
133                  }
134                },
135                "description": "Details of traders associated with the product"
136              },
137              "description": "Trader associated with the product."
138            }
139          },
140          "description": "Information about a product."
141        }
142      }
143    }
144  }
145}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.cd586c62-f1ce-11ee-aa9a-d6778ce1e347"
5    ],
6    "name": "product",
7    "type": "delete",
8    "version": "3",
9    "created_timestamp": 1712158100574,
10    "id": "dL4VUszr7UM8bPlXQSPqdwrgTY4yKjEF9p/kH0Vc2m0=",
11    "category": "company"
12  },
13  "company_id": 3523,
14  "contains": [
15    "product"
16  ],
17  "payload": {
18    "product": {
19      "uid": 10124296,
20      "company_id": 3523,
21      "archived_on": "2024-04-03T15:28:20.571977Z",
22      "brand_uid": 5294,
23      "archived_by": {
24        "username": "bijendra_nath_stylebaazar_com_37818",
25        "user_id": "f4bf0e6837690a325f35609a"
26      },
27      "item_code": "MJN-KSCN-915-LIGHT BLUE",
28      "trader": [
29        {
30          "address": [
31            "Address"
32          ],
33          "name": "Address",
34          "type": "Importer"
35        }
36      ]
37    }
38  }
39}

company/product/update/v3

this event is triggered when product is updated

Payload
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
id
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 (ProductUpdateSchema)
Required
ProductUpdateSchema
product
object
Required
Information about a product.
Properties
currency
string
Currency of the product.
product_group_tag
array of string
Tag associated with the product group.
name
string
Required
Name of the product.
tags
array of string
List of tags associated with the product.
slug
string
Required
Unique slug for the product.
variant_media
object
A dictionary of media files associated with each variant of the product.
teaser_tag
object
Teaser tag for the product.
trader
array of object
Trader associated with the product.
Array of Properties
address
array of string
Required
type
string
Required
Type of trader (e.g., Manufacturer, Importer, Packer)
name
string
Required
Name of the trader
description
string
Description of the product.
return_config
object
Required
Return policy information for the product.
Properties
returnable
boolean
Required
Flag indicating if the product is returnable or not.
time
integer
The time within which the product can be returned, in the specified time unit.
unit
string
The unit of time used to measure the time within which the product can be returned.
departments
array of integer
Required
List of department IDs associated with the product.
product_publish
object
Information about the product publication status.
Properties
product_online_date
string
Required
Unix timestamp indicating the date and time when the product was published online.
is_set
boolean
Required
Flag to indicate if the product is published online or not.
is_dependent
boolean
Required
Flag to indicate if the product is dependent on other products or not.
highlights
array of string
A list of highlights or special features associated with the product.
size_guide
string
URL to the size guide for the product.
no_of_boxes
integer
Required
Number of boxes containing the product.
company_id
integer
Required
ID of the company associated with the product.
variants
object
A dictionary of product variants, where the keys are variant names and the values are variant details.
category_slug
string
Slug of the category associated with the product.
media
array of object
List of media information associated with the product.
Array of Properties
type
string
url
string
uid
integer
Required
The unique identifier of the product.
template_tag
string
Required
The tag used for the product template.
short_description
string
A short description of the product, limited to 50 characters.
category_uid
integer
Required
The unique identifier of the category that the product belongs to.
item_code
string
Required
Item code for the product.
multi_size
boolean
Required
Flag to indicate if the product has multiple sizes or not.
is_set
boolean
Required
Flag to indicate if the product is a set or not.
net_quantity
object
A nested object representing the net quantity of the product.
brand_uid
integer
Required
Unique ID of the brand associated with the product.
is_active
boolean
Required
A boolean indicating whether the product is currently active or not.
is_image_less_product
boolean
Required
Flag to indicate if the product has no image or not.
attributes
object
Attributes of the product.
custom_order
object
Required
Custom order information for the product.
Properties
manufacturing_time_unit
string
Required
The unit of time used to measure the time required to manufacture the product.
is_custom_order
boolean
Required
Flag indicating if the product is a custom order or not.
manufacturing_time
integer
Required
The time required to manufacture the product, in the specified time unit.
tax_identifier
object
Required
Tax identifier for the product.
Properties
hsn_code
string
Required
The HSN (Harmonized System of Nomenclature) code associated with the product.
hsn_code_id
string
Required
ID of the HSN code associated with the product.
reporting_hsn
string
Required
Reporting HSN for the product.
country_of_origin
string
Required
Country of origin for the product.
item_type
string
Required
Type of the product.
_custom_json
object
A dictionary of custom JSON data associated with the product.
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      "$ref": "#/components/schemas/ProductUpdateSchema"
68    }
69  }
70}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.50d4dff6-f1ef-11ee-b8ab-6e67a317dc8d"
5    ],
6    "name": "product",
7    "type": "update",
8    "version": "3",
9    "created_timestamp": 1712172065067,
10    "id": "HIGFyd5dMpB8lxOHoMYx5JOfq/pafoqsCo0/UFzDOMw=",
11    "category": "company"
12  },
13  "company_id": 6065,
14  "contains": [
15    "product"
16  ],
17  "payload": {
18    "product": {
19      "brand_uid": 7450,
20      "category_slug": "sling-bags",
21      "name": "What a Click Bestie",
22      "attributes": {
23        "color": "Pastel Pink",
24        "primary_color": "Pink",
25        "net-quantity": "1 N",
26        "marketer-address": "New Delhi",
27        "primary_material": "Plastic",
28        "marketer-name": "Pretty Please",
29        "essential": "No",
30        "gender": [
31          "Women"
32        ]
33      },
34      "media": [
35        {
36          "type": "image",
37          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/RDfLeAu98-What-a-Click-Bestie.jpeg"
38        },
39        {
40          "type": "image",
41          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/oZac3z5Rc-What-a-Click-Bestie.jpeg"
42        },
43        {
44          "type": "image",
45          "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/nPP6FhSfs-What-a-Click-Bestie.jpeg"
46        }
47      ],
48      "custom_order": {
49        "manufacturing_time_unit": "days",
50        "is_custom_order": false,
51        "manufacturing_time": 0
52      },
53      "size_guide": "",
54      "highlights": [],
55      "is_image_less_product": false,
56      "return_config": {
57        "unit": "days",
58        "returnable": false,
59        "time": 0
60      },
61      "item_type": "standard",
62      "slug": "what-a-click-bestie-9739009",
63      "no_of_boxes": 1,
64      "is_active": true,
65      "uid": 9739009,
66      "net_quantity": {},
67      "is_set": false,
68      "trader": [
69        {
70          "name": "Pretty Please",
71          "type": "Manufacturer",
72          "address": [
73            "New Delhi"
74          ]
75        }
76      ],
77      "template_tag": "bags",
78      "variants": {
79        "primary_color": [
80          "PA-13",
81          "PA-12"
82        ]
83      },
84      "departments": [
85        21
86      ],
87      "product_publish": {
88        "product_online_date": "2023-11-04T21:42:29.788000+00:00",
89        "is_set": false
90      },
91      "tags": [],
92      "company_id": 6065,
93      "tax_identifier": {
94        "hsn_code": "42021290",
95        "hsn_code_id": "6277846d5e4c6fdbc8be5472",
96        "reporting_hsn": "42021290H1"
97      },
98      "currency": "INR",
99      "category_uid": 352,
100      "short_description": "",
101      "description": "This Bag exude effortless elegance, adding a touch of sophistication to your party look.",
102      "item_code": "PA-14",
103      "multi_size": true,
104      "is_dependent": false,
105      "country_of_origin": "India"
106    }
107  }
108}

Support ticket

This event will be generated where there is any action done on support-ticket

Events
company/support-ticket/create/v1
# this event is triggered when support-ticket is created
company/support-ticket/update/v1
# this event is triggered when support-ticket is updated

company/support-ticket/create/v1

this event is triggered when support-ticket is created

Payload
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
id
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
ticket
object
Required
The support ticket object associated with the event
Properties
_id
string
Required
Primary Identifier used for retrieving and updating the ticket
tags
array of string
Array of string describing relevant tags to the ticket
source
string
The type of origin of ticket - It can be either raised at platfom panel, partner panel or sales channel
status
string
Required
Describes the status of the ticket. Possible values: open, pending, in_progress, resolved, closed
content
object
Required
Contains title, base 64 encoded description (HTML), and list of attachments
Properties
title
string
Required
The title of issue/escalation - Summarizing the issue in one line
attachments
array of object (attachments)
Array of attachments
display
string
Display name of Attachment
type
string
Type of attachment - image, shipment, file etc
value
string
Attachment value. For image/file it'll be a url. For shipment it'll be a shipment ID
description
string
Required
The detailed description of issue/escalation - Encoded in base64
items
string
category
string
Required
The category or category hierarchy for which the ticket is raised, e.g. Catalogue, Collection, Product, Logistics, etc.
sla
object
Details regarding the resolution time of a ticket
Properties
resolution_time
string
Timestamp by which the ticket will be resolved
created_at
string
Ticket creation time
created_by
object
Contains description of user who created the ticket
Properties
_id
string
Required
Unique Identifier for an user - auto generated by system
last_name
string
Last name of the user who created the ticket
first_name
string
Last name of the user who created the ticket
updated_at
string
Ticket last updation time
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      "required": [
69        "ticket"
70      ],
71      "properties": {
72        "ticket": {
73          "type": "object",
74          "description": "The support ticket object associated with the event",
75          "required": [
76            "_id",
77            "content",
78            "category",
79            "status",
80            "priority"
81          ],
82          "properties": {
83            "_id": {
84              "type": "string",
85              "description": "Primary Identifier used for retrieving and updating the ticket"
86            },
87            "tags": {
88              "type": "array",
89              "description": "Array of string describing relevant tags to the ticket",
90              "items": {
91                "type": "string"
92              }
93            },
94            "source": {
95              "type": "string",
96              "description": "The type of origin of ticket - It can be either raised at platfom panel, partner panel or sales channel"
97            },
98            "status": {
99              "type": "string",
100              "description": "Describes the status of the ticket. Possible values: open, pending, in_progress, resolved, closed"
101            },
102            "content": {
103              "type": "object",
104              "description": "Contains title, base 64 encoded description (HTML), and list of attachments",
105              "required": [
106                "title",
107                "description"
108              ],
109              "properties": {
110                "title": {
111                  "type": "string",
112                  "description": "The title of issue/escalation - Summarizing the issue in one line"
113                },
114                "attachments": {
115                  "type": "array",
116                  "items": {
117                    "$ref": "#/components/schemas/attachments"
118                  }
119                },
120                "description": {
121                  "type": "string",
122                  "description": "The detailed description of issue/escalation - Encoded in base64"
123                },
124                "items": {
125                  "type": "string"
126                }
127              }
128            },
129            "category": {
130              "type": "string",
131              "description": "The category or category hierarchy for which the ticket is raised, e.g. Catalogue, Collection, Product, Logistics, etc."
132            },
133            "sla": {
134              "type": "object",
135              "description": "Details regarding the resolution time of a ticket",
136              "properties": {
137                "resolution_time": {
138                  "type": "string",
139                  "description": "Timestamp by which the ticket will be resolved"
140                }
141              }
142            },
143            "created_at": {
144              "type": "string",
145              "description": "Ticket creation time"
146            },
147            "created_by": {
148              "type": "object",
149              "description": "Contains description of user who created the ticket",
150              "required": [
151                "_id"
152              ],
153              "properties": {
154                "_id": {
155                  "type": "string",
156                  "description": "Unique Identifier for an user - auto generated by system"
157                },
158                "last_name": {
159                  "type": "string",
160                  "description": "Last name of the user who created the ticket"
161                },
162                "first_name": {
163                  "type": "string",
164                  "description": "Last name of the user who created the ticket"
165                }
166              }
167            },
168            "updated_at": {
169              "type": "string",
170              "description": "Ticket last updation time"
171            }
172          }
173        }
174      }
175    }
176  }
177}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "highbrow.afa35ff1-13d7-47ff-ac07-f95e76d551b6"
5    ],
6    "name": "support-ticket",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712147922314,
10    "id": "MRQ57aTXTvtPMyIkbLr1a4BpOu9LxH0KpRx2IF2uOo0=",
11    "category": "company"
12  },
13  "company_id": 46,
14  "contains": [
15    "ticket",
16    "type"
17  ],
18  "payload": {
19    "ticket": {
20      "_id": "660d4dd1a6c805c20b4c3352",
21      "source": "platform_panel",
22      "content": {
23        "title": "Ticket no 712147594320 / cX IS WAITING FOR PRODUCT, Bag ID 33849314 / Hamleys",
24        "description": "PHA+SGkgVGVhbSw8L3A+CjxwPkN4IGhhcyBwbGFjZWQgdGhlIG9yZGVyIG9uIDMwLTAzLTIwMjQgYnV0IHN0aWxsIHRoZSBvcmRlciBpcyBub3QgY29uZmlybWVkLjwvcD4KPHA+Q3ggaXMgd2FpdGluZyBmb3IgdGhlIHByb2R1Y3QgdG8gYmUgZGVsaXZlcmVkIG9uIHVyZ2VudCBiYXNlcy48L3A+CjxwPlNvIHdlIHJlcXVlc3QgeW91IHRvIHBsZWFzZSBkZWxpdmVyZWQgdGhlIHByb2R1Y3QgYXNhcC48L3A+",
25        "attachments": []
26      },
27      "tags": [
28        "Synced to Freshdesk"
29      ],
30      "category": "logistics > delivery_related > no_movement",
31      "priority": "high",
32      "status": "open",
33      "sla": {
34        "resolution_time": "2024-06-24T06:31:37.986Z"
35      },
36      "created_at": "2024-04-03T12:38:41.966Z",
37      "updated_at": "2024-04-03T12:38:41.966Z",
38      "created_by": {
39        "_id": "e2a288694429d6034e730874",
40        "first_name": "test",
41        "last_name": "test"
42      }
43    },
44    "type": "create"
45  }
46}

company/support-ticket/update/v1

this event is triggered when support-ticket is updated

Payload
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
id
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
ticket
object
Required
The support ticket object associated with the event
Properties
_id
string
Required
Primary Identifier used for retrieving and updating the ticket
tags
array of string
Array of string describing relevant tags to the ticket
source
string
The type of origin of ticket - It can be either raised at platfom panel, partner panel or sales channel
status
string
Required
Describes the status of the ticket. Possible values: open, pending, in_progress, resolved, closed
content
object
Required
Contains title, base 64 encoded description (HTML), and list of attachments
Properties
title
string
Required
The title of issue/escalation - Summarizing the issue in one line
attachments
array of object (attachments)
Array of attachments
display
string
Display name of Attachment
type
string
Type of attachment - image, shipment, file etc
value
string
Attachment value. For image/file it'll be a url. For shipment it'll be a shipment ID
description
string
Required
The detailed description of issue/escalation - Encoded in base64
category
string
Required
The category or category hierarchy for which the ticket is raised, e.g. Catalogue, Collection, Product, Logistics, etc.
sla
object
Details regarding the resolution time of a ticket
Properties
resolution_time
string
Timestamp by which the ticket will be resolved
created_at
string
Ticket creation time
created_by
object
Contains description of user who created the ticket
Properties
_id
string
Required
Unique Identifier for an user - auto generated by system
last_name
string
Last name of the user who created the ticket
first_name
string
Last name of the user who created the ticket
updated_at
string
Ticket last updation time
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      "required": [
69        "ticket"
70      ],
71      "properties": {
72        "ticket": {
73          "type": "object",
74          "description": "The support ticket object associated with the event",
75          "required": [
76            "_id",
77            "content",
78            "category",
79            "status",
80            "priority"
81          ],
82          "properties": {
83            "_id": {
84              "type": "string",
85              "description": "Primary Identifier used for retrieving and updating the ticket"
86            },
87            "tags": {
88              "type": "array",
89              "description": "Array of string describing relevant tags to the ticket",
90              "items": {
91                "type": "string"
92              }
93            },
94            "source": {
95              "type": "string",
96              "description": "The type of origin of ticket - It can be either raised at platfom panel, partner panel or sales channel"
97            },
98            "status": {
99              "type": "string",
100              "description": "Describes the status of the ticket. Possible values: open, pending, in_progress, resolved, closed"
101            },
102            "content": {
103              "type": "object",
104              "description": "Contains title, base 64 encoded description (HTML), and list of attachments",
105              "required": [
106                "title",
107                "description"
108              ],
109              "properties": {
110                "title": {
111                  "type": "string",
112                  "description": "The title of issue/escalation - Summarizing the issue in one line"
113                },
114                "attachments": {
115                  "type": "array",
116                  "items": {
117                    "$ref": "#/components/schemas/attachments"
118                  }
119                },
120                "description": {
121                  "type": "string",
122                  "description": "The detailed description of issue/escalation - Encoded in base64"
123                }
124              }
125            },
126            "category": {
127              "type": "string",
128              "description": "The category or category hierarchy for which the ticket is raised, e.g. Catalogue, Collection, Product, Logistics, etc."
129            },
130            "sla": {
131              "type": "object",
132              "description": "Details regarding the resolution time of a ticket",
133              "properties": {
134                "resolution_time": {
135                  "type": "string",
136                  "description": "Timestamp by which the ticket will be resolved"
137                }
138              }
139            },
140            "created_at": {
141              "type": "string",
142              "description": "Ticket creation time"
143            },
144            "created_by": {
145              "type": "object",
146              "description": "Contains description of user who created the ticket",
147              "required": [
148                "_id"
149              ],
150              "properties": {
151                "_id": {
152                  "type": "string",
153                  "description": "Unique Identifier for an user - auto generated by system"
154                },
155                "last_name": {
156                  "type": "string",
157                  "description": "Last name of the user who created the ticket"
158                },
159                "first_name": {
160                  "type": "string",
161                  "description": "Last name of the user who created the ticket"
162                }
163              }
164            },
165            "updated_at": {
166              "type": "string",
167              "description": "Ticket last updation time"
168            }
169          }
170        }
171      }
172    }
173  }
174}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "highbrow.4d0532eb-9212-4c8a-b7fe-ed82cf63383b"
5    ],
6    "name": "support-ticket",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712124739528,
10    "id": "ToQCu76QZV2EF1q++HZjOTHluZ3fDLogpmQNYaAx4LE=",
11    "category": "company"
12  },
13  "company_id": 320,
14  "contains": [
15    "ticket",
16    "type"
17  ],
18  "payload": {
19    "ticket": {
20      "_id": "660cf31ca6c805c20b494fb5",
21      "source": "platform_panel",
22      "content": {
23        "title": "Locked",
24        "description": "PHA+U0xBIGJyZWFjaGVkPC9wPg==",
25        "attachments": []
26      },
27      "tags": [
28        "Synced to Freshdesk"
29      ],
30      "category": "sales_channel > 3p_marketplace",
31      "priority": "urgent",
32      "status": "open",
33      "sla": {
34        "resolution_time": "2024-06-24T06:31:37.986Z"
35      },
36      "created_at": "2024-04-03T06:11:40.232Z",
37      "updated_at": "2024-04-03T06:11:58.566Z",
38      "created_by": {
39        "_id": "3794679420adfa2473997b6a",
40        "first_name": "test",
41        "last_name": "V"
42      }
43    },
44    "type": "update"
45  }
46}

Zone

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

Events
company/zone/create/v1
# this event is triggered when zone is created
company/zone/update/v1
# this event is triggered when zone is updated

company/zone/create/v1

this event is triggered when zone is created

Payload
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
id
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
zone
object
Required
Properties
new
object
Required
Properties
zone_id
string
Required
Zone ID
slug
string
Required
Slug of the region associated with the zone
name
string
Required
Canonical name of slug
company_id
integer
Required
Company ID of zone
store_ids
array of integer
Required
List of stores for the created/updated zone
product
object
Required
Product type and tags associated with the zone
Properties
tags
array of string
Required
Product tags associated with the zone
type
string
Required
Product type
Enum
channels
array of object
Required
Channels associated with the zone
Array of Properties
channel_id
string
Required
channel_type
string
Required
is_active
boolean
Required
Indicates whether the zone is active or not
old
object
Properties
zone_id
string
Zone ID
slug
string
Slug of the region associated with the zone
name
string
Canonical name of slug
company_id
integer
Company ID of zone
store_ids
array of integer
List of stores for the zone
product
object
Product type and tags associated with the zone
Properties
tags
array of string
Required
Product tags associated with the zone
type
string
Required
Product type
Enum
channels
array of object
Channels associated with the zone
Array of Properties
channel_id
string
Required
channel_type
string
Required
is_active
boolean
Indicates whether the zone is active or not
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        "zone": {
70          "type": "object",
71          "properties": {
72            "new": {
73              "type": "object",
74              "properties": {
75                "zone_id": {
76                  "type": "string",
77                  "description": "Zone ID"
78                },
79                "slug": {
80                  "type": "string",
81                  "description": "Slug of the region associated with the zone"
82                },
83                "name": {
84                  "type": "string",
85                  "description": "Canonical name of slug"
86                },
87                "company_id": {
88                  "type": "integer",
89                  "description": "Company ID of zone"
90                },
91                "store_ids": {
92                  "type": "array",
93                  "items": {
94                    "type": "integer"
95                  },
96                  "description": "List of stores for the created/updated zone"
97                },
98                "product": {
99                  "type": "object",
100                  "properties": {
101                    "tags": {
102                      "type": "array",
103                      "items": {
104                        "type": "string"
105                      },
106                      "description": "Product tags associated with the zone"
107                    },
108                    "type": {
109                      "type": "string",
110                      "enum": [
111                        "all",
112                        "explicit"
113                      ],
114                      "description": "Product type"
115                    }
116                  },
117                  "required": [
118                    "tags",
119                    "type"
120                  ],
121                  "description": "Product type and tags associated with the zone"
122                },
123                "channels": {
124                  "type": "array",
125                  "items": {
126                    "type": "object",
127                    "properties": {
128                      "channel_id": {
129                        "type": "string"
130                      },
131                      "channel_type": {
132                        "type": "string"
133                      }
134                    },
135                    "required": [
136                      "channel_id",
137                      "channel_type"
138                    ]
139                  },
140                  "description": "Channels associated with the zone"
141                },
142                "is_active": {
143                  "type": "boolean",
144                  "description": "Indicates whether the zone is active or not"
145                }
146              },
147              "required": [
148                "zone_id",
149                "slug",
150                "name",
151                "company_id",
152                "store_ids",
153                "product",
154                "channels",
155                "is_active"
156              ]
157            },
158            "old": {
159              "type": "object",
160              "properties": {
161                "zone_id": {
162                  "type": "string",
163                  "description": "Zone ID"
164                },
165                "slug": {
166                  "type": "string",
167                  "description": "Slug of the region associated with the zone"
168                },
169                "name": {
170                  "type": "string",
171                  "description": "Canonical name of slug"
172                },
173                "company_id": {
174                  "type": "integer",
175                  "description": "Company ID of zone"
176                },
177                "store_ids": {
178                  "type": "array",
179                  "items": {
180                    "type": "integer"
181                  },
182                  "description": "List of stores for the zone"
183                },
184                "product": {
185                  "type": "object",
186                  "properties": {
187                    "tags": {
188                      "type": "array",
189                      "items": {
190                        "type": "string"
191                      },
192                      "description": "Product tags associated with the zone"
193                    },
194                    "type": {
195                      "type": "string",
196                      "enum": [
197                        "all",
198                        "explicit"
199                      ],
200                      "description": "Product type"
201                    }
202                  },
203                  "required": [
204                    "tags",
205                    "type"
206                  ],
207                  "description": "Product type and tags associated with the zone"
208                },
209                "channels": {
210                  "type": "array",
211                  "items": {
212                    "type": "object",
213                    "properties": {
214                      "channel_id": {
215                        "type": "string"
216                      },
217                      "channel_type": {
218                        "type": "string"
219                      }
220                    },
221                    "required": [
222                      "channel_id",
223                      "channel_type"
224                    ]
225                  },
226                  "description": "Channels associated with the zone"
227                },
228                "is_active": {
229                  "type": "boolean",
230                  "description": "Indicates whether the zone is active or not"
231                }
232              }
233            }
234          },
235          "required": [
236            "new"
237          ]
238        }
239      },
240      "required": [
241        "zone"
242      ]
243    }
244  }
245}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "stormbreaker.0e0ecb4e-f4ae-49c0-ac08-6cab9ca03b05"
5    ],
6    "name": "zone",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711951311,
10    "id": "2WvgiyhP8hNQSLLifA/UHN17yq7nQTRha4B/0tzEzzg=",
11    "category": "company"
12  },
13  "company_id": 18376,
14  "contains": [
15    "zone"
16  ],
17  "payload": {
18    "zone": {
19      "new": {
20        "zone_id": "660a4dcf51c9e512f3c78515",
21        "slug": "zone-z2foq",
22        "name": "Zone1",
23        "company_id": 18376,
24        "store_ids": [
25          49666
26        ],
27        "product": {
28          "type": "all",
29          "tags": []
30        },
31        "channels": [
32          {
33            "channel_type": "application",
34            "channel_id": "660a3a36ac4f9c0f5a90f7ed"
35          }
36        ],
37        "is_active": true
38      },
39      "old": {}
40    }
41  }
42}

company/zone/update/v1

this event is triggered when zone is updated

Payload
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
id
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
zone
object
Required
Properties
new
object
Required
Properties
zone_id
string
Required
Zone ID
slug
string
Required
Slug of the region associated with the zone
name
string
Required
Canonical name of slug
company_id
integer
Required
Company ID of zone
store_ids
array of Undefined Type
Required
List of stores for the created/updated zone
product
object
Required
Product tags associated with the zone
Properties
tags
array of string
Required
type
string
Required
Product type
Enum
channels
array of object
Required
Channels associated with the zone
Array of Properties
channel_id
string
Required
channel_type
string
Required
is_active
boolean
Required
Indicates whether the zone is active or not
old
object
Properties
zone_id
string
Required
Zone ID
slug
string
Required
Slug of the region associated with the zone
name
string
Required
Canonical name of slug
company_id
integer
Required
Company ID of zone
store_ids
array of Undefined Type
Required
List of stores for the zone
product
object
Required
Product tags associated with the zone
Properties
tags
array of string
Required
type
string
Required
Product type
Enum
channels
array of object
Required
Channels associated with the zone
Array of Properties
channel_id
string
Required
channel_type
string
Required
is_active
boolean
Required
Indicates whether the zone is active or not
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        "zone": {
70          "type": "object",
71          "properties": {
72            "new": {
73              "type": "object",
74              "properties": {
75                "zone_id": {
76                  "type": "string",
77                  "description": "Zone ID"
78                },
79                "slug": {
80                  "type": "string",
81                  "description": "Slug of the region associated with the zone"
82                },
83                "name": {
84                  "type": "string",
85                  "description": "Canonical name of slug"
86                },
87                "company_id": {
88                  "type": "integer",
89                  "description": "Company ID of zone"
90                },
91                "store_ids": {
92                  "type": "array",
93                  "items": [
94                    {
95                      "type": "integer"
96                    }
97                  ],
98                  "description": "List of stores for the created/updated zone"
99                },
100                "product": {
101                  "type": "object",
102                  "properties": {
103                    "tags": {
104                      "type": "array",
105                      "items": {
106                        "type": "string"
107                      }
108                    },
109                    "type": {
110                      "type": "string",
111                      "enum": [
112                        "all",
113                        "explicit"
114                      ],
115                      "description": "Product type"
116                    }
117                  },
118                  "required": [
119                    "tags",
120                    "type"
121                  ],
122                  "description": "Product tags associated with the zone"
123                },
124                "channels": {
125                  "type": "array",
126                  "items": {
127                    "type": "object",
128                    "properties": {
129                      "channel_id": {
130                        "type": "string"
131                      },
132                      "channel_type": {
133                        "type": "string"
134                      }
135                    },
136                    "required": [
137                      "channel_id",
138                      "channel_type"
139                    ],
140                    "description": "Channel ID (Application or Extension ID) and type"
141                  },
142                  "description": "Channels associated with the zone"
143                },
144                "is_active": {
145                  "type": "boolean",
146                  "description": "Indicates whether the zone is active or not"
147                }
148              },
149              "required": [
150                "zone_id",
151                "slug",
152                "name",
153                "company_id",
154                "store_ids",
155                "product",
156                "channels",
157                "is_active"
158              ]
159            },
160            "old": {
161              "type": "object",
162              "properties": {
163                "zone_id": {
164                  "type": "string",
165                  "description": "Zone ID"
166                },
167                "slug": {
168                  "type": "string",
169                  "description": "Slug of the region associated with the zone"
170                },
171                "name": {
172                  "type": "string",
173                  "description": "Canonical name of slug"
174                },
175                "company_id": {
176                  "type": "integer",
177                  "description": "Company ID of zone"
178                },
179                "store_ids": {
180                  "type": "array",
181                  "items": [
182                    {
183                      "type": "integer"
184                    }
185                  ],
186                  "description": "List of stores for the zone"
187                },
188                "product": {
189                  "type": "object",
190                  "properties": {
191                    "tags": {
192                      "type": "array",
193                      "items": {
194                        "type": "string"
195                      }
196                    },
197                    "type": {
198                      "type": "string",
199                      "enum": [
200                        "all",
201                        "explicit"
202                      ],
203                      "description": "Product type"
204                    }
205                  },
206                  "required": [
207                    "tags",
208                    "type"
209                  ],
210                  "description": "Product tags associated with the zone"
211                },
212                "channels": {
213                  "type": "array",
214                  "items": {
215                    "type": "object",
216                    "properties": {
217                      "channel_id": {
218                        "type": "string"
219                      },
220                      "channel_type": {
221                        "type": "string"
222                      }
223                    },
224                    "required": [
225                      "channel_id",
226                      "channel_type"
227                    ],
228                    "description": "Channel ID (Application or Extension ID) and type"
229                  },
230                  "description": "Channels associated with the zone"
231                },
232                "is_active": {
233                  "type": "boolean",
234                  "description": "Indicates whether the zone is active or not"
235                }
236              },
237              "required": [
238                "zone_id",
239                "slug",
240                "name",
241                "company_id",
242                "store_ids",
243                "product",
244                "channels",
245                "is_active"
246              ]
247            }
248          },
249          "required": [
250            "new"
251          ]
252        }
253      },
254      "required": [
255        "zone"
256      ]
257    }
258  }
259}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "stormbreaker.e6b4d431-e77c-4f21-aa6c-1972949dd567"
5    ],
6    "name": "zone",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711901438,
10    "id": "ekAHB7u0rNUjGRInx15tFznDERKa15ciwSG/paS0NX8=",
11    "category": "company"
12  },
13  "company_id": 18361,
14  "contains": [
15    "zone"
16  ],
17  "payload": {
18    "zone": {
19      "new": {
20        "zone_id": "66098af40f0cf9063d423a2d",
21        "slug": "zone-o95cu",
22        "name": "Zone Updated 1",
23        "company_id": 18361,
24        "store_ids": [
25          49624
26        ],
27        "product": {
28          "type": "all",
29          "tags": []
30        },
31        "channels": [
32          {
33            "channel_id": "66097451388fb141a311124c",
34            "channel_type": "application"
35          }
36        ],
37        "is_active": false
38      },
39      "old": {
40        "zone_id": "66098af40f0cf9063d423a2d",
41        "slug": "zone-o95cu",
42        "name": "Zone1",
43        "company_id": 18361,
44        "store_ids": [
45          49624
46        ],
47        "product": {
48          "type": "all",
49          "tags": []
50        },
51        "channels": [
52          {
53            "channel_id": "66097451388fb141a311124c",
54            "channel_type": "application"
55          }
56        ],
57        "is_active": true
58      }
59    }
60  }
61}

Previous
« Temporal
Next
Address »