Webhooks
Overview
Webhook Configuration
Best Practices
Kafka
Amazon EventBridge
Amazon SQS
Google Pub/Sub
Temporal
Change Log
Customfields
Customobjects
Article
Brand
Company
Courier Partner
Customfield Definition
Customobject Definition
Location
Logistics Configuration
Product Size
Product
Support Ticket
Theme
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 Price
Product
Promotion
Promotion Usage
Refund
Return Config
Return Config Categories
Rule
Seo
Shipment
Sitemap
Sort
Tags
Theme
User
Zone
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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.
creator
string
Required
It is creator of the custom object definition, possible values are - company, application
company_id
string
Required
This is company id where this custom object created.
created_by
string
Required
The user who created this entry
updated_by
string
Required
The user who last updated this entry
status
string
Required
This is use for active/inactive status of custom object entry
type
string
Required
Type is a slug and its unique identifier for the custom object definition. Its required and will not be modified once created.
display_name
string
Required
Display name is the disaply text for the custom object entry
definition_id
string
Required
This is definition id of custom object definition against this entry.
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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.
creator
string
Required
It is creator of the custom object definition, possible values are - company, application
company_id
string
Required
This is company id where this custom object created.
created_by
string
Required
The user who created this entry
updated_by
string
Required
The user who last updated this entry
status
string
Required
This is use for active/inactive status of custom object entry
type
string
Required
Type is a slug and its unique identifier for the custom object definition. Its required and will not be modified once created.
display_name
string
Required
Display name is the disaply text for the custom object entry
definition_id
string
Required
This is definition id of custom object definition against this entry.
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Required
A description of the brand.
_locale_language
object
Required
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            "description",
130            "_locale_language",
131            "company_id",
132            "id"
133          ],
134          "description": "Brand details."
135        }
136      },
137      "required": [
138        "brand"
139      ]
140    }
141  }
142}
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/v2
# this event is triggered when company is created
company/company/update/v2
# this event is triggered when company is updated

company/company/create/v1

this event is triggered when company is created

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
uid
integer
ID of the company created.
mode
Undefined Type
Status of the company. (Live / Developmemt )
Enum
name
string
Required
Name of the company created.
stage
string
Verification stage of the Company
taxes
array of object
Contains the tax information of the company.
Array of Properties
rate
number
enable
boolean
effective_date
string
domain
string
warnings
object
Warning in the verification process
addresses
array of object
Required
Address of the company stituated at.
Array of Properties
city
string
Required
state
string
Required
country
string
Required
pincode
integer
Required
address1
string
Required
address2
string
landmark
string
latitude
number
Required
longitude
number
Required
address_type
string
country_code
string
documents
array of object
Required
Business documents of the company. For eg. PAN, GST
Array of Properties
url
string
type
string
Required
value
string
Required
verified
boolean
legal_name
string
created_by
object
Properties
user_id
string
Required
username
string
Required
created_on
string
Timestamp when the company was created.
modified_by
object
User details of the modifier.
Properties
user_id
string
Required
username
string
Required
modified_on
string
Timestamp when the company was last modified.
verified_by
object
User details of the verifier.
Properties
user_id
string
Required
username
string
Required
verified_on
string
Timestamp when the company is verified.
_custom_json
object
Extra information required by the External integrations
company_type
string
Category in which the company falls. For eg MBO, Distributor, Franchise, Owner/Manufacturer
marketplaces
array of string
List of all the marketaplaces that are opted in while creation of company.
business_info
string
Description of the business, company is involved in.
business_type
string
Category in which the business falls, For eg HUF, LTD/ PVT LTD, LLP/Partnership, Proprietorship
referral_info
object
Properties
referral_code
string
reject_reason
string
Reason for rejection in the verification process.
contact_details
object
Properties
phone
array of object
Array of Properties
number
string
Required
country_code
integer
Required
emails
array of string
business_details
object
Website details of the company.
Properties
website
object
Required
Properties
url
string
franchise_enabled
boolean
Whether company wants other seller to sell its product.
notification_emails
array of string
Email address of the company
business_country_info
object
Information regarding the country in which the company lies.
Properties
country
string
country_code
string
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            },
83            "uid": {
84              "type": "integer",
85              "description": "ID of the company created."
86            },
87            "mode": {
88              "enum": [
89                "live",
90                "development"
91              ],
92              "description": "Status of the company. (Live / Developmemt )"
93            },
94            "name": {
95              "type": "string",
96              "description": "Name of the company created."
97            },
98            "stage": {
99              "type": "string",
100              "description": "Verification stage of the Company"
101            },
102            "taxes": {
103              "type": "array",
104              "items": {
105                "type": "object",
106                "required": [],
107                "properties": {
108                  "rate": {
109                    "type": "number"
110                  },
111                  "enable": {
112                    "type": "boolean"
113                  },
114                  "effective_date": {
115                    "type": "string"
116                  }
117                }
118              },
119              "description": "Contains the tax information of the company."
120            },
121            "domain": {
122              "type": "string"
123            },
124            "warnings": {
125              "type": "object",
126              "description": "Warning in the verification process"
127            },
128            "addresses": {
129              "type": "array",
130              "items": {
131                "type": "object",
132                "required": [
133                  "country",
134                  "state",
135                  "city",
136                  "pincode",
137                  "address1",
138                  "latitude",
139                  "longitude"
140                ],
141                "properties": {
142                  "city": {
143                    "type": "string"
144                  },
145                  "state": {
146                    "type": "string"
147                  },
148                  "country": {
149                    "type": "string"
150                  },
151                  "pincode": {
152                    "type": "integer"
153                  },
154                  "address1": {
155                    "type": "string"
156                  },
157                  "address2": {
158                    "type": "string"
159                  },
160                  "landmark": {
161                    "type": "string"
162                  },
163                  "latitude": {
164                    "type": "number"
165                  },
166                  "longitude": {
167                    "type": "number"
168                  },
169                  "address_type": {
170                    "type": "string"
171                  },
172                  "country_code": {
173                    "type": "string"
174                  }
175                }
176              },
177              "description": "Address of the company stituated at."
178            },
179            "documents": {
180              "type": "array",
181              "items": {
182                "type": "object",
183                "required": [
184                  "type",
185                  "value"
186                ],
187                "properties": {
188                  "url": {
189                    "type": "string"
190                  },
191                  "type": {
192                    "type": "string"
193                  },
194                  "value": {
195                    "type": "string"
196                  },
197                  "verified": {
198                    "type": "boolean"
199                  },
200                  "legal_name": {
201                    "type": "string"
202                  }
203                }
204              },
205              "description": "Business documents of the company. For eg. PAN, GST"
206            },
207            "created_by": {
208              "type": "object",
209              "required": [
210                "user_id",
211                "username"
212              ],
213              "properties": {
214                "user_id": {
215                  "type": "string"
216                },
217                "username": {
218                  "type": "string"
219                }
220              }
221            },
222            "created_on": {
223              "type": "string",
224              "description": "Timestamp when the company was created."
225            },
226            "modified_by": {
227              "type": "object",
228              "required": [
229                "user_id",
230                "username"
231              ],
232              "properties": {
233                "user_id": {
234                  "type": "string"
235                },
236                "username": {
237                  "type": "string"
238                }
239              },
240              "description": "User details of the modifier."
241            },
242            "modified_on": {
243              "type": "string",
244              "description": "Timestamp when the company was last modified."
245            },
246            "verified_by": {
247              "type": "object",
248              "required": [
249                "user_id",
250                "username"
251              ],
252              "properties": {
253                "user_id": {
254                  "type": "string"
255                },
256                "username": {
257                  "type": "string"
258                }
259              },
260              "description": "User details of the verifier."
261            },
262            "verified_on": {
263              "type": "string",
264              "description": "Timestamp when the company is verified."
265            },
266            "_custom_json": {
267              "type": "object",
268              "description": "Extra information required by the External integrations"
269            },
270            "company_type": {
271              "type": "string",
272              "description": "Category in which the company falls. For eg MBO, Distributor, Franchise, Owner/Manufacturer"
273            },
274            "marketplaces": {
275              "type": "array",
276              "items": {
277                "type": "string"
278              },
279              "description": "List of all the marketaplaces that are opted in while creation of company."
280            },
281            "business_info": {
282              "type": "string",
283              "description": "Description of the business, company is involved in."
284            },
285            "business_type": {
286              "type": "string",
287              "description": "Category in which the business falls, For eg HUF, LTD/ PVT LTD, LLP/Partnership, Proprietorship"
288            },
289            "referral_info": {
290              "type": "object",
291              "required": [],
292              "properties": {
293                "referral_code": {
294                  "type": "string"
295                }
296              }
297            },
298            "reject_reason": {
299              "type": "string",
300              "description": "Reason for rejection in the verification process."
301            },
302            "contact_details": {
303              "type": "object",
304              "required": [],
305              "properties": {
306                "phone": {
307                  "type": "array",
308                  "items": {
309                    "type": "object",
310                    "required": [
311                      "number",
312                      "country_code"
313                    ],
314                    "properties": {
315                      "number": {
316                        "type": "string"
317                      },
318                      "country_code": {
319                        "type": "integer"
320                      }
321                    }
322                  }
323                },
324                "emails": {
325                  "type": "array",
326                  "items": {
327                    "type": "string"
328                  }
329                }
330              }
331            },
332            "business_details": {
333              "type": "object",
334              "required": [
335                "website"
336              ],
337              "properties": {
338                "website": {
339                  "type": "object",
340                  "required": [],
341                  "properties": {
342                    "url": {
343                      "type": "string"
344                    }
345                  }
346                }
347              },
348              "description": "Website details of the company."
349            },
350            "franchise_enabled": {
351              "type": "boolean",
352              "description": "Whether company wants other seller to sell its product."
353            },
354            "notification_emails": {
355              "type": "array",
356              "items": {
357                "type": "string"
358              },
359              "description": "Email address of the company"
360            },
361            "business_country_info": {
362              "type": "object",
363              "required": [],
364              "properties": {
365                "country": {
366                  "type": "string"
367                },
368                "country_code": {
369                  "type": "string"
370                }
371              },
372              "description": "Information regarding the country in which the company lies."
373            }
374          }
375        }
376      }
377    }
378  }
379}
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        "admin@talkingsox.com"
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
uid
integer
Required
ID of the company created.
mode
Undefined Type
Status of the company. (Live / Developmemt )
Enum
name
string
Name of the company created.
stage
string
Required
Verification stage of the Company
taxes
array of object
Contains the tax information of the company.
Array of Properties
rate
number
enable
boolean
effective_date
string
domain
string
warnings
object
Warning in the verification process
addresses
array of object
Address of the company stituated at.
Array of Properties
city
string
Required
state
string
Required
country
string
Required
pincode
integer
Required
address1
string
Required
address2
string
landmark
string
latitude
number
Required
longitude
number
Required
address_type
string
country_code
string
documents
array of object
Business documents of the company. For eg. PAN, GST
Array of Properties
url
string
type
string
Required
value
string
Required
verified
boolean
legal_name
string
created_by
object
Properties
user_id
string
Required
username
string
Required
created_on
string
Timestamp when the company was created.
modified_by
object
Required
User details of the modifier.
Properties
user_id
string
Required
username
string
Required
modified_on
string
Required
Timestamp when the company was last modified.
verified_by
object
User details of the verifier.
Properties
user_id
string
Required
username
string
Required
verified_on
string
Timestamp when the company is verified.
_custom_json
object
Extra information required by the External integrations
company_type
string
Category in which the company falls. For eg MBO, Distributor, Franchise, Owner/Manufacturer
marketplaces
array of string
List of all the marketaplaces that are opted in while creation of company.
business_info
string
Description of the business, company is involved in.
business_type
string
Category in which the business falls, For eg HUF, LTD/ PVT LTD, LLP/Partnership, Proprietorship
referral_info
object
Properties
referral_code
string
reject_reason
string
Reason for rejection in the verification process.
contact_details
object
Properties
phone
array of object
Array of Properties
number
string
Required
country_code
integer
Required
emails
array of string
business_details
object
Website details of the company.
Properties
website
object
Required
Properties
url
string
franchise_enabled
boolean
Whether company wants other seller to sell its product.
notification_emails
array of string
Email address of the company
business_country_info
object
Information regarding the country in which the company lies.
Properties
country
string
country_code
string
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            },
84            "uid": {
85              "type": "integer",
86              "description": "ID of the company created."
87            },
88            "mode": {
89              "enum": [
90                "live",
91                "development"
92              ],
93              "description": "Status of the company. (Live / Developmemt )"
94            },
95            "name": {
96              "type": "string",
97              "description": "Name of the company created."
98            },
99            "stage": {
100              "type": "string",
101              "description": "Verification stage of the Company"
102            },
103            "taxes": {
104              "type": "array",
105              "items": {
106                "type": "object",
107                "required": [],
108                "properties": {
109                  "rate": {
110                    "type": "number"
111                  },
112                  "enable": {
113                    "type": "boolean"
114                  },
115                  "effective_date": {
116                    "type": "string"
117                  }
118                }
119              },
120              "description": "Contains the tax information of the company."
121            },
122            "domain": {
123              "type": "string"
124            },
125            "warnings": {
126              "type": "object",
127              "description": "Warning in the verification process"
128            },
129            "addresses": {
130              "type": "array",
131              "items": {
132                "type": "object",
133                "required": [
134                  "country",
135                  "state",
136                  "city",
137                  "pincode",
138                  "address1",
139                  "latitude",
140                  "longitude"
141                ],
142                "properties": {
143                  "city": {
144                    "type": "string"
145                  },
146                  "state": {
147                    "type": "string"
148                  },
149                  "country": {
150                    "type": "string"
151                  },
152                  "pincode": {
153                    "type": "integer"
154                  },
155                  "address1": {
156                    "type": "string"
157                  },
158                  "address2": {
159                    "type": "string"
160                  },
161                  "landmark": {
162                    "type": "string"
163                  },
164                  "latitude": {
165                    "type": "number"
166                  },
167                  "longitude": {
168                    "type": "number"
169                  },
170                  "address_type": {
171                    "type": "string"
172                  },
173                  "country_code": {
174                    "type": "string"
175                  }
176                }
177              },
178              "description": "Address of the company stituated at."
179            },
180            "documents": {
181              "type": "array",
182              "items": {
183                "type": "object",
184                "required": [
185                  "type",
186                  "value"
187                ],
188                "properties": {
189                  "url": {
190                    "type": "string"
191                  },
192                  "type": {
193                    "type": "string"
194                  },
195                  "value": {
196                    "type": "string"
197                  },
198                  "verified": {
199                    "type": "boolean"
200                  },
201                  "legal_name": {
202                    "type": "string"
203                  }
204                }
205              },
206              "description": "Business documents of the company. For eg. PAN, GST"
207            },
208            "created_by": {
209              "type": "object",
210              "required": [
211                "user_id",
212                "username"
213              ],
214              "properties": {
215                "user_id": {
216                  "type": "string"
217                },
218                "username": {
219                  "type": "string"
220                }
221              }
222            },
223            "created_on": {
224              "type": "string",
225              "description": "Timestamp when the company was created."
226            },
227            "modified_by": {
228              "type": "object",
229              "required": [
230                "user_id",
231                "username"
232              ],
233              "properties": {
234                "user_id": {
235                  "type": "string"
236                },
237                "username": {
238                  "type": "string"
239                }
240              },
241              "description": "User details of the modifier."
242            },
243            "modified_on": {
244              "type": "string",
245              "description": "Timestamp when the company was last modified."
246            },
247            "verified_by": {
248              "type": "object",
249              "required": [
250                "user_id",
251                "username"
252              ],
253              "properties": {
254                "user_id": {
255                  "type": "string"
256                },
257                "username": {
258                  "type": "string"
259                }
260              },
261              "description": "User details of the verifier."
262            },
263            "verified_on": {
264              "type": "string",
265              "description": "Timestamp when the company is verified."
266            },
267            "_custom_json": {
268              "type": "object",
269              "description": "Extra information required by the External integrations"
270            },
271            "company_type": {
272              "type": "string",
273              "description": "Category in which the company falls. For eg MBO, Distributor, Franchise, Owner/Manufacturer"
274            },
275            "marketplaces": {
276              "type": "array",
277              "items": {
278                "type": "string"
279              },
280              "description": "List of all the marketaplaces that are opted in while creation of company."
281            },
282            "business_info": {
283              "type": "string",
284              "description": "Description of the business, company is involved in."
285            },
286            "business_type": {
287              "type": "string",
288              "description": "Category in which the business falls, For eg HUF, LTD/ PVT LTD, LLP/Partnership, Proprietorship"
289            },
290            "referral_info": {
291              "type": "object",
292              "required": [],
293              "properties": {
294                "referral_code": {
295                  "type": "string"
296                }
297              }
298            },
299            "reject_reason": {
300              "type": "string",
301              "description": "Reason for rejection in the verification process."
302            },
303            "contact_details": {
304              "type": "object",
305              "required": [],
306              "properties": {
307                "phone": {
308                  "type": "array",
309                  "items": {
310                    "type": "object",
311                    "required": [
312                      "number",
313                      "country_code"
314                    ],
315                    "properties": {
316                      "number": {
317                        "type": "string"
318                      },
319                      "country_code": {
320                        "type": "integer"
321                      }
322                    }
323                  }
324                },
325                "emails": {
326                  "type": "array",
327                  "items": {
328                    "type": "string"
329                  }
330                }
331              }
332            },
333            "business_details": {
334              "type": "object",
335              "required": [
336                "website"
337              ],
338              "properties": {
339                "website": {
340                  "type": "object",
341                  "required": [],
342                  "properties": {
343                    "url": {
344                      "type": "string"
345                    }
346                  }
347                }
348              },
349              "description": "Website details of the company."
350            },
351            "franchise_enabled": {
352              "type": "boolean",
353              "description": "Whether company wants other seller to sell its product."
354            },
355            "notification_emails": {
356              "type": "array",
357              "items": {
358                "type": "string"
359              },
360              "description": "Email address of the company"
361            },
362            "business_country_info": {
363              "type": "object",
364              "required": [],
365              "properties": {
366                "country": {
367                  "type": "string"
368                },
369                "country_code": {
370                  "type": "string"
371                }
372              },
373              "description": "Information regarding the country in which the company lies."
374            }
375          }
376        }
377      }
378    }
379  }
380}
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        "admin@talkingsox.com"
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}

company/company/create/v2

this event is triggered when company is created

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
uid
integer
mode
Undefined Type
Enum
name
string
Required
stage
string
taxes
array of object
Array of Properties
rate
number
enable
boolean
effective_date
string
domain
string
warnings
object
addresses
array of object
Required
Array of Properties
city
string
Required
state
string
country
string
Required
pincode
string
address1
string
Required
address2
string
landmark
string
latitude
number
Required
longitude
number
Required
address_type
string
country_code
string
documents
array of object
Required
Array of Properties
url
string
type
string
Required
value
string
Required
verified
boolean
legal_name
string
created_by
object
Properties
user_id
string
Required
username
string
Required
created_on
string
modified_by
object
Properties
user_id
string
Required
username
string
Required
modified_on
string
verified_by
object
Properties
user_id
string
Required
username
string
Required
verified_on
string
_custom_json
object
company_type
string
marketplaces
array of string
business_info
string
business_type
string
referral_info
object
Properties
referral_code
string
reject_reason
string
contact_details
object
Properties
phone
array of object
Array of Properties
number
string
Required
country_code
integer
Required
emails
array of string
business_details
object
Properties
website
object
Required
Properties
url
string
franchise_enabled
boolean
notification_emails
array of string
business_country_info
object
Properties
country
string
country_code
string
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            },
83            "uid": {
84              "type": "integer"
85            },
86            "mode": {
87              "enum": [
88                "live",
89                "development"
90              ]
91            },
92            "name": {
93              "type": "string"
94            },
95            "stage": {
96              "type": "string"
97            },
98            "taxes": {
99              "type": "array",
100              "items": {
101                "type": "object",
102                "required": [],
103                "properties": {
104                  "rate": {
105                    "type": "number"
106                  },
107                  "enable": {
108                    "type": "boolean"
109                  },
110                  "effective_date": {
111                    "type": "string"
112                  }
113                }
114              }
115            },
116            "domain": {
117              "type": "string"
118            },
119            "warnings": {
120              "type": "object"
121            },
122            "addresses": {
123              "type": "array",
124              "items": {
125                "type": "object",
126                "required": [
127                  "country",
128                  "city",
129                  "address1",
130                  "latitude",
131                  "longitude"
132                ],
133                "properties": {
134                  "city": {
135                    "type": "string"
136                  },
137                  "state": {
138                    "type": "string"
139                  },
140                  "country": {
141                    "type": "string"
142                  },
143                  "pincode": {
144                    "type": "string"
145                  },
146                  "address1": {
147                    "type": "string"
148                  },
149                  "address2": {
150                    "type": "string"
151                  },
152                  "landmark": {
153                    "type": "string"
154                  },
155                  "latitude": {
156                    "type": "number"
157                  },
158                  "longitude": {
159                    "type": "number"
160                  },
161                  "address_type": {
162                    "type": "string"
163                  },
164                  "country_code": {
165                    "type": "string"
166                  }
167                }
168              }
169            },
170            "documents": {
171              "type": "array",
172              "items": {
173                "type": "object",
174                "required": [
175                  "type",
176                  "value"
177                ],
178                "properties": {
179                  "url": {
180                    "type": "string"
181                  },
182                  "type": {
183                    "type": "string"
184                  },
185                  "value": {
186                    "type": "string"
187                  },
188                  "verified": {
189                    "type": "boolean"
190                  },
191                  "legal_name": {
192                    "type": "string"
193                  }
194                }
195              }
196            },
197            "created_by": {
198              "type": "object",
199              "required": [
200                "user_id",
201                "username"
202              ],
203              "properties": {
204                "user_id": {
205                  "type": "string"
206                },
207                "username": {
208                  "type": "string"
209                }
210              }
211            },
212            "created_on": {
213              "type": "string"
214            },
215            "modified_by": {
216              "type": "object",
217              "required": [
218                "user_id",
219                "username"
220              ],
221              "properties": {
222                "user_id": {
223                  "type": "string"
224                },
225                "username": {
226                  "type": "string"
227                }
228              }
229            },
230            "modified_on": {
231              "type": "string"
232            },
233            "verified_by": {
234              "type": "object",
235              "required": [
236                "user_id",
237                "username"
238              ],
239              "properties": {
240                "user_id": {
241                  "type": "string"
242                },
243                "username": {
244                  "type": "string"
245                }
246              }
247            },
248            "verified_on": {
249              "type": "string"
250            },
251            "_custom_json": {
252              "type": "object"
253            },
254            "company_type": {
255              "type": "string"
256            },
257            "marketplaces": {
258              "type": "array",
259              "items": {
260                "type": "string"
261              }
262            },
263            "business_info": {
264              "type": "string"
265            },
266            "business_type": {
267              "type": "string"
268            },
269            "referral_info": {
270              "type": "object",
271              "required": [],
272              "properties": {
273                "referral_code": {
274                  "type": "string"
275                }
276              }
277            },
278            "reject_reason": {
279              "type": "string"
280            },
281            "contact_details": {
282              "type": "object",
283              "required": [],
284              "properties": {
285                "phone": {
286                  "type": "array",
287                  "items": {
288                    "type": "object",
289                    "required": [
290                      "number",
291                      "country_code"
292                    ],
293                    "properties": {
294                      "number": {
295                        "type": "string"
296                      },
297                      "country_code": {
298                        "type": "integer"
299                      }
300                    }
301                  }
302                },
303                "emails": {
304                  "type": "array",
305                  "items": {
306                    "type": "string"
307                  }
308                }
309              }
310            },
311            "business_details": {
312              "type": "object",
313              "required": [
314                "website"
315              ],
316              "properties": {
317                "website": {
318                  "type": "object",
319                  "required": [],
320                  "properties": {
321                    "url": {
322                      "type": "string"
323                    }
324                  }
325                }
326              }
327            },
328            "franchise_enabled": {
329              "type": "boolean"
330            },
331            "notification_emails": {
332              "type": "array",
333              "items": {
334                "type": "string"
335              }
336            },
337            "business_country_info": {
338              "type": "object",
339              "required": [],
340              "properties": {
341                "country": {
342                  "type": "string"
343                },
344                "country_code": {
345                  "type": "string"
346                }
347              }
348            }
349          }
350        }
351      }
352    }
353  }
354}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "viking-utils.36b56740-f6fd-11ee-9273-1a4564ecdb3f"
5    ],
6    "name": "company",
7    "type": "create",
8    "version": "2",
9    "created_timestamp": 1712727790008,
10    "id": "fiYBwmYfhGFviNfhj5aJTLkgNTVXT+YSuB6UXaIozZ8=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 27177,
15  "contains": [
16    "company"
17  ],
18  "payload": {
19    "company": {
20      "mode": "live",
21      "modified_by": {
22        "user_id": "9759643b65ebc6bacb5275f5",
23        "username": "sandbox@gofynd.com"
24      },
25      "name": "Brunt Test Company - 1712727789512",
26      "company_type": "mbo",
27      "franchise_enabled": false,
28      "domain": "test-company-1712727789512",
29      "notification_emails": [
30        "app@gofynd.com"
31      ],
32      "warnings": {},
33      "modified_on": "2024-04-10T05:43:09.665115",
34      "stage": "complete",
35      "created_on": "2024-04-10T05:43:09.665110",
36      "documents": [
37        {
38          "type": "vat",
39          "value": "100234567890123",
40          "verified": true
41        }
42      ],
43      "business_country_info": {
44        "currency": {
45          "symbol": "AED",
46          "name": "United Arab Emirates Dirham",
47          "code": "AED"
48        },
49        "country_code": "AE",
50        "timezone": "Asia/Dubai",
51        "country": "United Arab Emirates"
52      },
53      "_id": "661626edc9f773c1ee2537e3",
54      "uid": 27177,
55      "addresses": [
56        {
57          "city": "SHARJAH",
58          "sector": "AL AAHAD AREA",
59          "longitude": 72.8423802,
60          "latitude": 19.0653252,
61          "address1": "POLARIS",
62          "address_type": "office",
63          "country_code": "AE",
64          "country": "UNITED ARAB EMIRATES"
65        },
66        {
67          "city": "SHARJAH",
68          "sector": "AL AAHAD AREA",
69          "longitude": 72.8423802,
70          "latitude": 19.0653252,
71          "address1": "POLARIS",
72          "address_type": "registered",
73          "country_code": "AE",
74          "country": "UNITED ARAB EMIRATES"
75        }
76      ],
77      "marketplaces": [],
78      "created_by": {
79        "user_id": "9759643b65ebc6bacb5275f5",
80        "username": "sandbox@gofynd.com"
81      }
82    }
83  }
84}

company/company/update/v2

this event is triggered when company is updated

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
uid
integer
Required
mode
Undefined Type
Enum
name
string
stage
string
Required
taxes
array of object
Array of Properties
rate
number
enable
boolean
effective_date
string
domain
string
warnings
object
addresses
array of object
Array of Properties
city
string
Required
state
string
country
string
Required
pincode
string
address1
string
Required
address2
string
landmark
string
latitude
number
Required
longitude
number
Required
address_type
string
country_code
string
documents
array of object
Array of Properties
url
string
type
string
Required
value
string
Required
verified
boolean
legal_name
string
created_by
object
Properties
user_id
string
Required
username
string
Required
created_on
string
modified_by
object
Required
Properties
user_id
string
Required
username
string
Required
modified_on
string
Required
verified_by
object
Properties
user_id
string
Required
username
string
Required
verified_on
string
_custom_json
object
company_type
string
marketplaces
array of string
business_info
string
business_type
string
referral_info
object
Properties
referral_code
string
reject_reason
string
contact_details
object
Properties
phone
array of object
Array of Properties
number
string
Required
country_code
integer
Required
emails
array of string
business_details
object
Properties
website
object
Required
Properties
url
string
franchise_enabled
boolean
notification_emails
array of string
business_country_info
object
Properties
country
string
country_code
string
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            },
84            "uid": {
85              "type": "integer"
86            },
87            "mode": {
88              "enum": [
89                "live",
90                "development"
91              ]
92            },
93            "name": {
94              "type": "string"
95            },
96            "stage": {
97              "type": "string"
98            },
99            "taxes": {
100              "type": "array",
101              "items": {
102                "type": "object",
103                "required": [],
104                "properties": {
105                  "rate": {
106                    "type": "number"
107                  },
108                  "enable": {
109                    "type": "boolean"
110                  },
111                  "effective_date": {
112                    "type": "string"
113                  }
114                }
115              }
116            },
117            "domain": {
118              "type": "string"
119            },
120            "warnings": {
121              "type": "object"
122            },
123            "addresses": {
124              "type": "array",
125              "items": {
126                "type": "object",
127                "required": [
128                  "country",
129                  "city",
130                  "address1",
131                  "latitude",
132                  "longitude"
133                ],
134                "properties": {
135                  "city": {
136                    "type": "string"
137                  },
138                  "state": {
139                    "type": "string"
140                  },
141                  "country": {
142                    "type": "string"
143                  },
144                  "pincode": {
145                    "type": "string"
146                  },
147                  "address1": {
148                    "type": "string"
149                  },
150                  "address2": {
151                    "type": "string"
152                  },
153                  "landmark": {
154                    "type": "string"
155                  },
156                  "latitude": {
157                    "type": "number"
158                  },
159                  "longitude": {
160                    "type": "number"
161                  },
162                  "address_type": {
163                    "type": "string"
164                  },
165                  "country_code": {
166                    "type": "string"
167                  }
168                }
169              }
170            },
171            "documents": {
172              "type": "array",
173              "items": {
174                "type": "object",
175                "required": [
176                  "type",
177                  "value"
178                ],
179                "properties": {
180                  "url": {
181                    "type": "string"
182                  },
183                  "type": {
184                    "type": "string"
185                  },
186                  "value": {
187                    "type": "string"
188                  },
189                  "verified": {
190                    "type": "boolean"
191                  },
192                  "legal_name": {
193                    "type": "string"
194                  }
195                }
196              }
197            },
198            "created_by": {
199              "type": "object",
200              "required": [
201                "user_id",
202                "username"
203              ],
204              "properties": {
205                "user_id": {
206                  "type": "string"
207                },
208                "username": {
209                  "type": "string"
210                }
211              }
212            },
213            "created_on": {
214              "type": "string"
215            },
216            "modified_by": {
217              "type": "object",
218              "required": [
219                "user_id",
220                "username"
221              ],
222              "properties": {
223                "user_id": {
224                  "type": "string"
225                },
226                "username": {
227                  "type": "string"
228                }
229              }
230            },
231            "modified_on": {
232              "type": "string"
233            },
234            "verified_by": {
235              "type": "object",
236              "required": [
237                "user_id",
238                "username"
239              ],
240              "properties": {
241                "user_id": {
242                  "type": "string"
243                },
244                "username": {
245                  "type": "string"
246                }
247              }
248            },
249            "verified_on": {
250              "type": "string"
251            },
252            "_custom_json": {
253              "type": "object"
254            },
255            "company_type": {
256              "type": "string"
257            },
258            "marketplaces": {
259              "type": "array",
260              "items": {
261                "type": "string"
262              }
263            },
264            "business_info": {
265              "type": "string"
266            },
267            "business_type": {
268              "type": "string"
269            },
270            "referral_info": {
271              "type": "object",
272              "required": [],
273              "properties": {
274                "referral_code": {
275                  "type": "string"
276                }
277              }
278            },
279            "reject_reason": {
280              "type": "string"
281            },
282            "contact_details": {
283              "type": "object",
284              "required": [],
285              "properties": {
286                "phone": {
287                  "type": "array",
288                  "items": {
289                    "type": "object",
290                    "required": [
291                      "number",
292                      "country_code"
293                    ],
294                    "properties": {
295                      "number": {
296                        "type": "string"
297                      },
298                      "country_code": {
299                        "type": "integer"
300                      }
301                    }
302                  }
303                },
304                "emails": {
305                  "type": "array",
306                  "items": {
307                    "type": "string"
308                  }
309                }
310              }
311            },
312            "business_details": {
313              "type": "object",
314              "required": [
315                "website"
316              ],
317              "properties": {
318                "website": {
319                  "type": "object",
320                  "required": [],
321                  "properties": {
322                    "url": {
323                      "type": "string"
324                    }
325                  }
326                }
327              }
328            },
329            "franchise_enabled": {
330              "type": "boolean"
331            },
332            "notification_emails": {
333              "type": "array",
334              "items": {
335                "type": "string"
336              }
337            },
338            "business_country_info": {
339              "type": "object",
340              "required": [],
341              "properties": {
342                "country": {
343                  "type": "string"
344                },
345                "country_code": {
346                  "type": "string"
347                }
348              }
349            }
350          }
351        }
352      }
353    }
354  }
355}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.37094770-f6fd-11ee-89f6-bea0eaeccf98"
5    ],
6    "name": "company",
7    "type": "update",
8    "version": "2",
9    "created_timestamp": 1712727790557,
10    "id": "3++/08D0Sa9UQaYBuoAKUpzLuXPcEwj4RJ31trsSAGI=",
11    "category": "company",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 27177,
15  "contains": [
16    "company"
17  ],
18  "payload": {
19    "company": {
20      "documents": [
21        {
22          "type": "vat",
23          "value": "100234567890123",
24          "verified": true
25        }
26      ],
27      "marketplaces": [],
28      "company_type": "mbo",
29      "franchise_enabled": false,
30      "addresses": [
31        {
32          "latitude": 19.0653252,
33          "longitude": 72.8423802,
34          "country_code": "AE",
35          "address1": "POLARIS",
36          "address_type": "office",
37          "country": "UNITED ARAB EMIRATES",
38          "sector": "AL AAHAD AREA",
39          "city": "SHARJAH"
40        },
41        {
42          "latitude": 19.0653252,
43          "longitude": 72.8423802,
44          "country_code": "AE",
45          "address1": "POLARIS",
46          "address_type": "registered",
47          "country": "UNITED ARAB EMIRATES",
48          "sector": "AL AAHAD AREA",
49          "city": "SHARJAH"
50        }
51      ],
52      "_id": "661626edc9f773c1ee2537e3",
53      "warnings": {},
54      "mode": "live",
55      "modified_by": {
56        "username": "sandbox@gofynd.com",
57        "user_id": "9759643b65ebc6bacb5275f5"
58      },
59      "created_on": "2024-04-10T05:43:09.665000",
60      "stage": "verified",
61      "notification_emails": [
62        "app@gofynd.com"
63      ],
64      "created_by": {
65        "username": "sandbox@gofynd.com",
66        "user_id": "9759643b65ebc6bacb5275f5"
67      },
68      "uid": 27177,
69      "modified_on": "2024-04-10T05:43:09.665000",
70      "domain": "test-company-1712727789512",
71      "verified_by": {
72        "username": "silverbolt",
73        "user_id": "0"
74      },
75      "business_country_info": {
76        "timezone": "Asia/Dubai",
77        "currency": {
78          "name": "United Arab Emirates Dirham",
79          "symbol": "AED",
80          "code": "AED"
81        },
82        "country": "United Arab Emirates",
83        "country_code": "AE"
84      },
85      "name": "Brunt Test Company - 1712727789512",
86      "verified_on": "2024-04-10T05:43:10.395281"
87    }
88  }
89}

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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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.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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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.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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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-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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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-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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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.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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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        "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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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        "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
Properties
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
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        "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/v2
# this event is triggered when location is created
company/location/update/v2
# this event is triggered when location is updated

company/location/create/v1

this event is triggered when location is created

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Detailed information about a specific store location, including its configuration, contact details, operational timings, and management.
Properties
product_return_config
object
Configuration for handling product returns.
Properties
on_same_store
boolean
Flag to indicate returns are processed in the same store.
contact_numbers
array of object
Stores contact numbers for customer service.
Array of Properties
number
string
Contact number of the store.
country_code
integer
Country code for the contact number.
documents
array of
Business documents of the store, such as GST, licenses, etc.
company
integer
Company ID of the store, associating it with a specific company on the platform.
address
object
Physical address where the store is situated.
Properties
address1
string
Primary address line of the store.
state
string
State where the store is located.
country_code
string
ISO country code of the stores location.
city
string
City where the store is situated.
latitude
number
Geographical latitude of the store.
pincode
integer
Postal code for the stores location.
longitude
number
Geographical longitude of the store.
country
string
Country where the store is located.
manager
object
Details regarding the store manager.
Properties
mobile_no
object
Contact details of the store manager.
Properties
number
string
Mobile number of the store manager.
country_code
integer
Country code of the store managers mobile number.
name
string
Name of the store manager.
email
string
Email address of the store manager.
avg_order_processing_time
object
Information regarding the average time it takes for the store to process orders.
Properties
duration_type
string
The unit of time for processing, e.g., hours, days.
duration
integer
Average duration to process orders.
gst_credentials
object
Credentials of the store for generating e_waybill & e_invoice.
Properties
e_waybill
object
Properties
enabled
boolean
Indicates if the store is enabled to generate e-waybills.
e_invoice
object
Properties
enabled
boolean
Indicates if the store is enabled to generate e-invoices.
auto_assign_courier_partner
boolean
Automatically assigns a courier partner for deliveries.
auto_invoice
boolean
Indicates if invoices are generated automatically.
modified_on
string
The last modification date of the stores data.
created_by
object
Information about the creator of the store location.
Properties
username
string
Username of the individual who created the store location.
user_id
string
User ID of the individual who created the store location.
timing
array of object
Array of Properties
open
boolean
Indicates whether the store is open during the day.
weekday
string
Indicates the name of the weekday.
closing
object
Timing details for the closing of the store.
Properties
hour
integer
Hour at which the store is closed.
minute
integer
Minute at which the store is closed.
opening
object
Timing details for the opening of the store.
Properties
hour
integer
Hour at which the store is closed.
minute
integer
Minute at which the store is closed.
name
string
Name of the store.
_id
string
Unique identifier for the store location.
modified_by
object
Information about the last modifier of the store location.
Properties
username
string
Username of the individual who last modified the store location.
user_id
string
User ID of the individual who last modified the store location.
uid
integer
Unique ID for the store within the system.
stage
string
Current lifecycle stage of the store.
display_name
string
Display name of the store for marketing or external purposes.
credit_note
boolean
Indicates if the store allows credit notes to be issued.
code
string
A unique code associated with the store for identification.
bulk_shipment
boolean
Indicates if the store is capable of handling bulk shipments.
tags
array of
Tags for categorizing or identifying specific characteristics of the store.
store_type
string
Category or type of store, e.g., Mall, High Street, Warehouse.
created_on
string
ISODate string for when the store location was created.
warnings
object
Container for any warnings or alerts related to the store.
order_acceptance_timing
array of object
Timings for accepting orders, which may vary from general operational hours.
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
Indicates if the store follows a default timing for order acceptance.
notification_emails
array of string
Email addresses to receive notifications related to the store.
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": "Flag to indicate returns are processed in the same store."
78                }
79              },
80              "description": "Configuration for handling product returns."
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": "Stores contact numbers for customer service."
98            },
99            "documents": {
100              "type": "array",
101              "description": "Business documents of the store, such as GST, licenses, etc."
102            },
103            "company": {
104              "type": "integer",
105              "description": "Company ID of the store, associating it with a specific company on the platform."
106            },
107            "address": {
108              "type": "object",
109              "properties": {
110                "address1": {
111                  "type": "string",
112                  "description": "Primary address line of the store."
113                },
114                "state": {
115                  "type": "string",
116                  "description": "State where the store is located."
117                },
118                "country_code": {
119                  "type": "string",
120                  "description": "ISO country code of the stores location."
121                },
122                "city": {
123                  "type": "string",
124                  "description": "City where the store is situated."
125                },
126                "latitude": {
127                  "type": "number",
128                  "description": "Geographical latitude of the store."
129                },
130                "pincode": {
131                  "type": "integer",
132                  "description": "Postal code for the stores location."
133                },
134                "longitude": {
135                  "type": "number",
136                  "description": "Geographical longitude of the store."
137                },
138                "country": {
139                  "type": "string",
140                  "description": "Country where the store is located."
141                }
142              },
143              "description": "Physical address where the store is situated."
144            },
145            "manager": {
146              "type": "object",
147              "properties": {
148                "mobile_no": {
149                  "type": "object",
150                  "properties": {
151                    "number": {
152                      "type": "string",
153                      "description": "Mobile number of the store manager."
154                    },
155                    "country_code": {
156                      "type": "integer",
157                      "description": "Country code of the store managers mobile number."
158                    }
159                  },
160                  "description": "Contact details of the store manager."
161                },
162                "name": {
163                  "type": "string",
164                  "description": "Name of the store manager."
165                },
166                "email": {
167                  "type": "string",
168                  "description": "Email address of the store manager."
169                }
170              },
171              "description": "Details regarding the store manager."
172            },
173            "avg_order_processing_time": {
174              "type": "object",
175              "properties": {
176                "duration_type": {
177                  "type": "string",
178                  "description": "The unit of time for processing, e.g., hours, days."
179                },
180                "duration": {
181                  "type": "integer",
182                  "description": "Average duration to process orders."
183                }
184              },
185              "description": "Information regarding the average time it takes for the store to process orders."
186            },
187            "gst_credentials": {
188              "type": "object",
189              "properties": {
190                "e_waybill": {
191                  "type": "object",
192                  "properties": {
193                    "enabled": {
194                      "type": "boolean",
195                      "description": "Indicates if the store is enabled to generate e-waybills."
196                    }
197                  }
198                },
199                "e_invoice": {
200                  "type": "object",
201                  "properties": {
202                    "enabled": {
203                      "type": "boolean",
204                      "description": "Indicates if the store is enabled to generate e-invoices."
205                    }
206                  }
207                }
208              },
209              "description": "Credentials of the store for generating e_waybill & e_invoice."
210            },
211            "auto_assign_courier_partner": {
212              "type": "boolean",
213              "description": "Automatically assigns a courier partner for deliveries."
214            },
215            "auto_invoice": {
216              "type": "boolean",
217              "description": "Indicates if invoices are generated automatically."
218            },
219            "modified_on": {
220              "type": "string",
221              "description": "The last modification date of the stores data."
222            },
223            "created_by": {
224              "type": "object",
225              "properties": {
226                "username": {
227                  "type": "string",
228                  "description": "Username of the individual who created the store location."
229                },
230                "user_id": {
231                  "type": "string",
232                  "description": "User ID of the individual who created the store location."
233                }
234              },
235              "description": "Information about the creator of the store location."
236            },
237            "timing": {
238              "type": "array",
239              "items": {
240                "type": "object",
241                "properties": {
242                  "open": {
243                    "type": "boolean",
244                    "description": "Indicates whether the store is open during the day."
245                  },
246                  "weekday": {
247                    "type": "string",
248                    "description": "Indicates the name of the weekday."
249                  },
250                  "closing": {
251                    "type": "object",
252                    "description": "Timing details for the closing of the store.",
253                    "properties": {
254                      "hour": {
255                        "type": "integer",
256                        "description": "Hour at which the store is closed."
257                      },
258                      "minute": {
259                        "type": "integer",
260                        "description": "Minute at which the store is closed."
261                      }
262                    }
263                  },
264                  "opening": {
265                    "type": "object",
266                    "description": "Timing details for the opening of the store.",
267                    "properties": {
268                      "hour": {
269                        "type": "integer",
270                        "description": "Hour at which the store is closed."
271                      },
272                      "minute": {
273                        "type": "integer",
274                        "description": "Minute at which the store is closed."
275                      }
276                    }
277                  }
278                }
279              }
280            },
281            "name": {
282              "type": "string",
283              "description": "Name of the store."
284            },
285            "_id": {
286              "type": "string",
287              "description": "Unique identifier for the store location."
288            },
289            "modified_by": {
290              "type": "object",
291              "properties": {
292                "username": {
293                  "type": "string",
294                  "description": "Username of the individual who last modified the store location."
295                },
296                "user_id": {
297                  "type": "string",
298                  "description": "User ID of the individual who last modified the store location."
299                }
300              },
301              "description": "Information about the last modifier of the store location."
302            },
303            "uid": {
304              "type": "integer",
305              "description": "Unique ID for the store within the system."
306            },
307            "stage": {
308              "type": "string",
309              "description": "Current lifecycle stage of the store."
310            },
311            "display_name": {
312              "type": "string",
313              "description": "Display name of the store for marketing or external purposes."
314            },
315            "credit_note": {
316              "type": "boolean",
317              "description": "Indicates if the store allows credit notes to be issued."
318            },
319            "code": {
320              "type": "string",
321              "description": "A unique code associated with the store for identification."
322            },
323            "bulk_shipment": {
324              "type": "boolean",
325              "description": "Indicates if the store is capable of handling bulk shipments."
326            },
327            "tags": {
328              "type": "array",
329              "description": "Tags for categorizing or identifying specific characteristics of the store."
330            },
331            "store_type": {
332              "type": "string",
333              "description": "Category or type of store, e.g., Mall, High Street, Warehouse."
334            },
335            "created_on": {
336              "type": "string",
337              "description": "ISODate string for when the store location was created."
338            },
339            "warnings": {
340              "type": "object",
341              "description": "Container for any warnings or alerts related to the store."
342            },
343            "order_acceptance_timing": {
344              "type": "array",
345              "items": {
346                "type": "object",
347                "properties": {
348                  "open": {
349                    "type": "boolean"
350                  },
351                  "weekday": {
352                    "type": "string"
353                  },
354                  "closing": {
355                    "type": "object",
356                    "properties": {
357                      "hour": {
358                        "type": "integer"
359                      },
360                      "minute": {
361                        "type": "integer"
362                      }
363                    }
364                  },
365                  "opening": {
366                    "type": "object",
367                    "properties": {
368                      "hour": {
369                        "type": "integer"
370                      },
371                      "minute": {
372                        "type": "integer"
373                      }
374                    }
375                  }
376                }
377              },
378              "description": "Timings for accepting orders, which may vary from general operational hours."
379            },
380            "default_order_acceptance_timing": {
381              "type": "boolean",
382              "description": "Indicates if the store follows a default timing for order acceptance."
383            },
384            "notification_emails": {
385              "type": "array",
386              "items": {
387                "type": "string"
388              },
389              "description": "Email addresses to receive notifications related to the store."
390            }
391          },
392          "description": "Detailed information about a specific store location, including its configuration, contact details, operational timings, and management."
393        }
394      }
395    }
396  }
397}
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": "sandbox@gofynd.com"
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": "sandbox@gofynd.com"
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": "sandbox@gofynd.com"
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        "app@gofynd.com"
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
_id
string
Subscription ID on platform side.
modified_by
object
Details of the person who last modified the location.
Properties
username
string
Username of the person who last modified the location.
user_id
string
User ID of the person who last modified the location.
created_on
string
ISODate string for when the location was created.
product_return_config
object
Information regarding the product return journey for the location.
Properties
on_same_store
boolean
Flag to indicate if product returns are managed by the same store.
warnings
object
Container for any warnings related to the store.
Properties
store_address
string
Warning related to the stores address, if any.
manager
object
Details regarding the store manager.
Properties
mobile_no
object
Contact details of the store manager.
Properties
country_code
integer
Country code of the manager's mobile number.
number
string
Mobile number of the store manager.
email
string
Email address of the store manager.
name
string
Name of the store manager.
uid
integer
Unique identifier for the location within the platform.
order_acceptance_timing
array of object
Timings of the store for the whole week.
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
Indicates if the store handles bulk shipments.
auto_invoice
boolean
Flag indicating if invoices are generated automatically.
modified_on
string
ISODate string for the last modification date of the location.
credit_note
boolean
Indicates if the store supports credit notes.
avg_order_processing_time
object
Average order processing time for the store.
Properties
duration_type
string
Type of duration for order processing time (e.g., hours, days).
duration
integer
Average time taken to process orders.
documents
array of Undefined Type
default_order_acceptance_timing
boolean
Indicates if the store follows default order acceptance timing.
auto_assign_courier_partner
boolean
Flag indicating if courier partners are assigned automatically.
address
object
Properties
pincode
integer
latitude
number
country_code
string
country
string
address1
string
longitude
number
city
string
state
string
notification_emails
array of string
Email addresses for receiving notifications.
company
integer
Company ID of the store.
created_by
object
Properties
username
string
user_id
string
display_name
string
Display name of the store.
store_type
string
Category in which the store falls, e.g., Mall, High Street, Warehouse.
stage
string
Current stage of the store in its lifecycle.
name
string
Name of the store created.
code
string
Unique code associated with the store for identification.
contact_numbers
array of object
Array of Properties
country_code
integer
number
string
gst_credentials
object
Properties
e_invoice
object
Properties
enabled
boolean
e_waybill
object
Properties
enabled
boolean
timing
array of object
Array of Properties
open
boolean
Indicates whether the store is open during the day.
weekday
string
Indicates the name of the weekday.
closing
object
Timing details for the closing of the store.
Properties
hour
integer
Hour at which the store is closed.
minute
integer
Minute at which the store is closed.
opening
object
Timing details for the opening of the store.
Properties
hour
integer
Hour at which the store is closed.
minute
integer
Minute at which the store is closed.
tags
array of string
Tags associated with the store for categorization or searchability.
verified_on
string
ISODate string when the store was last verified.
verified_by
object
Details of the person who verified the store.
Properties
username
string
Username of the verifier.
user_id
string
User ID of the verifier.
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": "Subscription ID on platform side."
75            },
76            "modified_by": {
77              "type": "object",
78              "properties": {
79                "username": {
80                  "type": "string",
81                  "description": "Username of the person who last modified the location."
82                },
83                "user_id": {
84                  "type": "string",
85                  "description": "User ID of the person who last modified the location."
86                }
87              },
88              "description": "Details of the person who last modified the location."
89            },
90            "created_on": {
91              "type": "string",
92              "description": "ISODate string 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": "Flag to indicate if product returns are managed by the same store."
100                }
101              },
102              "description": "Information regarding the product return journey for the location."
103            },
104            "warnings": {
105              "type": "object",
106              "properties": {
107                "store_address": {
108                  "type": "string",
109                  "description": "Warning related to the stores address, if any."
110                }
111              },
112              "description": "Container for any warnings related to the store."
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 of the manager's mobile number."
123                    },
124                    "number": {
125                      "type": "string",
126                      "description": "Mobile number of the store manager."
127                    }
128                  },
129                  "description": "Contact details of the store manager."
130                },
131                "email": {
132                  "type": "string",
133                  "description": "Email address of the store manager."
134                },
135                "name": {
136                  "type": "string",
137                  "description": "Name of the store manager."
138                }
139              },
140              "description": "Details regarding the store manager."
141            },
142            "uid": {
143              "type": "integer",
144              "description": "Unique identifier for the location within the platform."
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 stores operational hours for each day of the week."
189              },
190              "description": "Timings of the store for the whole week."
191            },
192            "bulk_shipment": {
193              "type": "boolean",
194              "description": "Indicates if the store handles bulk shipments."
195            },
196            "auto_invoice": {
197              "type": "boolean",
198              "description": "Flag indicating if invoices are generated automatically."
199            },
200            "modified_on": {
201              "type": "string",
202              "description": "ISODate string for the last modification date of the location."
203            },
204            "credit_note": {
205              "type": "boolean",
206              "description": "Indicates if the store supports credit notes."
207            },
208            "avg_order_processing_time": {
209              "type": "object",
210              "properties": {
211                "duration_type": {
212                  "type": "string",
213                  "description": "Type of duration for order processing time (e.g., hours, days)."
214                },
215                "duration": {
216                  "type": "integer",
217                  "description": "Average time taken to process orders."
218                }
219              },
220              "description": "Average order processing time for the store."
221            },
222            "documents": {
223              "type": "array",
224              "items": {}
225            },
226            "default_order_acceptance_timing": {
227              "type": "boolean",
228              "description": "Indicates if the store follows default order acceptance timing."
229            },
230            "auto_assign_courier_partner": {
231              "type": "boolean",
232              "description": "Flag indicating if courier partners are assigned automatically."
233            },
234            "address": {
235              "type": "object",
236              "properties": {
237                "pincode": {
238                  "type": "integer"
239                },
240                "latitude": {
241                  "type": "number"
242                },
243                "country_code": {
244                  "type": "string"
245                },
246                "country": {
247                  "type": "string"
248                },
249                "address1": {
250                  "type": "string"
251                },
252                "longitude": {
253                  "type": "number"
254                },
255                "city": {
256                  "type": "string"
257                },
258                "state": {
259                  "type": "string"
260                }
261              }
262            },
263            "notification_emails": {
264              "type": "array",
265              "items": {
266                "type": "string"
267              },
268              "description": "Email addresses for receiving notifications."
269            },
270            "company": {
271              "type": "integer",
272              "description": "Company ID of the store."
273            },
274            "created_by": {
275              "type": "object",
276              "properties": {
277                "username": {
278                  "type": "string"
279                },
280                "user_id": {
281                  "type": "string"
282                }
283              }
284            },
285            "display_name": {
286              "type": "string",
287              "description": "Display name of the store."
288            },
289            "store_type": {
290              "type": "string",
291              "description": "Category in which the store falls, e.g., Mall, High Street, Warehouse."
292            },
293            "stage": {
294              "type": "string",
295              "description": "Current stage of the store in its lifecycle."
296            },
297            "name": {
298              "type": "string",
299              "description": "Name of the store created."
300            },
301            "code": {
302              "type": "string",
303              "description": "Unique code associated with the store for identification."
304            },
305            "contact_numbers": {
306              "type": "array",
307              "items": {
308                "type": "object",
309                "properties": {
310                  "country_code": {
311                    "type": "integer"
312                  },
313                  "number": {
314                    "type": "string"
315                  }
316                }
317              }
318            },
319            "gst_credentials": {
320              "type": "object",
321              "properties": {
322                "e_invoice": {
323                  "type": "object",
324                  "properties": {
325                    "enabled": {
326                      "type": "boolean"
327                    }
328                  }
329                },
330                "e_waybill": {
331                  "type": "object",
332                  "properties": {
333                    "enabled": {
334                      "type": "boolean"
335                    }
336                  }
337                }
338              }
339            },
340            "timing": {
341              "type": "array",
342              "items": {
343                "type": "object",
344                "properties": {
345                  "open": {
346                    "type": "boolean",
347                    "description": "Indicates whether the store is open during the day."
348                  },
349                  "weekday": {
350                    "type": "string",
351                    "description": "Indicates the name of the weekday."
352                  },
353                  "closing": {
354                    "type": "object",
355                    "description": "Timing details for the closing of the store.",
356                    "properties": {
357                      "hour": {
358                        "type": "integer",
359                        "description": "Hour at which the store is closed."
360                      },
361                      "minute": {
362                        "type": "integer",
363                        "description": "Minute at which the store is closed."
364                      }
365                    }
366                  },
367                  "opening": {
368                    "type": "object",
369                    "description": "Timing details for the opening of the store.",
370                    "properties": {
371                      "hour": {
372                        "type": "integer",
373                        "description": "Hour at which the store is closed."
374                      },
375                      "minute": {
376                        "type": "integer",
377                        "description": "Minute at which the store is closed."
378                      }
379                    }
380                  }
381                }
382              }
383            },
384            "tags": {
385              "type": "array",
386              "items": {
387                "type": "string"
388              },
389              "description": "Tags associated with the store for categorization or searchability."
390            },
391            "verified_on": {
392              "type": "string",
393              "description": "ISODate string when the store was last verified."
394            },
395            "verified_by": {
396              "type": "object",
397              "properties": {
398                "username": {
399                  "type": "string",
400                  "description": "Username of the verifier."
401                },
402                "user_id": {
403                  "type": "string",
404                  "description": "User ID of the verifier."
405                }
406              },
407              "description": "Details of the person who verified the store."
408            }
409          }
410        }
411      }
412    }
413  }
414}
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": "HARISH.LOGISTICMGR@CAMPUSSHOES.COM",
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        "arun@campusshoes.com"
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}

company/location/create/v2

this event is triggered when location is created

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
product_return_config
object
Properties
on_same_store
boolean
contact_numbers
array of object
Array of Properties
number
string
country_code
integer
documents
array of Undefined Type
company
integer
address
object
Properties
address1
string
state
string
country_code
string
city
string
latitude
number
pincode
string
longitude
number
country
string
manager
object
Properties
mobile_no
object
Properties
number
string
country_code
integer
name
string
email
string
avg_order_processing_time
object
Properties
duration_type
string
duration
integer
gst_credentials
object
Properties
e_waybill
object
Properties
enabled
boolean
e_invoice
object
Properties
enabled
boolean
auto_assign_courier_partner
boolean
auto_invoice
boolean
modified_on
string
created_by
object
Properties
username
string
user_id
string
timing
array of object
Array of Properties
open
boolean
Indicates whether the store is open during the day.
weekday
string
Indicates the name of the weekday.
closing
object
Timing details for the closing of the store.
Properties
hour
integer
Hour at which the store is closed.
minute
integer
Minute at which the store is closed.
opening
object
Timing details for the opening of the store.
Properties
hour
integer
Hour at which the store is closed.
minute
integer
Minute at which the store is closed.
name
string
_id
string
modified_by
object
Properties
username
string
user_id
string
uid
integer
stage
string
display_name
string
credit_note
boolean
code
string
bulk_shipment
boolean
tags
array of Undefined Type
store_type
string
created_on
string
warnings
object
order_acceptance_timing
array of object
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
notification_emails
array of string
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                }
78              }
79            },
80            "contact_numbers": {
81              "type": "array",
82              "items": {
83                "type": "object",
84                "properties": {
85                  "number": {
86                    "type": "string"
87                  },
88                  "country_code": {
89                    "type": "integer"
90                  }
91                }
92              }
93            },
94            "documents": {
95              "type": "array",
96              "items": {}
97            },
98            "company": {
99              "type": "integer"
100            },
101            "address": {
102              "type": "object",
103              "properties": {
104                "address1": {
105                  "type": "string"
106                },
107                "state": {
108                  "type": "string"
109                },
110                "country_code": {
111                  "type": "string"
112                },
113                "city": {
114                  "type": "string"
115                },
116                "latitude": {
117                  "type": "number"
118                },
119                "pincode": {
120                  "type": "string"
121                },
122                "longitude": {
123                  "type": "number"
124                },
125                "country": {
126                  "type": "string"
127                }
128              }
129            },
130            "manager": {
131              "type": "object",
132              "properties": {
133                "mobile_no": {
134                  "type": "object",
135                  "properties": {
136                    "number": {
137                      "type": "string"
138                    },
139                    "country_code": {
140                      "type": "integer"
141                    }
142                  }
143                },
144                "name": {
145                  "type": "string"
146                },
147                "email": {
148                  "type": "string"
149                }
150              }
151            },
152            "avg_order_processing_time": {
153              "type": "object",
154              "properties": {
155                "duration_type": {
156                  "type": "string"
157                },
158                "duration": {
159                  "type": "integer"
160                }
161              }
162            },
163            "gst_credentials": {
164              "type": "object",
165              "properties": {
166                "e_waybill": {
167                  "type": "object",
168                  "properties": {
169                    "enabled": {
170                      "type": "boolean"
171                    }
172                  }
173                },
174                "e_invoice": {
175                  "type": "object",
176                  "properties": {
177                    "enabled": {
178                      "type": "boolean"
179                    }
180                  }
181                }
182              }
183            },
184            "auto_assign_courier_partner": {
185              "type": "boolean"
186            },
187            "auto_invoice": {
188              "type": "boolean"
189            },
190            "modified_on": {
191              "type": "string"
192            },
193            "created_by": {
194              "type": "object",
195              "properties": {
196                "username": {
197                  "type": "string"
198                },
199                "user_id": {
200                  "type": "string"
201                }
202              }
203            },
204            "timing": {
205              "type": "array",
206              "items": {
207                "type": "object",
208                "properties": {
209                  "open": {
210                    "type": "boolean",
211                    "description": "Indicates whether the store is open during the day."
212                  },
213                  "weekday": {
214                    "type": "string",
215                    "description": "Indicates the name of the weekday."
216                  },
217                  "closing": {
218                    "type": "object",
219                    "description": "Timing details for the closing of the store.",
220                    "properties": {
221                      "hour": {
222                        "type": "integer",
223                        "description": "Hour at which the store is closed."
224                      },
225                      "minute": {
226                        "type": "integer",
227                        "description": "Minute at which the store is closed."
228                      }
229                    }
230                  },
231                  "opening": {
232                    "type": "object",
233                    "description": "Timing details for the opening of the store.",
234                    "properties": {
235                      "hour": {
236                        "type": "integer",
237                        "description": "Hour at which the store is closed."
238                      },
239                      "minute": {
240                        "type": "integer",
241                        "description": "Minute at which the store is closed."
242                      }
243                    }
244                  }
245                }
246              }
247            },
248            "name": {
249              "type": "string"
250            },
251            "_id": {
252              "type": "string"
253            },
254            "modified_by": {
255              "type": "object",
256              "properties": {
257                "username": {
258                  "type": "string"
259                },
260                "user_id": {
261                  "type": "string"
262                }
263              }
264            },
265            "uid": {
266              "type": "integer"
267            },
268            "stage": {
269              "type": "string"
270            },
271            "display_name": {
272              "type": "string"
273            },
274            "credit_note": {
275              "type": "boolean"
276            },
277            "code": {
278              "type": "string"
279            },
280            "bulk_shipment": {
281              "type": "boolean"
282            },
283            "tags": {
284              "type": "array",
285              "items": {}
286            },
287            "store_type": {
288              "type": "string"
289            },
290            "created_on": {
291              "type": "string"
292            },
293            "warnings": {
294              "type": "object"
295            },
296            "order_acceptance_timing": {
297              "type": "array",
298              "items": {
299                "type": "object",
300                "properties": {
301                  "open": {
302                    "type": "boolean"
303                  },
304                  "weekday": {
305                    "type": "string"
306                  },
307                  "closing": {
308                    "type": "object",
309                    "properties": {
310                      "hour": {
311                        "type": "integer"
312                      },
313                      "minute": {
314                        "type": "integer"
315                      }
316                    }
317                  },
318                  "opening": {
319                    "type": "object",
320                    "properties": {
321                      "hour": {
322                        "type": "integer"
323                      },
324                      "minute": {
325                        "type": "integer"
326                      }
327                    }
328                  }
329                }
330              }
331            },
332            "default_order_acceptance_timing": {
333              "type": "boolean"
334            },
335            "notification_emails": {
336              "type": "array",
337              "items": {
338                "type": "string"
339              }
340            }
341          }
342        }
343      }
344    }
345  }
346}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "viking-utils.0bf48b84-0919-11ef-ae4b-8630e04ab204"
5    ],
6    "name": "location",
7    "type": "create",
8    "version": "2",
9    "created_timestamp": 1714718865118,
10    "id": "8ECdQulqoEvD86FcllObQnWbzBDj1IuyW442UP12qUw=",
11    "category": "company",
12    "referer": "sit.fyndx1.de"
13  },
14  "company_id": 31732,
15  "contains": [
16    "location"
17  ],
18  "payload": {
19    "location": {
20      "_id": "66348890ea6d8cc0d4311cb8",
21      "code": "HS-e1feb",
22      "created_on": "2024-05-03T06:47:44.742309",
23      "stage": "complete",
24      "address": {
25        "address1": "Malad",
26        "latitude": 19.0759837,
27        "city": "Mumbai",
28        "country": "India",
29        "state": "Maharashtra",
30        "country_code": "IN",
31        "pincode": "400067",
32        "longitude": 72.8776559
33      },
34      "tags": [],
35      "documents": [
36        {
37          "verified": true,
38          "value": "27AALCA0442L1ZM",
39          "type": "gst"
40        }
41      ],
42      "order_acceptance_timing": [
43        {
44          "weekday": "monday",
45          "closing": {
46            "minute": 30,
47            "hour": 21
48          },
49          "open": true,
50          "opening": {
51            "minute": 0,
52            "hour": 11
53          }
54        },
55        {
56          "weekday": "tuesday",
57          "closing": {
58            "minute": 30,
59            "hour": 21
60          },
61          "open": true,
62          "opening": {
63            "minute": 0,
64            "hour": 11
65          }
66        },
67        {
68          "weekday": "wednesday",
69          "closing": {
70            "minute": 30,
71            "hour": 21
72          },
73          "open": true,
74          "opening": {
75            "minute": 0,
76            "hour": 11
77          }
78        },
79        {
80          "weekday": "thursday",
81          "closing": {
82            "minute": 30,
83            "hour": 21
84          },
85          "open": true,
86          "opening": {
87            "minute": 0,
88            "hour": 11
89          }
90        },
91        {
92          "weekday": "friday",
93          "closing": {
94            "minute": 30,
95            "hour": 21
96          },
97          "open": true,
98          "opening": {
99            "minute": 0,
100            "hour": 11
101          }
102        },
103        {
104          "weekday": "saturday",
105          "closing": {
106            "minute": 30,
107            "hour": 21
108          },
109          "open": true,
110          "opening": {
111            "minute": 0,
112            "hour": 11
113          }
114        },
115        {
116          "weekday": "sunday",
117          "closing": {
118            "minute": 30,
119            "hour": 21
120          },
121          "open": true,
122          "opening": {
123            "minute": 0,
124            "hour": 11
125          }
126        }
127      ],
128      "manager": {
129        "name": "sandbox user",
130        "mobile_no": {
131          "country_code": 91,
132          "number": "8888888888"
133        },
134        "email": "sandbox@gofynd.com"
135      },
136      "modified_by": {
137        "user_id": "9759643b65ebc6bacb5275f5",
138        "username": "sandbox@gofynd.com"
139      },
140      "contact_numbers": [
141        {
142          "country_code": 91,
143          "number": "8888888888"
144        }
145      ],
146      "company": 31732,
147      "uid": 64521,
148      "created_by": {
149        "user_id": "9759643b65ebc6bacb5275f5",
150        "username": "sandbox@gofynd.com"
151      },
152      "auto_invoice": false,
153      "bulk_shipment": false,
154      "name": "Brunt Test Company - 1714718863381",
155      "timing": [
156        {
157          "weekday": "monday",
158          "closing": {
159            "minute": 30,
160            "hour": 21
161          },
162          "open": true,
163          "opening": {
164            "minute": 0,
165            "hour": 11
166          }
167        },
168        {
169          "weekday": "tuesday",
170          "closing": {
171            "minute": 30,
172            "hour": 21
173          },
174          "open": true,
175          "opening": {
176            "minute": 0,
177            "hour": 11
178          }
179        },
180        {
181          "weekday": "wednesday",
182          "closing": {
183            "minute": 30,
184            "hour": 21
185          },
186          "open": true,
187          "opening": {
188            "minute": 0,
189            "hour": 11
190          }
191        },
192        {
193          "weekday": "thursday",
194          "closing": {
195            "minute": 30,
196            "hour": 21
197          },
198          "open": true,
199          "opening": {
200            "minute": 0,
201            "hour": 11
202          }
203        },
204        {
205          "weekday": "friday",
206          "closing": {
207            "minute": 30,
208            "hour": 21
209          },
210          "open": true,
211          "opening": {
212            "minute": 0,
213            "hour": 11
214          }
215        },
216        {
217          "weekday": "saturday",
218          "closing": {
219            "minute": 30,
220            "hour": 21
221          },
222          "open": true,
223          "opening": {
224            "minute": 0,
225            "hour": 11
226          }
227        },
228        {
229          "weekday": "sunday",
230          "closing": {
231            "minute": 30,
232            "hour": 21
233          },
234          "open": true,
235          "opening": {
236            "minute": 0,
237            "hour": 11
238          }
239        }
240      ],
241      "credit_note": false,
242      "store_type": "high_street",
243      "gst_credentials": {
244        "e_invoice": {
245          "enabled": false
246        },
247        "e_waybill": {
248          "enabled": false
249        }
250      },
251      "default_order_acceptance_timing": true,
252      "avg_order_processing_time": {
253        "duration_type": "days",
254        "duration": 1
255      },
256      "auto_assign_courier_partner": true,
257      "warnings": {},
258      "modified_on": "2024-05-03T06:47:44.742314",
259      "product_return_config": {
260        "on_same_store": true
261      },
262      "display_name": "Brunt Test Company - 1714718863381",
263      "notification_emails": [
264        "app@gofynd.com"
265      ]
266    }
267  }
268}

company/location/update/v2

this event is triggered when location is updated

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
_id
string
modified_by
object
Properties
username
string
user_id
string
created_on
string
product_return_config
object
Properties
on_same_store
boolean
warnings
object
Properties
store_address
string
manager
object
Properties
mobile_no
object
Properties
country_code
integer
number
string
email
string
name
string
uid
integer
order_acceptance_timing
array of object
Array of Properties
closing
object
Properties
minute
integer
hour
integer
opening
object
Properties
minute
integer
hour
integer
open
boolean
weekday
string
bulk_shipment
boolean
auto_invoice
boolean
modified_on
string
credit_note
boolean
avg_order_processing_time
object
Properties
duration_type
string
duration
integer
documents
array of Undefined Type
default_order_acceptance_timing
boolean
auto_assign_courier_partner
boolean
address
object
Properties
pincode
string
latitude
number
country_code
string
country
string
address1
string
longitude
number
city
string
state
string
notification_emails
array of string
company
integer
created_by
object
Properties
username
string
user_id
string
display_name
string
store_type
string
stage
string
name
string
code
string
contact_numbers
array of object
Array of Properties
country_code
integer
number
string
gst_credentials
object
Properties
e_invoice
object
Properties
enabled
boolean
e_waybill
object
Properties
enabled
boolean
timing
array of object
Array of Properties
open
boolean
Indicates whether the store is open during the day.
weekday
string
Indicates the name of the weekday.
closing
object
Timing details for the closing of the store.
Properties
hour
integer
Hour at which the store is closed.
minute
integer
Minute at which the store is closed.
opening
object
Timing details for the opening of the store.
Properties
hour
integer
Hour at which the store is closed.
minute
integer
Minute at which the store is closed.
tags
array of Undefined Type
verified_on
string
verified_by
object
Properties
username
string
user_id
string
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            },
75            "modified_by": {
76              "type": "object",
77              "properties": {
78                "username": {
79                  "type": "string"
80                },
81                "user_id": {
82                  "type": "string"
83                }
84              }
85            },
86            "created_on": {
87              "type": "string"
88            },
89            "product_return_config": {
90              "type": "object",
91              "properties": {
92                "on_same_store": {
93                  "type": "boolean"
94                }
95              }
96            },
97            "warnings": {
98              "type": "object",
99              "properties": {
100                "store_address": {
101                  "type": "string"
102                }
103              }
104            },
105            "manager": {
106              "type": "object",
107              "properties": {
108                "mobile_no": {
109                  "type": "object",
110                  "properties": {
111                    "country_code": {
112                      "type": "integer"
113                    },
114                    "number": {
115                      "type": "string"
116                    }
117                  }
118                },
119                "email": {
120                  "type": "string"
121                },
122                "name": {
123                  "type": "string"
124                }
125              }
126            },
127            "uid": {
128              "type": "integer"
129            },
130            "order_acceptance_timing": {
131              "type": "array",
132              "items": {
133                "type": "object",
134                "properties": {
135                  "closing": {
136                    "type": "object",
137                    "properties": {
138                      "minute": {
139                        "type": "integer"
140                      },
141                      "hour": {
142                        "type": "integer"
143                      }
144                    }
145                  },
146                  "opening": {
147                    "type": "object",
148                    "properties": {
149                      "minute": {
150                        "type": "integer"
151                      },
152                      "hour": {
153                        "type": "integer"
154                      }
155                    }
156                  },
157                  "open": {
158                    "type": "boolean"
159                  },
160                  "weekday": {
161                    "type": "string"
162                  }
163                }
164              }
165            },
166            "bulk_shipment": {
167              "type": "boolean"
168            },
169            "auto_invoice": {
170              "type": "boolean"
171            },
172            "modified_on": {
173              "type": "string"
174            },
175            "credit_note": {
176              "type": "boolean"
177            },
178            "avg_order_processing_time": {
179              "type": "object",
180              "properties": {
181                "duration_type": {
182                  "type": "string"
183                },
184                "duration": {
185                  "type": "integer"
186                }
187              }
188            },
189            "documents": {
190              "type": "array",
191              "items": {}
192            },
193            "default_order_acceptance_timing": {
194              "type": "boolean"
195            },
196            "auto_assign_courier_partner": {
197              "type": "boolean"
198            },
199            "address": {
200              "type": "object",
201              "properties": {
202                "pincode": {
203                  "type": "string"
204                },
205                "latitude": {
206                  "type": "number"
207                },
208                "country_code": {
209                  "type": "string"
210                },
211                "country": {
212                  "type": "string"
213                },
214                "address1": {
215                  "type": "string"
216                },
217                "longitude": {
218                  "type": "number"
219                },
220                "city": {
221                  "type": "string"
222                },
223                "state": {
224                  "type": "string"
225                }
226              }
227            },
228            "notification_emails": {
229              "type": "array",
230              "items": {
231                "type": "string"
232              }
233            },
234            "company": {
235              "type": "integer"
236            },
237            "created_by": {
238              "type": "object",
239              "properties": {
240                "username": {
241                  "type": "string"
242                },
243                "user_id": {
244                  "type": "string"
245                }
246              }
247            },
248            "display_name": {
249              "type": "string"
250            },
251            "store_type": {
252              "type": "string"
253            },
254            "stage": {
255              "type": "string"
256            },
257            "name": {
258              "type": "string"
259            },
260            "code": {
261              "type": "string"
262            },
263            "contact_numbers": {
264              "type": "array",
265              "items": {
266                "type": "object",
267                "properties": {
268                  "country_code": {
269                    "type": "integer"
270                  },
271                  "number": {
272                    "type": "string"
273                  }
274                }
275              }
276            },
277            "gst_credentials": {
278              "type": "object",
279              "properties": {
280                "e_invoice": {
281                  "type": "object",
282                  "properties": {
283                    "enabled": {
284                      "type": "boolean"
285                    }
286                  }
287                },
288                "e_waybill": {
289                  "type": "object",
290                  "properties": {
291                    "enabled": {
292                      "type": "boolean"
293                    }
294                  }
295                }
296              }
297            },
298            "timing": {
299              "type": "array",
300              "items": {
301                "type": "object",
302                "properties": {
303                  "open": {
304                    "type": "boolean",
305                    "description": "Indicates whether the store is open during the day."
306                  },
307                  "weekday": {
308                    "type": "string",
309                    "description": "Indicates the name of the weekday."
310                  },
311                  "closing": {
312                    "type": "object",
313                    "description": "Timing details for the closing of the store.",
314                    "properties": {
315                      "hour": {
316                        "type": "integer",
317                        "description": "Hour at which the store is closed."
318                      },
319                      "minute": {
320                        "type": "integer",
321                        "description": "Minute at which the store is closed."
322                      }
323                    }
324                  },
325                  "opening": {
326                    "type": "object",
327                    "description": "Timing details for the opening of the store.",
328                    "properties": {
329                      "hour": {
330                        "type": "integer",
331                        "description": "Hour at which the store is closed."
332                      },
333                      "minute": {
334                        "type": "integer",
335                        "description": "Minute at which the store is closed."
336                      }
337                    }
338                  }
339                }
340              }
341            },
342            "tags": {
343              "type": "array",
344              "items": {}
345            },
346            "verified_on": {
347              "type": "string"
348            },
349            "verified_by": {
350              "type": "object",
351              "properties": {
352                "username": {
353                  "type": "string"
354                },
355                "user_id": {
356                  "type": "string"
357                }
358              }
359            }
360          }
361        }
362      }
363    }
364  }
365}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.0d438d00-0919-11ef-8040-d22c35b94424"
5    ],
6    "name": "location",
7    "type": "update",
8    "version": "2",
9    "created_timestamp": 1714718867313,
10    "id": "q/FqHuiBWeR6afcQPnGU0myU9sFyIGL7mSjlCrVQglA=",
11    "category": "company",
12    "referer": "sit.fyndx1.de"
13  },
14  "company_id": 31732,
15  "contains": [
16    "location"
17  ],
18  "payload": {
19    "location": {
20      "_id": "66348890ea6d8cc0d4311cb8",
21      "code": "HS-e1feb",
22      "created_on": "2024-05-03T06:47:44.742000",
23      "stage": "verified",
24      "address": {
25        "address1": "Malad",
26        "latitude": 19.0759837,
27        "city": "Mumbai",
28        "country": "India",
29        "state": "Maharashtra",
30        "country_code": "IN",
31        "pincode": "400067",
32        "longitude": 72.8776559
33      },
34      "tags": [],
35      "documents": [
36        {
37          "verified": true,
38          "value": "27AALCA0442L1ZM",
39          "type": "gst"
40        }
41      ],
42      "order_acceptance_timing": [
43        {
44          "weekday": "monday",
45          "closing": {
46            "minute": 30,
47            "hour": 21
48          },
49          "open": true,
50          "opening": {
51            "minute": 0,
52            "hour": 11
53          }
54        },
55        {
56          "weekday": "tuesday",
57          "closing": {
58            "minute": 30,
59            "hour": 21
60          },
61          "open": true,
62          "opening": {
63            "minute": 0,
64            "hour": 11
65          }
66        },
67        {
68          "weekday": "wednesday",
69          "closing": {
70            "minute": 30,
71            "hour": 21
72          },
73          "open": true,
74          "opening": {
75            "minute": 0,
76            "hour": 11
77          }
78        },
79        {
80          "weekday": "thursday",
81          "closing": {
82            "minute": 30,
83            "hour": 21
84          },
85          "open": true,
86          "opening": {
87            "minute": 0,
88            "hour": 11
89          }
90        },
91        {
92          "weekday": "friday",
93          "closing": {
94            "minute": 30,
95            "hour": 21
96          },
97          "open": true,
98          "opening": {
99            "minute": 0,
100            "hour": 11
101          }
102        },
103        {
104          "weekday": "saturday",
105          "closing": {
106            "minute": 30,
107            "hour": 21
108          },
109          "open": true,
110          "opening": {
111            "minute": 0,
112            "hour": 11
113          }
114        },
115        {
116          "weekday": "sunday",
117          "closing": {
118            "minute": 30,
119            "hour": 21
120          },
121          "open": true,
122          "opening": {
123            "minute": 0,
124            "hour": 11
125          }
126        }
127      ],
128      "manager": {
129        "name": "sandbox user",
130        "mobile_no": {
131          "country_code": 91,
132          "number": "8888888888"
133        },
134        "email": "sandbox@gofynd.com"
135      },
136      "modified_by": {
137        "user_id": "9759643b65ebc6bacb5275f5",
138        "username": "sandbox@gofynd.com"
139      },
140      "contact_numbers": [
141        {
142          "country_code": 91,
143          "number": "8888888888"
144        }
145      ],
146      "company": 31732,
147      "uid": 64521,
148      "created_by": {
149        "user_id": "9759643b65ebc6bacb5275f5",
150        "username": "sandbox@gofynd.com"
151      },
152      "auto_invoice": false,
153      "bulk_shipment": false,
154      "name": "Brunt Test Company - 1714718863381",
155      "timing": [
156        {
157          "weekday": "monday",
158          "closing": {
159            "minute": 30,
160            "hour": 21
161          },
162          "open": true,
163          "opening": {
164            "minute": 0,
165            "hour": 11
166          }
167        },
168        {
169          "weekday": "tuesday",
170          "closing": {
171            "minute": 30,
172            "hour": 21
173          },
174          "open": true,
175          "opening": {
176            "minute": 0,
177            "hour": 11
178          }
179        },
180        {
181          "weekday": "wednesday",
182          "closing": {
183            "minute": 30,
184            "hour": 21
185          },
186          "open": true,
187          "opening": {
188            "minute": 0,
189            "hour": 11
190          }
191        },
192        {
193          "weekday": "thursday",
194          "closing": {
195            "minute": 30,
196            "hour": 21
197          },
198          "open": true,
199          "opening": {
200            "minute": 0,
201            "hour": 11
202          }
203        },
204        {
205          "weekday": "friday",
206          "closing": {
207            "minute": 30,
208            "hour": 21
209          },
210          "open": true,
211          "opening": {
212            "minute": 0,
213            "hour": 11
214          }
215        },
216        {
217          "weekday": "saturday",
218          "closing": {
219            "minute": 30,
220            "hour": 21
221          },
222          "open": true,
223          "opening": {
224            "minute": 0,
225            "hour": 11
226          }
227        },
228        {
229          "weekday": "sunday",
230          "closing": {
231            "minute": 30,
232            "hour": 21
233          },
234          "open": true,
235          "opening": {
236            "minute": 0,
237            "hour": 11
238          }
239        }
240      ],
241      "credit_note": false,
242      "store_type": "high_street",
243      "gst_credentials": {
244        "e_invoice": {
245          "enabled": false
246        },
247        "e_waybill": {
248          "enabled": false
249        }
250      },
251      "default_order_acceptance_timing": true,
252      "avg_order_processing_time": {
253        "duration_type": "days",
254        "duration": 1
255      },
256      "auto_assign_courier_partner": true,
257      "warnings": {
258        "store_address": "Address seems to be inappropriate this might affect the delivery."
259      },
260      "modified_on": "2024-05-03T06:47:44.742000",
261      "product_return_config": {
262        "on_same_store": true
263      },
264      "display_name": "Brunt Test Company - 1714718863381",
265      "notification_emails": [
266        "app@gofynd.com"
267      ],
268      "verified_on": "2024-05-03T06:47:47.261426",
269      "verified_by": {
270        "username": "silverbolt",
271        "user_id": "0"
272      }
273    }
274  }
275}

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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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.
product
object
Properties
slug
string
Slug for the product.
_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              "product": {
238                "type": "object",
239                "properties": {
240                  "slug": {
241                    "type": "string",
242                    "description": "Slug for the product."
243                  }
244                }
245              },
246              "_custom_json": {
247                "type": "object",
248                "description": "Custom JSON data for the product ( can contain any key value pair )"
249              }
250            }
251          }
252        }
253      }
254    }
255  }
256}
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        "product": {
76          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
77        }
78      }
79    ]
80  }
81}

company/product-size/update/v1

this event is triggered when product-size is updated

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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.
product
object
Properties
slug
string
Slug for the product.
_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              "product": {
238                "type": "object",
239                "properties": {
240                  "slug": {
241                    "type": "string",
242                    "description": "Slug for the product."
243                  }
244                }
245              },
246              "_custom_json": {
247                "type": "object",
248                "description": "Custom JSON data for the product ( can contain any key value pair )"
249              }
250            }
251          }
252        }
253      }
254    }
255  }
256}
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        "product": {
72          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
73        }
74      },
75      {
76        "_id": "65604051f50ddd0b7df5ec5a",
77        "brand_uid": 61,
78        "company_id": 42,
79        "currency": "INR",
80        "dimensions": {
81          "item_dimensions_unit_of_measure": "cm",
82          "item_height": 32,
83          "item_length": 12,
84          "item_weight": 2000,
85          "item_weight_unit_of_measure": "gram",
86          "item_width": 22
87        },
88        "identifiers": [
89          {
90            "gtin_type": "ean",
91            "gtin_value": "5050409521960",
92            "primary": true
93          }
94        ],
95        "is_active": true,
96        "is_set": false,
97        "item_code": "26140139",
98        "item_id": 7817584,
99        "modified_by": {
100          "super_user": false,
101          "user_id": "5eb2fca2e72f8a243fbfd696",
102          "username": "bijal_thakker_clarks_in_56048"
103        },
104        "price": 7499,
105        "price_effective": 7499,
106        "price_transfer": 0,
107        "return_config": {
108          "returnable": true,
109          "time": 15,
110          "unit": "days"
111        },
112        "seller_identifier": "5050409521960",
113        "size": "6",
114        "tax_identifier": {
115          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
116        },
117        "track_inventory": true,
118        "trader": [
119          {
120            "address": [
121              "dummy data"
122            ],
123            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
124            "type": "Importer"
125          }
126        ],
127        "product": {
128          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
129        }
130      },
131      {
132        "_id": "65604051f50ddd0b7df5ec5c",
133        "brand_uid": 61,
134        "company_id": 42,
135        "currency": "INR",
136        "dimensions": {
137          "item_dimensions_unit_of_measure": "cm",
138          "item_height": 32,
139          "item_length": 12,
140          "item_weight": 2000,
141          "item_weight_unit_of_measure": "gram",
142          "item_width": 23
143        },
144        "identifiers": [
145          {
146            "gtin_type": "ean",
147            "gtin_value": "5050409521984",
148            "primary": true
149          }
150        ],
151        "is_active": true,
152        "is_set": false,
153        "item_code": "26140139",
154        "item_id": 7817584,
155        "modified_by": {
156          "super_user": false,
157          "user_id": "5eb2fca2e72f8a243fbfd696",
158          "username": "bijal_thakker_clarks_in_56048"
159        },
160        "price": 7499,
161        "price_effective": 7499,
162        "price_transfer": 0,
163        "return_config": {
164          "returnable": true,
165          "time": 15,
166          "unit": "days"
167        },
168        "seller_identifier": "5050409521984",
169        "size": "7",
170        "tax_identifier": {
171          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
172        },
173        "track_inventory": true,
174        "trader": [
175          {
176            "address": [
177              "dummy data"
178            ],
179            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
180            "type": "Importer"
181          }
182        ],
183        "product": {
184          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
185        }
186      },
187      {
188        "_id": "65604051f50ddd0b7df5ec64",
189        "brand_uid": 61,
190        "company_id": 42,
191        "currency": "INR",
192        "dimensions": {
193          "item_dimensions_unit_of_measure": "cm",
194          "item_height": 32,
195          "item_length": 12,
196          "item_weight": 2000,
197          "item_weight_unit_of_measure": "gram",
198          "item_width": 22
199        },
200        "identifiers": [
201          {
202            "gtin_type": "ean",
203            "gtin_value": "5050409522066",
204            "primary": true
205          }
206        ],
207        "is_active": true,
208        "is_set": false,
209        "item_code": "26140139",
210        "item_id": 7817584,
211        "modified_by": {
212          "super_user": false,
213          "user_id": "5eb2fca2e72f8a243fbfd696",
214          "username": "bijal_thakker_clarks_in_56048"
215        },
216        "price": 7499,
217        "price_effective": 7499,
218        "price_transfer": 0,
219        "return_config": {
220          "returnable": true,
221          "time": 15,
222          "unit": "days"
223        },
224        "seller_identifier": "5050409522066",
225        "size": "11",
226        "tax_identifier": {
227          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
228        },
229        "track_inventory": true,
230        "trader": [
231          {
232            "address": [
233              "dummy data"
234            ],
235            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
236            "type": "Importer"
237          }
238        ],
239        "product": {
240          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
241        }
242      },
243      {
244        "_id": "65604051f50ddd0b7df5ec5b",
245        "brand_uid": 61,
246        "company_id": 42,
247        "currency": "INR",
248        "dimensions": {
249          "item_dimensions_unit_of_measure": "cm",
250          "item_height": 32,
251          "item_length": 12,
252          "item_weight": 2000,
253          "item_weight_unit_of_measure": "gram",
254          "item_width": 22
255        },
256        "identifiers": [
257          {
258            "gtin_type": "ean",
259            "gtin_value": "5050409521977",
260            "primary": true
261          }
262        ],
263        "is_active": true,
264        "is_set": false,
265        "item_code": "26140139",
266        "item_id": 7817584,
267        "modified_by": {
268          "super_user": false,
269          "user_id": "5eb2fca2e72f8a243fbfd696",
270          "username": "bijal_thakker_clarks_in_56048"
271        },
272        "price": 7499,
273        "price_effective": 7499,
274        "price_transfer": 0,
275        "return_config": {
276          "returnable": true,
277          "time": 15,
278          "unit": "days"
279        },
280        "seller_identifier": "5050409521977",
281        "size": "6.5",
282        "tax_identifier": {
283          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
284        },
285        "track_inventory": true,
286        "trader": [
287          {
288            "address": [
289              "dummy data"
290            ],
291            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
292            "type": "Importer"
293          }
294        ],
295        "product": {
296          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
297        }
298      },
299      {
300        "_id": "65604051f50ddd0b7df5ec5d",
301        "brand_uid": 61,
302        "company_id": 42,
303        "currency": "INR",
304        "dimensions": {
305          "item_dimensions_unit_of_measure": "cm",
306          "item_height": 32,
307          "item_length": 12,
308          "item_weight": 2000,
309          "item_weight_unit_of_measure": "gram",
310          "item_width": 22
311        },
312        "identifiers": [
313          {
314            "gtin_type": "ean",
315            "gtin_value": "5050409521991",
316            "primary": true
317          }
318        ],
319        "is_active": true,
320        "is_set": false,
321        "item_code": "26140139",
322        "item_id": 7817584,
323        "modified_by": {
324          "super_user": false,
325          "user_id": "5eb2fca2e72f8a243fbfd696",
326          "username": "bijal_thakker_clarks_in_56048"
327        },
328        "price": 7499,
329        "price_effective": 7499,
330        "price_transfer": 0,
331        "return_config": {
332          "returnable": true,
333          "time": 15,
334          "unit": "days"
335        },
336        "seller_identifier": "5050409521991",
337        "size": "7.5",
338        "tax_identifier": {
339          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
340        },
341        "track_inventory": true,
342        "trader": [
343          {
344            "address": [
345              "dummy data"
346            ],
347            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
348            "type": "Importer"
349          }
350        ],
351        "product": {
352          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
353        }
354      },
355      {
356        "_id": "65604051f50ddd0b7df5ec61",
357        "brand_uid": 61,
358        "company_id": 42,
359        "currency": "INR",
360        "dimensions": {
361          "item_dimensions_unit_of_measure": "cm",
362          "item_height": 32,
363          "item_length": 12,
364          "item_weight": 2000,
365          "item_weight_unit_of_measure": "gram",
366          "item_width": 22
367        },
368        "identifiers": [
369          {
370            "gtin_type": "ean",
371            "gtin_value": "5050409522035",
372            "primary": true
373          }
374        ],
375        "is_active": true,
376        "is_set": false,
377        "item_code": "26140139",
378        "item_id": 7817584,
379        "modified_by": {
380          "super_user": false,
381          "user_id": "5eb2fca2e72f8a243fbfd696",
382          "username": "bijal_thakker_clarks_in_56048"
383        },
384        "price": 7499,
385        "price_effective": 7499,
386        "price_transfer": 0,
387        "return_config": {
388          "returnable": true,
389          "time": 15,
390          "unit": "days"
391        },
392        "seller_identifier": "5050409522035",
393        "size": "9.5",
394        "tax_identifier": {
395          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
396        },
397        "track_inventory": true,
398        "trader": [
399          {
400            "address": [
401              "dummy data"
402            ],
403            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
404            "type": "Importer"
405          }
406        ],
407        "product": {
408          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
409        }
410      },
411      {
412        "_id": "65604051f50ddd0b7df5ec5e",
413        "brand_uid": 61,
414        "company_id": 42,
415        "currency": "INR",
416        "dimensions": {
417          "item_dimensions_unit_of_measure": "cm",
418          "item_height": 32,
419          "item_length": 12,
420          "item_weight": 2000,
421          "item_weight_unit_of_measure": "gram",
422          "item_width": 22
423        },
424        "identifiers": [
425          {
426            "gtin_type": "ean",
427            "gtin_value": "5050409522004",
428            "primary": true
429          }
430        ],
431        "is_active": true,
432        "is_set": false,
433        "item_code": "26140139",
434        "item_id": 7817584,
435        "modified_by": {
436          "super_user": false,
437          "user_id": "5eb2fca2e72f8a243fbfd696",
438          "username": "bijal_thakker_clarks_in_56048"
439        },
440        "price": 7499,
441        "price_effective": 7499,
442        "price_transfer": 0,
443        "return_config": {
444          "returnable": true,
445          "time": 15,
446          "unit": "days"
447        },
448        "seller_identifier": "5050409522004",
449        "size": "8",
450        "tax_identifier": {
451          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
452        },
453        "track_inventory": true,
454        "trader": [
455          {
456            "address": [
457              "dummy data"
458            ],
459            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
460            "type": "Importer"
461          }
462        ],
463        "product": {
464          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
465        }
466      },
467      {
468        "_id": "65604051f50ddd0b7df5ec63",
469        "brand_uid": 61,
470        "company_id": 42,
471        "currency": "INR",
472        "dimensions": {
473          "item_dimensions_unit_of_measure": "cm",
474          "item_height": 32,
475          "item_length": 12,
476          "item_weight": 2000,
477          "item_weight_unit_of_measure": "gram",
478          "item_width": 22
479        },
480        "identifiers": [
481          {
482            "gtin_type": "ean",
483            "gtin_value": "5050409522059",
484            "primary": true
485          }
486        ],
487        "is_active": true,
488        "is_set": false,
489        "item_code": "26140139",
490        "item_id": 7817584,
491        "modified_by": {
492          "super_user": false,
493          "user_id": "5eb2fca2e72f8a243fbfd696",
494          "username": "bijal_thakker_clarks_in_56048"
495        },
496        "price": 7499,
497        "price_effective": 7499,
498        "price_transfer": 0,
499        "return_config": {
500          "returnable": true,
501          "time": 15,
502          "unit": "days"
503        },
504        "seller_identifier": "5050409522059",
505        "size": "10.5",
506        "tax_identifier": {
507          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
508        },
509        "track_inventory": true,
510        "trader": [
511          {
512            "address": [
513              "dummy data"
514            ],
515            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
516            "type": "Importer"
517          }
518        ],
519        "product": {
520          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
521        }
522      },
523      {
524        "_id": "65604051f50ddd0b7df5ec65",
525        "brand_uid": 61,
526        "company_id": 42,
527        "currency": "INR",
528        "dimensions": {
529          "item_dimensions_unit_of_measure": "cm",
530          "item_height": 32,
531          "item_length": 12,
532          "item_weight": 2000,
533          "item_weight_unit_of_measure": "gram",
534          "item_width": 22
535        },
536        "identifiers": [
537          {
538            "gtin_type": "ean",
539            "gtin_value": "5050409522073",
540            "primary": true
541          }
542        ],
543        "is_active": true,
544        "is_set": false,
545        "item_code": "26140139",
546        "item_id": 7817584,
547        "modified_by": {
548          "super_user": false,
549          "user_id": "5eb2fca2e72f8a243fbfd696",
550          "username": "bijal_thakker_clarks_in_56048"
551        },
552        "price": 7499,
553        "price_effective": 7499,
554        "price_transfer": 0,
555        "return_config": {
556          "returnable": true,
557          "time": 15,
558          "unit": "days"
559        },
560        "seller_identifier": "5050409522073",
561        "size": "12",
562        "tax_identifier": {
563          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
564        },
565        "track_inventory": true,
566        "trader": [
567          {
568            "address": [
569              "dummy data"
570            ],
571            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
572            "type": "Importer"
573          }
574        ],
575        "product": {
576          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
577        }
578      },
579      {
580        "_id": "65604051f50ddd0b7df5ec5f",
581        "brand_uid": 61,
582        "company_id": 42,
583        "currency": "INR",
584        "dimensions": {
585          "item_dimensions_unit_of_measure": "cm",
586          "item_height": 32,
587          "item_length": 12,
588          "item_weight": 2000,
589          "item_weight_unit_of_measure": "gram",
590          "item_width": 22
591        },
592        "identifiers": [
593          {
594            "gtin_type": "ean",
595            "gtin_value": "5050409522011",
596            "primary": true
597          }
598        ],
599        "is_active": true,
600        "is_set": false,
601        "item_code": "26140139",
602        "item_id": 7817584,
603        "modified_by": {
604          "super_user": false,
605          "user_id": "5eb2fca2e72f8a243fbfd696",
606          "username": "bijal_thakker_clarks_in_56048"
607        },
608        "price": 7499,
609        "price_effective": 7499,
610        "price_transfer": 0,
611        "return_config": {
612          "returnable": true,
613          "time": 15,
614          "unit": "days"
615        },
616        "seller_identifier": "5050409522011",
617        "size": "8.5",
618        "tax_identifier": {
619          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
620        },
621        "track_inventory": true,
622        "trader": [
623          {
624            "address": [
625              "dummy data"
626            ],
627            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
628            "type": "Importer"
629          }
630        ],
631        "product": {
632          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
633        }
634      },
635      {
636        "_id": "65604051f50ddd0b7df5ec62",
637        "brand_uid": 61,
638        "company_id": 42,
639        "currency": "INR",
640        "dimensions": {
641          "item_dimensions_unit_of_measure": "cm",
642          "item_height": 32,
643          "item_length": 12,
644          "item_weight": 2000,
645          "item_weight_unit_of_measure": "gram",
646          "item_width": 21
647        },
648        "identifiers": [
649          {
650            "gtin_type": "ean",
651            "gtin_value": "5050409522042",
652            "primary": true
653          }
654        ],
655        "is_active": true,
656        "is_set": false,
657        "item_code": "26140139",
658        "item_id": 7817584,
659        "modified_by": {
660          "super_user": false,
661          "user_id": "5eb2fca2e72f8a243fbfd696",
662          "username": "bijal_thakker_clarks_in_56048"
663        },
664        "price": 7499,
665        "price_effective": 7499,
666        "price_transfer": 0,
667        "return_config": {
668          "returnable": true,
669          "time": 15,
670          "unit": "days"
671        },
672        "seller_identifier": "5050409522042",
673        "size": "10",
674        "tax_identifier": {
675          "hsn_code_id": "6277839f5e4c6fdbc8be41dc"
676        },
677        "track_inventory": true,
678        "trader": [
679          {
680            "address": [
681              "dummy data"
682            ],
683            "name": "CLARKS RELIANCE FOOTWEAR PRIVATE LIMITED",
684            "type": "Importer"
685          }
686        ],
687        "product": {
688          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
689        }
690      }
691    ]
692  }
693}

company/product-size/create/v2

this event is triggered when product-size is created

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
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
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                "x-not-enum": true
100              },
101              "price": {
102                "type": "number",
103                "description": "Price of the item"
104              },
105              "price_transfer": {
106                "type": "number",
107                "description": "Transfer price of the item"
108              },
109              "identifiers": {
110                "type": "array",
111                "items": {
112                  "type": "object"
113                },
114                "description": "List of identifiers for this product"
115              },
116              "is_set": {
117                "type": "boolean",
118                "description": "Whether the product is a set of multiple items or not"
119              },
120              "size": {
121                "type": "string",
122                "description": "Size of the item"
123              },
124              "track_inventory": {
125                "type": "boolean",
126                "description": "Whether to track inventory for the product or not"
127              },
128              "price_effective": {
129                "type": "number",
130                "description": "Effective price of the item"
131              },
132              "company_id": {
133                "type": "integer",
134                "description": "The ID of the company the product belongs to"
135              },
136              "currency": {
137                "type": "string",
138                "description": "The currency used for pricing the product"
139              },
140              "return_config": {
141                "type": "object",
142                "required": [
143                  "returnable"
144                ],
145                "properties": {
146                  "returnable": {
147                    "type": "boolean",
148                    "description": "Indicates whether the product is returnable or not"
149                  },
150                  "time": {
151                    "type": "integer",
152                    "description": "Time duration for returns"
153                  },
154                  "unit": {
155                    "type": "string",
156                    "description": "Unit of time for return duration"
157                  }
158                },
159                "description": "Return configuration for the product"
160              },
161              "is_active": {
162                "type": "boolean",
163                "description": "Whether the product is currently active or not"
164              },
165              "trader": {
166                "type": "array",
167                "description": "Trader information.",
168                "items": {
169                  "type": "object",
170                  "required": [
171                    "address",
172                    "type",
173                    "name"
174                  ],
175                  "properties": {
176                    "address": {
177                      "type": "array",
178                      "items": {
179                        "type": "string"
180                      },
181                      "description": "The address of the trader."
182                    },
183                    "type": {
184                      "type": "string",
185                      "description": "The type of trader."
186                    },
187                    "name": {
188                      "type": "string"
189                    }
190                  },
191                  "description": "Trader information"
192                }
193              },
194              "item_id": {
195                "type": "integer",
196                "description": "ID of the item"
197              },
198              "dimensions": {
199                "type": "object",
200                "description": "Dimensions of the item.",
201                "properties": {
202                  "item_length": {
203                    "type": "number",
204                    "description": "Length of the item in centimeters."
205                  },
206                  "item_width": {
207                    "type": "number",
208                    "description": "Width of the item in centimeters."
209                  },
210                  "item_height": {
211                    "type": "number",
212                    "description": "Height of the item in centimeters."
213                  },
214                  "item_weight": {
215                    "type": "number",
216                    "description": "Weight of the item in grams."
217                  },
218                  "item_weight_unit_of_measure": {
219                    "type": "string",
220                    "description": "Unit of measure for the item's weight (e.g., \"gram\")."
221                  },
222                  "item_dimensions_unit_of_measure": {
223                    "type": "string",
224                    "description": "Unit of measure for the item's dimensions (e.g., \"cm\")."
225                  }
226                }
227              },
228              "tax_identifier": {
229                "type": "object",
230                "description": "Tax identifier for the product"
231              },
232              "_custom_json": {
233                "type": "object",
234                "description": "Custom JSON data for the product"
235              }
236            }
237          }
238        }
239      }
240    }
241  }
242}
Payload Example
1{
2  "company_id": 1202,
3  "contains": [
4    "product-size"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1712153363458,
9    "id": "LwLNywt40aw0FZSrK9CdnSo35J/3EWZnxnFT93dNyI8=",
10    "name": "product-size",
11    "trace_id": [
12      "silverbolt.c5cde860-f1c3-11ee-8e32-1670e4e67cd9"
13    ],
14    "type": "create",
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.026532",
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_active": true,
42        "is_set": false,
43        "item_code": "ITEM123",
44        "item_id": 10242321,
45        "modified_by": {
46          "super_user": false,
47          "user_id": "c068a675de437e48d5db3537",
48          "username": "rohinipawar_gofynd_com_33829"
49        },
50        "modified_on": "2024-04-03T14:09:23.026537",
51        "price": 1,
52        "price_effective": 1,
53        "price_transfer": 0,
54        "return_config": {
55          "returnable": false,
56          "time": 0,
57          "unit": "days"
58        },
59        "seller_identifier": "ABCROHINI",
60        "size": "L",
61        "tax_identifier": {
62          "hsn_code_id": "65fd783dc528d7515782df49"
63        },
64        "track_inventory": true,
65        "trader": [
66          {
67            "address": [
68              "ABc"
69            ],
70            "name": "ABC",
71            "type": "Manufacturer"
72          }
73        ],
74        "product": {
75          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
76        }
77      }
78    ]
79  }
80}

company/product-size/delete/v2

this event is triggered when product-size is deleted

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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                "x-not-enum": true
100              },
101              "price": {
102                "type": "number",
103                "description": "Price of the item"
104              },
105              "price_transfer": {
106                "type": "number",
107                "description": "Transfer price of the item"
108              },
109              "identifiers": {
110                "type": "array",
111                "items": {
112                  "type": "object"
113                },
114                "description": "List of identifiers for this product"
115              },
116              "is_set": {
117                "type": "boolean",
118                "description": "Whether the product is a set of multiple items or not"
119              },
120              "size": {
121                "type": "string",
122                "description": "Size of the item"
123              },
124              "track_inventory": {
125                "type": "boolean",
126                "description": "Whether to track inventory for the product or not"
127              },
128              "price_effective": {
129                "type": "number",
130                "description": "Effective price of the item"
131              },
132              "company_id": {
133                "type": "integer",
134                "description": "The ID of the company the product belongs to"
135              },
136              "currency": {
137                "type": "string",
138                "description": "The currency used for pricing the product"
139              },
140              "return_config": {
141                "type": "object",
142                "required": [
143                  "returnable"
144                ],
145                "properties": {
146                  "returnable": {
147                    "type": "boolean",
148                    "description": "Indicates whether the product is returnable or not"
149                  },
150                  "time": {
151                    "type": "integer",
152                    "description": "Time duration for returns"
153                  },
154                  "unit": {
155                    "type": "string",
156                    "description": "Unit of time for return duration"
157                  }
158                },
159                "description": "Return configuration for the product"
160              },
161              "is_active": {
162                "type": "boolean",
163                "description": "Whether the product is currently active or not"
164              },
165              "trader": {
166                "type": "array",
167                "description": "Trader information.",
168                "items": {
169                  "type": "object",
170                  "required": [
171                    "address",
172                    "type",
173                    "name"
174                  ],
175                  "properties": {
176                    "address": {
177                      "type": "array",
178                      "items": {
179                        "type": "string"
180                      },
181                      "description": "The address of the trader."
182                    },
183                    "type": {
184                      "type": "string",
185                      "description": "The type of trader."
186                    },
187                    "name": {
188                      "type": "string",
189                      "description": "The name of the trader."
190                    }
191                  }
192                }
193              },
194              "item_id": {
195                "type": "integer",
196                "description": "ID of the item"
197              },
198              "dimensions": {
199                "type": "object",
200                "description": "Dimensions of the item.",
201                "properties": {
202                  "item_length": {
203                    "type": "number",
204                    "description": "Length of the item in centimeters."
205                  },
206                  "item_width": {
207                    "type": "number",
208                    "description": "Width of the item in centimeters."
209                  },
210                  "item_height": {
211                    "type": "number",
212                    "description": "Height of the item in centimeters."
213                  },
214                  "item_weight": {
215                    "type": "number",
216                    "description": "Weight of the item in grams."
217                  },
218                  "item_weight_unit_of_measure": {
219                    "type": "string",
220                    "description": "Unit of measure for the item's weight (e.g., \"gram\")."
221                  },
222                  "item_dimensions_unit_of_measure": {
223                    "type": "string",
224                    "description": "Unit of measure for the item's dimensions (e.g., \"cm\")."
225                  }
226                }
227              },
228              "tax_identifier": {
229                "type": "object",
230                "description": "Tax identifier for the product.",
231                "properties": {
232                  "hsn_code_id": {
233                    "type": "string",
234                    "description": "The ID of the HSN code associated with the tax."
235                  }
236                }
237              },
238              "_custom_json": {
239                "type": "object",
240                "description": "Custom JSON data for the product ( can contain any key value pair )"
241              }
242            }
243          }
244        }
245      }
246    }
247  }
248}
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        "product": {
231          "slug": "samsung-galaxy-a14-5g-128-gb-6-gb-ram-light-green-mobile-phone-7514611"
232        }
233      }
234    ]
235  }
236}

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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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 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      "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": "array",
134              "items": {
135                "type": "object",
136                "required": [
137                  "address",
138                  "type",
139                  "name"
140                ],
141                "properties": {
142                  "address": {
143                    "type": "array",
144                    "items": {
145                      "type": "string"
146                    }
147                  },
148                  "type": {
149                    "type": "string",
150                    "description": "Type of trader (e.g., Manufacturer, Importer, Packer)"
151                  },
152                  "name": {
153                    "type": "string",
154                    "description": "Name of the trader"
155                  }
156                }
157              },
158              "description": "Trader associated with the product."
159            },
160            "description": {
161              "type": "string",
162              "description": "Description of the product."
163            },
164            "return_config": {
165              "type": "object",
166              "required": [
167                "returnable"
168              ],
169              "properties": {
170                "returnable": {
171                  "type": "boolean",
172                  "description": "Flag indicating if the product is returnable or not."
173                },
174                "time": {
175                  "type": "integer",
176                  "description": "The time within which the product can be returned, in the specified time unit."
177                },
178                "unit": {
179                  "type": "string",
180                  "description": "The unit of time used to measure the time within which the product can be returned."
181                }
182              },
183              "description": "Return policy information for the product."
184            },
185            "departments": {
186              "type": "array",
187              "items": {
188                "type": "integer",
189                "description": "Department IDs associated with the product"
190              },
191              "description": "List of department IDs associated with the product."
192            },
193            "product_publish": {
194              "type": "object",
195              "required": [
196                "product_online_date",
197                "is_set"
198              ],
199              "properties": {
200                "product_online_date": {
201                  "type": "string",
202                  "description": "Unix timestamp indicating the date and time when the product was published online."
203                },
204                "is_set": {
205                  "type": "boolean",
206                  "description": "Flag to indicate if the product is published online or not."
207                }
208              },
209              "description": "Information about the product publication status."
210            },
211            "is_dependent": {
212              "type": "boolean",
213              "description": "Flag to indicate if the product is dependent on other products or not."
214            },
215            "highlights": {
216              "type": "array",
217              "items": {
218                "type": "string"
219              },
220              "description": "A list of highlights or special features associated with the product."
221            },
222            "size_guide": {
223              "type": "string",
224              "description": "URL to the size guide for the product."
225            },
226            "no_of_boxes": {
227              "type": "integer",
228              "description": "Number of boxes containing the product."
229            },
230            "company_id": {
231              "type": "integer",
232              "description": "ID of the company associated with the product."
233            },
234            "category_slug": {
235              "type": "string",
236              "description": "Slug of the category associated with the product."
237            },
238            "media": {
239              "type": "array",
240              "items": {
241                "type": "object",
242                "properties": {
243                  "type": {
244                    "type": "string"
245                  },
246                  "url": {
247                    "type": "string"
248                  }
249                }
250              },
251              "description": "List of media information associated with the product."
252            },
253            "uid": {
254              "type": "integer",
255              "description": "The unique identifier of the product."
256            },
257            "template_tag": {
258              "type": "string",
259              "description": "The tag used for the product template."
260            },
261            "short_description": {
262              "type": "string",
263              "description": "A short description of the product, limited to 50 characters."
264            },
265            "category_uid": {
266              "type": "integer",
267              "description": "The unique identifier of the category that the product belongs to."
268            },
269            "item_code": {
270              "type": "string",
271              "description": "Item code for the product."
272            },
273            "multi_size": {
274              "type": "boolean",
275              "description": "Flag to indicate if the product has multiple sizes or not."
276            },
277            "is_set": {
278              "type": "boolean",
279              "description": "Flag to indicate if the product is a set or not."
280            },
281            "net_quantity": {
282              "type": "object",
283              "description": "A nested object representing the net quantity of the product."
284            },
285            "brand_uid": {
286              "type": "integer",
287              "description": "Unique ID of the brand associated with the product."
288            },
289            "is_active": {
290              "type": "boolean",
291              "description": "A boolean indicating whether the product is currently active or not."
292            },
293            "is_image_less_product": {
294              "type": "boolean",
295              "description": "Flag to indicate if the product has no image or not."
296            },
297            "attributes": {
298              "type": "object",
299              "description": "Attributes of the product."
300            },
301            "custom_order": {
302              "type": "object",
303              "required": [
304                "manufacturing_time_unit",
305                "is_custom_order",
306                "manufacturing_time"
307              ],
308              "properties": {
309                "manufacturing_time_unit": {
310                  "type": "string",
311                  "description": "The unit of time used to measure the time required to manufacture the product."
312                },
313                "is_custom_order": {
314                  "type": "boolean",
315                  "description": "Flag indicating if the product is a custom order or not."
316                },
317                "manufacturing_time": {
318                  "type": "integer",
319                  "description": "The time required to manufacture the product, in the specified time unit."
320                }
321              },
322              "description": "Custom order information for the product."
323            },
324            "tax_identifier": {
325              "type": "object",
326              "required": [
327                "hsn_code",
328                "hsn_code_id",
329                "reporting_hsn"
330              ],
331              "properties": {
332                "hsn_code": {
333                  "type": "string",
334                  "description": "The HSN (Harmonized System of Nomenclature) code associated with the product."
335                },
336                "hsn_code_id": {
337                  "type": "string",
338                  "description": "ID of the HSN code associated with the product."
339                },
340                "reporting_hsn": {
341                  "type": "string",
342                  "description": "Reporting HSN for the product."
343                }
344              },
345              "description": "Tax identifier for the product."
346            },
347            "country_of_origin": {
348              "type": "string",
349              "description": "Country of origin for the product."
350            },
351            "item_type": {
352              "type": "string",
353              "description": "Type of the product."
354            },
355            "_custom_json": {
356              "type": "object",
357              "description": "A dictionary of custom JSON data associated with the product."
358            }
359          },
360          "description": "Information about a product."
361        }
362      }
363    }
364  }
365}
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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 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      "type": "object",
68      "required": [
69        "product"
70      ],
71      "properties": {
72        "product": {
73          "type": "object",
74          "required": [
75            "name",
76            "return_config",
77            "is_dependent",
78            "no_of_boxes",
79            "company_id",
80            "uid",
81            "template_tag",
82            "category_uid",
83            "item_code",
84            "multi_size",
85            "is_set",
86            "brand_uid",
87            "is_active",
88            "is_image_less_product",
89            "custom_order",
90            "tax_identifier",
91            "country_of_origin",
92            "item_type",
93            "departments",
94            "slug"
95          ],
96          "properties": {
97            "currency": {
98              "type": "string",
99              "description": "Currency of the product."
100            },
101            "product_group_tag": {
102              "type": "array",
103              "description": "Tag associated with the product group.",
104              "items": {
105                "type": "string"
106              }
107            },
108            "name": {
109              "type": "string",
110              "description": "Name of the product."
111            },
112            "tags": {
113              "type": "array",
114              "description": "List of tags associated with the product.",
115              "items": {
116                "type": "string"
117              }
118            },
119            "slug": {
120              "type": "string",
121              "description": "Unique slug for the product."
122            },
123            "variant_media": {
124              "type": "object",
125              "description": "A dictionary of media files associated with each variant of the product."
126            },
127            "teaser_tag": {
128              "type": "object",
129              "description": "Teaser tag for the product."
130            },
131            "trader": {
132              "type": "array",
133              "items": {
134                "type": "object",
135                "required": [
136                  "address",
137                  "type",
138                  "name"
139                ],
140                "properties": {
141                  "address": {
142                    "type": "array",
143                    "items": {
144                      "type": "string"
145                    }
146                  },
147                  "type": {
148                    "type": "string",
149                    "description": "Type of trader (e.g., Manufacturer, Importer, Packer)"
150                  },
151                  "name": {
152                    "type": "string",
153                    "description": "Name of the trader"
154                  }
155                },
156                "description": "Details of traders associated with the product"
157              },
158              "description": "Trader associated with the product."
159            },
160            "description": {
161              "type": "string",
162              "description": "Description of the product."
163            },
164            "return_config": {
165              "type": "object",
166              "required": [
167                "returnable"
168              ],
169              "properties": {
170                "returnable": {
171                  "type": "boolean",
172                  "description": "Flag indicating if the product is returnable or not."
173                },
174                "time": {
175                  "type": "integer",
176                  "description": "The time within which the product can be returned, in the specified time unit."
177                },
178                "unit": {
179                  "type": "string",
180                  "description": "The unit of time used to measure the time within which the product can be returned."
181                }
182              },
183              "description": "Return policy information for the product."
184            },
185            "departments": {
186              "type": "array",
187              "items": {
188                "type": "integer",
189                "description": "Departments associated with the product"
190              },
191              "description": "List of department IDs associated with the product."
192            },
193            "product_publish": {
194              "type": "object",
195              "required": [
196                "product_online_date",
197                "is_set"
198              ],
199              "properties": {
200                "product_online_date": {
201                  "type": "string",
202                  "description": "Unix timestamp indicating the date and time when the product was published online."
203                },
204                "is_set": {
205                  "type": "boolean",
206                  "description": "Flag to indicate if the product is published online or not."
207                }
208              },
209              "description": "Information about the product publication status."
210            },
211            "is_dependent": {
212              "type": "boolean",
213              "description": "Flag to indicate if the product is dependent on other products or not."
214            },
215            "highlights": {
216              "type": "array",
217              "items": {
218                "type": "string",
219                "description": "Highlights or features of the product"
220              },
221              "description": "A list of highlights or special features associated with the product."
222            },
223            "size_guide": {
224              "type": "string",
225              "description": "URL to the size guide for the product."
226            },
227            "no_of_boxes": {
228              "type": "integer",
229              "description": "Number of boxes containing the product."
230            },
231            "company_id": {
232              "type": "integer",
233              "description": "ID of the company associated with the product."
234            },
235            "variants": {
236              "type": "object",
237              "description": "A dictionary of product variants, where the keys are variant names and the values are variant details."
238            },
239            "category_slug": {
240              "type": "string",
241              "description": "Slug of the category associated with the product."
242            },
243            "media": {
244              "type": "array",
245              "items": {
246                "type": "object",
247                "properties": {
248                  "type": {
249                    "type": "string"
250                  },
251                  "url": {
252                    "type": "string"
253                  }
254                },
255                "description": "Media URLs associated with the product"
256              },
257              "description": "List of media information associated with the product."
258            },
259            "uid": {
260              "type": "integer",
261              "description": "The unique identifier of the product."
262            },
263            "template_tag": {
264              "type": "string",
265              "description": "The tag used for the product template."
266            },
267            "short_description": {
268              "type": "string",
269              "description": "A short description of the product, limited to 50 characters."
270            },
271            "category_uid": {
272              "type": "integer",
273              "description": "The unique identifier of the category that the product belongs to."
274            },
275            "item_code": {
276              "type": "string",
277              "description": "Item code for the product."
278            },
279            "multi_size": {
280              "type": "boolean",
281              "description": "Flag to indicate if the product has multiple sizes or not."
282            },
283            "is_set": {
284              "type": "boolean",
285              "description": "Flag to indicate if the product is a set or not."
286            },
287            "net_quantity": {
288              "type": "object",
289              "description": "A nested object representing the net quantity of the product."
290            },
291            "brand_uid": {
292              "type": "integer",
293              "description": "Unique ID of the brand associated with the product."
294            },
295            "is_active": {
296              "type": "boolean",
297              "description": "A boolean indicating whether the product is currently active or not."
298            },
299            "is_image_less_product": {
300              "type": "boolean",
301              "description": "Flag to indicate if the product has no image or not."
302            },
303            "attributes": {
304              "type": "object",
305              "description": "Attributes of the product."
306            },
307            "custom_order": {
308              "type": "object",
309              "required": [
310                "manufacturing_time_unit",
311                "is_custom_order",
312                "manufacturing_time"
313              ],
314              "properties": {
315                "manufacturing_time_unit": {
316                  "type": "string",
317                  "description": "The unit of time used to measure the time required to manufacture the product."
318                },
319                "is_custom_order": {
320                  "type": "boolean",
321                  "description": "Flag indicating if the product is a custom order or not."
322                },
323                "manufacturing_time": {
324                  "type": "integer",
325                  "description": "The time required to manufacture the product, in the specified time unit."
326                }
327              },
328              "description": "Custom order information for the product."
329            },
330            "tax_identifier": {
331              "type": "object",
332              "required": [
333                "hsn_code",
334                "hsn_code_id",
335                "reporting_hsn"
336              ],
337              "properties": {
338                "hsn_code": {
339                  "type": "string",
340                  "description": "The HSN (Harmonized System of Nomenclature) code associated with the product."
341                },
342                "hsn_code_id": {
343                  "type": "string",
344                  "description": "ID of the HSN code associated with the product."
345                },
346                "reporting_hsn": {
347                  "type": "string",
348                  "description": "Reporting HSN for the product."
349                }
350              },
351              "description": "Tax identifier for the product."
352            },
353            "country_of_origin": {
354              "type": "string",
355              "description": "Country of origin for the product."
356            },
357            "item_type": {
358              "type": "string",
359              "description": "Type of the product."
360            },
361            "_custom_json": {
362              "type": "object",
363              "description": "A dictionary of custom JSON data associated with the product."
364            }
365          },
366          "description": "Information about a product."
367        }
368      }
369    }
370  }
371}
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Array of Properties
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                    "type": "object",
118                    "properties": {
119                      "display": {
120                        "type": "string",
121                        "description": "Display name of Attachment"
122                      },
123                      "type": {
124                        "type": "string",
125                        "description": "Type of attachment - image, shipment, file etc"
126                      },
127                      "value": {
128                        "type": "string",
129                        "description": "Attachment value. For image/file it'll be a url. For shipment it'll be a shipment ID"
130                      }
131                    }
132                  }
133                },
134                "description": {
135                  "type": "string",
136                  "description": "The detailed description of issue/escalation - Encoded in base64"
137                },
138                "items": {
139                  "type": "string"
140                }
141              }
142            },
143            "category": {
144              "type": "string",
145              "description": "The category or category hierarchy for which the ticket is raised, e.g. Catalogue, Collection, Product, Logistics, etc."
146            },
147            "sla": {
148              "type": "object",
149              "description": "Details regarding the resolution time of a ticket",
150              "properties": {
151                "resolution_time": {
152                  "type": "string",
153                  "description": "Timestamp by which the ticket will be resolved"
154                }
155              }
156            },
157            "created_at": {
158              "type": "string",
159              "description": "Ticket creation time"
160            },
161            "created_by": {
162              "type": "object",
163              "description": "Contains description of user who created the ticket",
164              "required": [
165                "_id"
166              ],
167              "properties": {
168                "_id": {
169                  "type": "string",
170                  "description": "Unique Identifier for an user - auto generated by system"
171                },
172                "last_name": {
173                  "type": "string",
174                  "description": "Last name of the user who created the ticket"
175                },
176                "first_name": {
177                  "type": "string",
178                  "description": "Last name of the user who created the ticket"
179                }
180              }
181            },
182            "updated_at": {
183              "type": "string",
184              "description": "Ticket last updation time"
185            }
186          }
187        }
188      }
189    }
190  }
191}
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Array of Properties
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                    "type": "object",
118                    "properties": {
119                      "display": {
120                        "type": "string",
121                        "description": "Display name of Attachment"
122                      },
123                      "type": {
124                        "type": "string",
125                        "description": "Type of attachment - image, shipment, file etc"
126                      },
127                      "value": {
128                        "type": "string",
129                        "description": "Attachment value. For image/file it'll be a url. For shipment it'll be a shipment ID"
130                      }
131                    }
132                  }
133                },
134                "description": {
135                  "type": "string",
136                  "description": "The detailed description of issue/escalation - Encoded in base64"
137                }
138              }
139            },
140            "category": {
141              "type": "string",
142              "description": "The category or category hierarchy for which the ticket is raised, e.g. Catalogue, Collection, Product, Logistics, etc."
143            },
144            "sla": {
145              "type": "object",
146              "description": "Details regarding the resolution time of a ticket",
147              "properties": {
148                "resolution_time": {
149                  "type": "string",
150                  "description": "Timestamp by which the ticket will be resolved"
151                }
152              }
153            },
154            "created_at": {
155              "type": "string",
156              "description": "Ticket creation time"
157            },
158            "created_by": {
159              "type": "object",
160              "description": "Contains description of user who created the ticket",
161              "required": [
162                "_id"
163              ],
164              "properties": {
165                "_id": {
166                  "type": "string",
167                  "description": "Unique Identifier for an user - auto generated by system"
168                },
169                "last_name": {
170                  "type": "string",
171                  "description": "Last name of the user who created the ticket"
172                },
173                "first_name": {
174                  "type": "string",
175                  "description": "Last name of the user who created the ticket"
176                }
177              }
178            },
179            "updated_at": {
180              "type": "string",
181              "description": "Ticket last updation time"
182            }
183          }
184        }
185      }
186    }
187  }
188}
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}

Theme

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

Events
company/theme/install/v1
# this event is triggered when theme is installed
company/theme/remove/v1
# this event is triggered when theme is removed

company/theme/install/v1

this event is triggered when theme is installed

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
theme
object
Required
Properties
_id
string
meta
object
name
string
Required
created_at
string
updated_at
string
company_id
integer
Required
marketplace_theme_id
string
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        "theme"
70      ],
71      "properties": {
72        "theme": {
73          "type": "object",
74          "required": [
75            "company_id",
76            "name"
77          ],
78          "properties": {
79            "_id": {
80              "type": "string"
81            },
82            "meta": {
83              "type": "object"
84            },
85            "name": {
86              "type": "string"
87            },
88            "created_at": {
89              "type": "string"
90            },
91            "updated_at": {
92              "type": "string"
93            },
94            "company_id": {
95              "type": "integer"
96            },
97            "marketplace_theme_id": {
98              "type": "string"
99            }
100          }
101        }
102      }
103    }
104  }
105}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "blitzkrieg.e750460f-8276-4d7b-81a9-40ece03a6e08"
5    ],
6    "name": "theme",
7    "type": "install",
8    "version": "1",
9    "created_timestamp": 1714205162849,
10    "id": "j36wh2v/3caqADzARdSOfFb59bxm6mOVwrNKBIW9dwQ=",
11    "category": "company",
12    "referer": "sit.fyndx1.de"
13  },
14  "company_id": 31352,
15  "contains": [
16    "theme"
17  ],
18  "payload": {
19    "theme": {
20      "name": "brunt-theme-zip-0.9sxmv2x35q",
21      "marketplace_theme_id": "65f968f8d6cd25b10fc215a4",
22      "company_id": 31352,
23      "meta": {
24        "description": "meytv",
25        "industry": [
26          "Arts and crafts",
27          "Baby and kids",
28          "Books, music, and video"
29        ],
30        "payment": {
31          "is_paid": false,
32          "amount": 0
33        },
34        "images": {
35          "desktop": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/test/general/free/original/sampleJPG.jpg",
36          "mobile": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/test/general/free/original/sampleJPG.jpg"
37        },
38        "slug": "brunt-theme-zip-0.9sxmv2x35q"
39      },
40      "_id": "662cb1ea0fefd6e05c4f1756",
41      "created_at": "2024-04-27T08:06:02.751Z",
42      "updated_at": "2024-04-27T08:06:02.751Z"
43    }
44  }
45}

company/theme/remove/v1

this event is triggered when theme is removed

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
theme
object
Required
Properties
_id
string
meta
object
name
string
Required
created_at
string
updated_at
string
company_id
integer
Required
marketplace_theme_id
string
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        "theme"
70      ],
71      "properties": {
72        "theme": {
73          "type": "object",
74          "required": [
75            "company_id",
76            "name"
77          ],
78          "properties": {
79            "_id": {
80              "type": "string"
81            },
82            "meta": {
83              "type": "object"
84            },
85            "name": {
86              "type": "string"
87            },
88            "created_at": {
89              "type": "string"
90            },
91            "updated_at": {
92              "type": "string"
93            },
94            "company_id": {
95              "type": "integer"
96            },
97            "marketplace_theme_id": {
98              "type": "string"
99            }
100          }
101        }
102      }
103    }
104  }
105}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "blitzkrieg.afeff47f-7180-4fe0-bafc-9ff3da653bc9"
5    ],
6    "name": "theme",
7    "type": "remove",
8    "version": "1",
9    "created_timestamp": 1714931209301,
10    "id": "mImcyHcQyPCaeA2BgdJ/IwxVxhXPFFwG3BpfVKDkUh4=",
11    "category": "company",
12    "referer": "sit.fyndx1.de"
13  },
14  "company_id": 31828,
15  "contains": [
16    "theme"
17  ],
18  "payload": {
19    "theme": {
20      "_id": "6637c5ef13b8bb735240ecc5",
21      "name": "brunt-theme-zip-0.km6yx2aho1",
22      "marketplace_theme_id": "6637c5fafa9d4b80b70f5743",
23      "company_id": 31828,
24      "meta": {
25        "payment": {
26          "is_paid": false,
27          "amount": 0
28        },
29        "description": "siuqu",
30        "industry": [
31          "Arts and crafts",
32          "Baby and kids",
33          "Books, music, and video"
34        ],
35        "images": {
36          "desktop": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/test/general/free/original/sampleJPG.jpg",
37          "mobile": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/test/general/free/original/sampleJPG.jpg"
38        },
39        "slug": "brunt-theme-zip-0.km6yx2aho1"
40      },
41      "created_at": "2024-05-05T17:46:23.698Z",
42      "updated_at": "2024-05-05T17:46:36.835Z"
43    }
44  }
45}

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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
« Change Log
Next
Address »