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

Application

Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.

Address

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

Events
application/address/create/v1
# this event is triggered when address is created
application/address/delete/v1
# this event is triggered when address is deleted
application/address/update/v1
# this event is triggered when address is updated

application/address/create/v1

this event is triggered when address is created

Payload
Properties
application_id
array|string
Required
Application/sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
address
object
Required
Properties
_id
string
Required
Unique identifier for the address mongo object.
uid
integer
Required
Unique identifier of the address object.
area
string
Building Name/ Street*.
city
string
Required
City name.
name
string
Required
Name of the user.
tags
array of string
Required
Value to add to identify a group of address.
email
null|string
Email id of user.
phone
integer
Required
Phone number of user.
state
string
Required
State name.
app_id
string
Required
Application id.
address
string
Required
Flat No/House No/Building No.
country
string
Required
Country name.
user_id
string
Required
User Id of the user.
landmark
string
Landmark.
area_code
string
Required
pincode or zipcode..
expire_at
null|string
Required
Expiry for address.
_custom_json
object
Required
Custom data for address/user.
address_type
string
This would represent the name of the address.
country_code
string
Required
Country code.
geo_location
object
Geographic location e.g. latitude/longitude.
Properties
latitude
number
Required
longitude
number
Required
checkout_mode
string
Required
Checkout type of user.
area_code_slug
string
Required
Slug for area code e.g. pincode or zipcode.
sector
string
Sector will represent the sector for that address.
state_code
string
Sector will represent the code for that state.
is_default_address
boolean
Required
Boolean for default address of user.
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "Application/sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "address"
78      ],
79      "properties": {
80        "address": {
81          "type": "object",
82          "required": [
83            "area_code_slug",
84            "country_code",
85            "name",
86            "tags",
87            "expire_at",
88            "address",
89            "phone",
90            "_custom_json",
91            "checkout_mode",
92            "app_id",
93            "uid",
94            "state",
95            "is_default_address",
96            "_id",
97            "city",
98            "country",
99            "user_id",
100            "area_code"
101          ],
102          "properties": {
103            "_id": {
104              "type": "string",
105              "description": "Unique identifier for the address mongo object."
106            },
107            "uid": {
108              "type": "integer",
109              "description": "Unique identifier of the address object."
110            },
111            "area": {
112              "type": "string",
113              "description": "Building Name/ Street*."
114            },
115            "city": {
116              "type": "string",
117              "description": "City name."
118            },
119            "name": {
120              "type": "string",
121              "description": "Name of the user."
122            },
123            "tags": {
124              "type": "array",
125              "description": "Value to add to identify a group of address.",
126              "items": {
127                "type": "string"
128              }
129            },
130            "email": {
131              "type": [
132                "null",
133                "string"
134              ],
135              "description": "Email id of user."
136            },
137            "phone": {
138              "type": "integer",
139              "description": "Phone number of user."
140            },
141            "state": {
142              "type": "string",
143              "description": "State name."
144            },
145            "app_id": {
146              "type": "string",
147              "description": "Application id."
148            },
149            "address": {
150              "type": "string",
151              "description": "Flat No/House No/Building No."
152            },
153            "country": {
154              "type": "string",
155              "description": "Country name."
156            },
157            "user_id": {
158              "type": "string",
159              "description": "User Id of the user."
160            },
161            "landmark": {
162              "type": "string",
163              "description": "Landmark."
164            },
165            "area_code": {
166              "type": "string",
167              "description": "pincode or zipcode.."
168            },
169            "expire_at": {
170              "type": [
171                "null",
172                "string"
173              ],
174              "description": "Expiry for address."
175            },
176            "_custom_json": {
177              "type": "object",
178              "description": "Custom data for address/user."
179            },
180            "address_type": {
181              "type": "string",
182              "description": "This would represent the name of the address."
183            },
184            "country_code": {
185              "type": "string",
186              "description": "Country code."
187            },
188            "geo_location": {
189              "type": "object",
190              "required": [
191                "latitude",
192                "longitude"
193              ],
194              "properties": {
195                "latitude": {
196                  "type": "number"
197                },
198                "longitude": {
199                  "type": "number"
200                }
201              },
202              "description": "Geographic location e.g. latitude/longitude."
203            },
204            "checkout_mode": {
205              "type": "string",
206              "description": "Checkout type of user."
207            },
208            "area_code_slug": {
209              "type": "string",
210              "description": "Slug for area code e.g. pincode or zipcode."
211            },
212            "sector": {
213              "type": "string",
214              "description": "Sector will represent the sector for that address."
215            },
216            "state_code": {
217              "type": "string",
218              "description": "Sector will represent the code for that state."
219            },
220            "is_default_address": {
221              "type": "boolean",
222              "description": "Boolean for default address of user."
223            }
224          }
225        }
226      }
227    }
228  }
229}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "megatron.c9828f42-f16f-467a-88ae-4cf0fa0afd84"
5    ],
6    "name": "address",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712210270722,
10    "id": "e9pQKO0id7YvJEwIba0Ji0la4tOr4FA4fJqzX8YZYCQ=",
11    "category": "application"
12  },
13  "company_id": 292,
14  "application_id": "628f081195f552f12185aab5",
15  "contains": [
16    "address"
17  ],
18  "payload": {
19    "address": {
20      "landmark": "dummy landmark ",
21      "tags": [],
22      "phone": 1111111111,
23      "area": "dummy area ",
24      "expire_at": null,
25      "area_code_slug": "pincode",
26      "_id": "660e415ef015dbfce2469b25",
27      "user_id": "63f5d19be6acf23c4f0f0529",
28      "address": "test test ",
29      "country": "India",
30      "uid": 5787855,
31      "app_id": "628f081195f552f12185aab5",
32      "area_code": "560047",
33      "is_default_address": true,
34      "state": "Karnataka",
35      "sector": "",
36      "city": "Bangalore",
37      "state_code": "",
38      "address_type": "home",
39      "_custom_json": {},
40      "name": "dummy",
41      "email": "test@example.com",
42      "checkout_mode": "other",
43      "country_code": "null"
44    }
45  }
46}

application/address/delete/v1

this event is triggered when address is deleted

Payload
Properties
application_id
array|string
Required
Application/sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
address
object
Required
Properties
_id
string
Required
Unique identifier for the address mongo object.
uid
integer
Required
Unique identifier of the address object.
area
string
Building Name/ Street*.
city
string
Required
City name.
name
string
Required
Name of the user.
tags
array of string
Required
Value to add to identify a group of address.
email
null|string
Email id of user.
phone
integer
Required
Phone number of user.
state
string
Required
State name.
app_id
string
Required
Application id.
address
string
Required
Flat No/House No/Building No.
country
string
Required
Country name.
user_id
string
Required
User Id of the user.
landmark
string
Landmark.
area_code
string
Required
pincode or zipcode..
expire_at
null|string
Required
Expiry for address.
_custom_json
object
Required
Custom data for address/user.
address_type
string
This would represent the name of the address.
country_code
string
Required
Country code.
geo_location
object
Geographic location e.g. latitude/longitude.
Properties
latitude
number
Required
longitude
number
Required
checkout_mode
string
Required
Checkout type of user.
area_code_slug
string
Required
Slug for area code e.g. pincode or zipcode.
sector
string
Sector will represent the sector for that address.
state_code
string
Sector will represent the code for that state.
is_default_address
boolean
Required
Boolean for default address of user.
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "Application/sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "address"
78      ],
79      "properties": {
80        "address": {
81          "type": "object",
82          "required": [
83            "area_code_slug",
84            "country_code",
85            "name",
86            "tags",
87            "expire_at",
88            "address",
89            "phone",
90            "_custom_json",
91            "checkout_mode",
92            "app_id",
93            "uid",
94            "state",
95            "is_default_address",
96            "_id",
97            "city",
98            "country",
99            "user_id",
100            "area_code"
101          ],
102          "properties": {
103            "_id": {
104              "type": "string",
105              "description": "Unique identifier for the address mongo object."
106            },
107            "uid": {
108              "type": "integer",
109              "description": "Unique identifier of the address object."
110            },
111            "area": {
112              "type": "string",
113              "description": "Building Name/ Street*."
114            },
115            "city": {
116              "type": "string",
117              "description": "City name."
118            },
119            "name": {
120              "type": "string",
121              "description": "Name of the user."
122            },
123            "tags": {
124              "type": "array",
125              "description": "Value to add to identify a group of address.",
126              "items": {
127                "type": "string"
128              }
129            },
130            "email": {
131              "type": [
132                "null",
133                "string"
134              ],
135              "description": "Email id of user."
136            },
137            "phone": {
138              "type": "integer",
139              "description": "Phone number of user."
140            },
141            "state": {
142              "type": "string",
143              "description": "State name."
144            },
145            "app_id": {
146              "type": "string",
147              "description": "Application id."
148            },
149            "address": {
150              "type": "string",
151              "description": "Flat No/House No/Building No."
152            },
153            "country": {
154              "type": "string",
155              "description": "Country name."
156            },
157            "user_id": {
158              "type": "string",
159              "description": "User Id of the user."
160            },
161            "landmark": {
162              "type": "string",
163              "description": "Landmark."
164            },
165            "area_code": {
166              "type": "string",
167              "description": "pincode or zipcode.."
168            },
169            "expire_at": {
170              "type": [
171                "null",
172                "string"
173              ],
174              "description": "Expiry for address."
175            },
176            "_custom_json": {
177              "type": "object",
178              "description": "Custom data for address/user."
179            },
180            "address_type": {
181              "type": "string",
182              "description": "This would represent the name of the address."
183            },
184            "country_code": {
185              "type": "string",
186              "description": "Country code."
187            },
188            "geo_location": {
189              "type": "object",
190              "required": [
191                "latitude",
192                "longitude"
193              ],
194              "properties": {
195                "latitude": {
196                  "type": "number"
197                },
198                "longitude": {
199                  "type": "number"
200                }
201              },
202              "description": "Geographic location e.g. latitude/longitude."
203            },
204            "checkout_mode": {
205              "type": "string",
206              "description": "Checkout type of user."
207            },
208            "area_code_slug": {
209              "type": "string",
210              "description": "Slug for area code e.g. pincode or zipcode."
211            },
212            "sector": {
213              "type": "string",
214              "description": "Sector will represent the sector for that address."
215            },
216            "state_code": {
217              "type": "string",
218              "description": "Sector will represent the code for that state."
219            },
220            "is_default_address": {
221              "type": "boolean",
222              "description": "Boolean for default address of user."
223            }
224          }
225        }
226      }
227    }
228  }
229}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "megatron.49245abb-5fcc-4134-bdd4-4a0daefd004a"
5    ],
6    "name": "address",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712162915740,
10    "id": "sVTG/vvln7WClX8S7+4me2swfV2K81OiS488Gk0B5qE=",
11    "category": "application"
12  },
13  "company_id": 5842,
14  "application_id": "6523fa5f41f4eb4c10a1d869",
15  "contains": [
16    "address"
17  ],
18  "payload": {
19    "address": {
20      "country": "India",
21      "area_code": "500008",
22      "state_code": "",
23      "state": "Telangana",
24      "address": "Dummy area",
25      "expire_at": null,
26      "country_code": "+91",
27      "tags": [],
28      "user_id": "65faabf928bb65b47f484c94",
29      "area": "Dummy address",
30      "city": "Hyderabad",
31      "checkout_mode": "self",
32      "name": "dummy user",
33      "uid": 5786605,
34      "app_id": "6523fa5f41f4eb4c10a1d869",
35      "landmark": "Dummy landmark",
36      "sector": "",
37      "area_code_slug": "pincode",
38      "geo_location": {
39        "latitude": 28.6667,
40        "longitude": 77.2167
41      },
42      "address_type": "Friend & Family",
43      "phone": 1111111111,
44      "_id": "660bd2a5905869cdd609af5e",
45      "is_default_address": false,
46      "_custom_json": {},
47      "email": "test@example.com"
48    }
49  }
50}

application/address/update/v1

this event is triggered when address is updated

Payload
Properties
application_id
array|string
Required
Application/sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
address
object
Required
Properties
_id
string
Required
Unique identifier for the address mongo object.
uid
integer
Required
Unique identifier of the address object.
area
string
Building Name/ Street.
city
string
Required
City name.
name
string
Required
Name of the user.
tags
array of string
Required
Value to add to identify a group of addresses.
email
null|string
Email id of the user, can be null.
phone
integer
Required
Phone number of the user.
state
string
Required
State name.
app_id
string
Required
Application id.
address
string
Required
Flat No/House No/Building No.
country
string
Required
Country name.
user_id
string
Required
User Id of the user.
landmark
string
Landmark.
area_code
string
Required
pincode or zipcode.
expire_at
null|string
Required
Expiry for the address, can be null.
_custom_json
object
Required
Custom data for the address/user.
address_type
string
This would represent the type of the address.
country_code
string
Required
Country code.
geo_location
object
Geographic location e.g., latitude/longitude.
Properties
latitude
number
Required
longitude
number
Required
checkout_mode
string
Required
Checkout type of the user.
area_code_slug
string
Required
Slug for area code e.g., pincode or zipcode.
sector
string
Sector will represent the sector for that address.
state_code
string
Sector will represent the code for that state.
is_default_address
boolean
Required
Boolean for default address of the user.
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "Application/sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "address"
78      ],
79      "properties": {
80        "address": {
81          "type": "object",
82          "required": [
83            "area_code_slug",
84            "country_code",
85            "name",
86            "tags",
87            "expire_at",
88            "address",
89            "phone",
90            "_custom_json",
91            "checkout_mode",
92            "app_id",
93            "uid",
94            "state",
95            "is_default_address",
96            "_id",
97            "city",
98            "country",
99            "user_id",
100            "area_code"
101          ],
102          "properties": {
103            "_id": {
104              "type": "string",
105              "description": "Unique identifier for the address mongo object."
106            },
107            "uid": {
108              "type": "integer",
109              "description": "Unique identifier of the address object."
110            },
111            "area": {
112              "type": "string",
113              "description": "Building Name/ Street."
114            },
115            "city": {
116              "type": "string",
117              "description": "City name."
118            },
119            "name": {
120              "type": "string",
121              "description": "Name of the user."
122            },
123            "tags": {
124              "type": "array",
125              "description": "Value to add to identify a group of addresses.",
126              "items": {
127                "type": "string"
128              }
129            },
130            "email": {
131              "type": [
132                "null",
133                "string"
134              ],
135              "description": "Email id of the user, can be null."
136            },
137            "phone": {
138              "type": "integer",
139              "description": "Phone number of the user."
140            },
141            "state": {
142              "type": "string",
143              "description": "State name."
144            },
145            "app_id": {
146              "type": "string",
147              "description": "Application id."
148            },
149            "address": {
150              "type": "string",
151              "description": "Flat No/House No/Building No."
152            },
153            "country": {
154              "type": "string",
155              "description": "Country name."
156            },
157            "user_id": {
158              "type": "string",
159              "description": "User Id of the user."
160            },
161            "landmark": {
162              "type": "string",
163              "description": "Landmark."
164            },
165            "area_code": {
166              "type": "string",
167              "description": "pincode or zipcode."
168            },
169            "expire_at": {
170              "type": [
171                "null",
172                "string"
173              ],
174              "description": "Expiry for the address, can be null."
175            },
176            "_custom_json": {
177              "type": "object",
178              "description": "Custom data for the address/user."
179            },
180            "address_type": {
181              "type": "string",
182              "description": "This would represent the type of the address."
183            },
184            "country_code": {
185              "type": "string",
186              "description": "Country code."
187            },
188            "geo_location": {
189              "type": "object",
190              "required": [
191                "latitude",
192                "longitude"
193              ],
194              "properties": {
195                "latitude": {
196                  "type": "number"
197                },
198                "longitude": {
199                  "type": "number"
200                }
201              },
202              "description": "Geographic location e.g., latitude/longitude."
203            },
204            "checkout_mode": {
205              "type": "string",
206              "description": "Checkout type of the user."
207            },
208            "area_code_slug": {
209              "type": "string",
210              "description": "Slug for area code e.g., pincode or zipcode."
211            },
212            "sector": {
213              "type": "string",
214              "description": "Sector will represent the sector for that address."
215            },
216            "state_code": {
217              "type": "string",
218              "description": "Sector will represent the code for that state."
219            },
220            "is_default_address": {
221              "type": "boolean",
222              "description": "Boolean for default address of the user."
223            }
224          }
225        }
226      }
227    }
228  }
229}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "megatron.0d2300ad-00f5-493c-bfdd-a350ffc05f49"
5    ],
6    "name": "address",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712210110937,
10    "id": "VMh6ikastS4S6dvuRefSRImoOEzGe87jFgQXyHAzKv4=",
11    "category": "application"
12  },
13  "company_id": 61,
14  "application_id": "64f038190f62808b5a922f16",
15  "contains": [
16    "address"
17  ],
18  "payload": {
19    "address": {
20      "phone": 1111111111,
21      "uid": 5717753,
22      "tags": [],
23      "country_code": "+91",
24      "user_id": "65a66d01c48e8f9870441d7d",
25      "city": "Mumbai",
26      "country": "India",
27      "app_id": "64f038190f62808b5a922f16",
28      "checkout_mode": "self",
29      "_custom_json": {},
30      "_id": "65a66d014310788f24728a5e",
31      "state_code": "",
32      "state": "Maharashtra",
33      "area": "Dummy areas",
34      "is_default_address": true,
35      "area_code": "400078",
36      "name": "test user",
37      "expire_at": null,
38      "area_code_slug": "pincode",
39      "sector": "",
40      "email": "test@example.com",
41      "landmark": "Tesy",
42      "address": "501"
43    }
44  }
45}

Article

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

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

application/article/create/v1

this event is triggered when article is created

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

application/article/delete/v1

this event is triggered when article is deleted

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

application/article/update/v1

this event is triggered when article is updated

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

Available pages

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

Events
application/available_pages/create/v1
# this event is triggered when available_pages is created
application/available_pages/delete/v1
# this event is triggered when available_pages is deleted
application/available_pages/update/v1
# this event is triggered when available_pages is updated

application/available_pages/create/v1

this event is triggered when available_pages is created

Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
theme object containing various parameters
Properties
__v
integer
_id
string
Required
Unique Identifier of the section page
seo
object
Required
Title and description used for Search Engine Optimization
Properties
title
string
Required
description
string
Required
path
string
Required
Path where the page will be loaded
text
string
Required
Name given to the page
type
string
Required
Type of page, e.g. sections
props
array of object
Required
Page-level configuration details
Array of Properties
default
boolean|string|object|number|null|array
Value for default value of prop.
id
string
string that represents the ID of the schema
label
string
title of label
type
string
type of UI component(like textbox,checkbox)
theme
string
Required
ID of the theme within which the section page exists
value
string
Required
URL-friendly identifier given to the page
sections
array of Undefined Type
Required
Details of all the sections included in the page
sections_meta
array of Undefined Type
Required
application
string
Required
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "theme"
78      ],
79      "properties": {
80        "theme": {
81          "type": "object",
82          "description": "theme object containing various parameters",
83          "required": [
84            "path",
85            "type",
86            "seo",
87            "props",
88            "_id",
89            "value",
90            "text",
91            "sections",
92            "sections_meta",
93            "theme",
94            "application"
95          ],
96          "properties": {
97            "__v": {
98              "type": "integer"
99            },
100            "_id": {
101              "type": "string",
102              "description": "Unique Identifier of the section page"
103            },
104            "seo": {
105              "type": "object",
106              "description": "Title and description used for Search Engine Optimization",
107              "required": [
108                "title",
109                "description"
110              ],
111              "properties": {
112                "title": {
113                  "type": "string"
114                },
115                "description": {
116                  "type": "string"
117                }
118              }
119            },
120            "path": {
121              "type": "string",
122              "description": "Path where the page will be loaded"
123            },
124            "text": {
125              "type": "string",
126              "description": "Name given to the page"
127            },
128            "type": {
129              "type": "string",
130              "description": "Type of page, e.g. sections"
131            },
132            "props": {
133              "type": "array",
134              "description": "Page-level configuration details",
135              "items": {
136                "type": "object",
137                "properties": {
138                  "default": {
139                    "type": [
140                      "boolean",
141                      "string",
142                      "object",
143                      "number",
144                      "null",
145                      "array"
146                    ],
147                    "description": "Value for default value of prop."
148                  },
149                  "id": {
150                    "type": "string",
151                    "description": "string that represents the ID of the schema"
152                  },
153                  "label": {
154                    "type": "string",
155                    "description": "title of label"
156                  },
157                  "type": {
158                    "type": "string",
159                    "description": "type of UI component(like textbox,checkbox)"
160                  }
161                }
162              }
163            },
164            "theme": {
165              "type": "string",
166              "description": "ID of the theme within which the section page exists"
167            },
168            "value": {
169              "type": "string",
170              "description": "URL-friendly identifier given to the page"
171            },
172            "sections": {
173              "type": "array",
174              "description": "Details of all the sections included in the page",
175              "items": {}
176            },
177            "sections_meta": {
178              "type": "array",
179              "items": {}
180            },
181            "application": {
182              "type": "string"
183            }
184          }
185        }
186      }
187    }
188  }
189}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "blitzkrieg.12a01877-79fe-4b90-a91d-2cf1e78a8d43"
5    ],
6    "name": "available_pages",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711611409937,
10    "id": "5KksEFTHinLQhRYVhP6/sDdtj3jqf5wE6bSiA85VMKs=",
11    "category": "application"
12  },
13  "company_id": 4835,
14  "application_id": "646f16ecacf6d0900a166cc6",
15  "contains": [
16    "theme"
17  ],
18  "payload": {
19    "theme": {
20      "value": "c:::ugadi-contest",
21      "text": "Ugadi Contest",
22      "path": "c/ugadi-contest",
23      "type": "custom",
24      "sections": [],
25      "sections_meta": [],
26      "theme": "647032235be8e32873528087",
27      "seo": {
28        "title": "",
29        "description": "",
30        "sitemap": {
31          "priority": 0.5,
32          "frequency": "never"
33        },
34        "canonical_url": "",
35        "breadcrumbs": [],
36        "meta_tags": []
37      },
38      "props": [
39        {
40          "default": true,
41          "id": "header",
42          "label": "Header",
43          "type": "checkbox"
44        }
45      ],
46      "_id": "66051e11247a7df59105c4d2",
47      "created_at": "2024-03-28T07:36:49.925Z",
48      "updated_at": "2024-03-28T07:36:49.925Z",
49      "__v": 0,
50      "application": "646f16ecacf6d0900a166cc6",
51      "cli_version": "5.0.2"
52    }
53  }
54}

application/available_pages/delete/v1

this event is triggered when available_pages is deleted

Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
__v
integer
Version number
_id
string
Required
Unique Identifier of the section page
seo
object
Required
SEO details
Properties
title
string
Required
Title used for Search Engine Optimization
description
string
Required
Description used for Search Engine Optimization
path
string
Required
Path where the page will be loaded
text
string
Required
Name given to the page
type
string
Required
Type of page, e.g. sections
props
array of object
Required
Page-level configuration details
Array of Properties
default
boolean|string|object|number|null|array
Value for default value of prop.
id
string
string that represents the ID of the schema
label
string
title of label
type
string
type of UI component(like textbox,checkbox)
theme
string
Required
ID of the theme within which the section page exists
value
string
Required
URL-friendly identifier given to the page
sections
array of Undefined Type
Required
Details of all the sections included in the page
sections_meta
array of Undefined Type
Required
Metadata for the sections
application
string
Required
Application name
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "theme"
78      ],
79      "properties": {
80        "theme": {
81          "type": "object",
82          "required": [
83            "path",
84            "type",
85            "seo",
86            "props",
87            "_id",
88            "value",
89            "text",
90            "sections",
91            "sections_meta",
92            "theme",
93            "application"
94          ],
95          "properties": {
96            "__v": {
97              "type": "integer",
98              "description": "Version number"
99            },
100            "_id": {
101              "type": "string",
102              "description": "Unique Identifier of the section page"
103            },
104            "seo": {
105              "type": "object",
106              "required": [
107                "title",
108                "description"
109              ],
110              "properties": {
111                "title": {
112                  "type": "string",
113                  "description": "Title used for Search Engine Optimization"
114                },
115                "description": {
116                  "type": "string",
117                  "description": "Description used for Search Engine Optimization"
118                }
119              },
120              "description": "SEO details"
121            },
122            "path": {
123              "type": "string",
124              "description": "Path where the page will be loaded"
125            },
126            "text": {
127              "type": "string",
128              "description": "Name given to the page"
129            },
130            "type": {
131              "type": "string",
132              "description": "Type of page, e.g. sections"
133            },
134            "props": {
135              "type": "array",
136              "items": {
137                "type": "object",
138                "properties": {
139                  "default": {
140                    "type": [
141                      "boolean",
142                      "string",
143                      "object",
144                      "number",
145                      "null",
146                      "array"
147                    ],
148                    "description": "Value for default value of prop."
149                  },
150                  "id": {
151                    "type": "string",
152                    "description": "string that represents the ID of the schema"
153                  },
154                  "label": {
155                    "type": "string",
156                    "description": "title of label"
157                  },
158                  "type": {
159                    "type": "string",
160                    "description": "type of UI component(like textbox,checkbox)"
161                  }
162                }
163              },
164              "description": "Page-level configuration details"
165            },
166            "theme": {
167              "type": "string",
168              "description": "ID of the theme within which the section page exists"
169            },
170            "value": {
171              "type": "string",
172              "description": "URL-friendly identifier given to the page"
173            },
174            "sections": {
175              "type": "array",
176              "items": {},
177              "description": "Details of all the sections included in the page"
178            },
179            "sections_meta": {
180              "type": "array",
181              "items": {},
182              "description": "Metadata for the sections"
183            },
184            "application": {
185              "type": "string",
186              "description": "Application name"
187            }
188          }
189        }
190      }
191    }
192  }
193}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "blitzkrieg.6f55b163-69b3-4d9b-a813-084df4b69a6a"
5    ],
6    "name": "available_pages",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1711701676466,
10    "id": "jhIEK0IZ4F/m3U9P8w1n3fT6uC5OK7XmyyQdf+pjP1o=",
11    "category": "application"
12  },
13  "company_id": 4835,
14  "application_id": "646f16ecacf6d0900a166cc6",
15  "contains": [
16    "theme"
17  ],
18  "payload": {
19    "theme": {
20      "_id": "65a12e9670e4da2ebf5f36ef",
21      "path": "c/republic-day-contest",
22      "type": "custom",
23      "seo": {
24        "sitemap": {
25          "priority": 0.5,
26          "frequency": "never"
27        },
28        "title": "",
29        "description": "",
30        "breadcrumbs": [],
31        "meta_tags": [],
32        "canonical_url": ""
33      },
34      "props": [
35        {
36          "default": true,
37          "id": "header",
38          "label": "Header",
39          "type": "checkbox"
40        }
41      ],
42      "value": "c:::republic-day-contest",
43      "text": "Republic Day Contest",
44      "sections": [],
45      "sections_meta": [],
46      "theme": "647032235be8e32873528087",
47      "created_at": "2024-01-12T12:20:38.973Z",
48      "updated_at": "2024-03-28T13:27:30.651Z",
49      "__v": 19,
50      "application": "646f16ecacf6d0900a166cc6",
51      "cli_version": "5.0.2"
52    }
53  }
54}

application/available_pages/update/v1

this event is triggered when available_pages is updated

Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
__v
integer
Version number
_id
string
Required
Unique Identifier of the theme
seo
object
Required
SEO details
Properties
title
string
Required
Title used for Search Engine Optimization
description
string
Required
Description used for Search Engine Optimization
path
string
Required
Path where the theme is located
text
string
Required
Name given to the theme
type
string
Required
Type of theme
props
array of object
Required
Theme-level configuration details
Array of Properties
default
boolean|string|object|number|null|array
Value for default value of prop.
id
string
string that represents the ID of the schema
label
string
title of label
type
string
type of UI component(like textbox,checkbox)
theme
string
Required
Theme ID
value
string
Required
URL-friendly identifier given to the theme
sections
array of Undefined Type
Required
Details of all sections included in the theme
sections_meta
array of Undefined Type
Required
Metadata for the sections
application
string
Required
Application name
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "theme"
78      ],
79      "properties": {
80        "theme": {
81          "type": "object",
82          "required": [
83            "path",
84            "type",
85            "seo",
86            "props",
87            "_id",
88            "value",
89            "text",
90            "sections",
91            "sections_meta",
92            "theme",
93            "application"
94          ],
95          "properties": {
96            "__v": {
97              "type": "integer",
98              "description": "Version number"
99            },
100            "_id": {
101              "type": "string",
102              "description": "Unique Identifier of the theme"
103            },
104            "seo": {
105              "type": "object",
106              "required": [
107                "title",
108                "description"
109              ],
110              "properties": {
111                "title": {
112                  "type": "string",
113                  "description": "Title used for Search Engine Optimization"
114                },
115                "description": {
116                  "type": "string",
117                  "description": "Description used for Search Engine Optimization"
118                }
119              },
120              "description": "SEO details"
121            },
122            "path": {
123              "type": "string",
124              "description": "Path where the theme is located"
125            },
126            "text": {
127              "type": "string",
128              "description": "Name given to the theme"
129            },
130            "type": {
131              "type": "string",
132              "description": "Type of theme"
133            },
134            "props": {
135              "type": "array",
136              "items": {
137                "type": "object",
138                "properties": {
139                  "default": {
140                    "type": [
141                      "boolean",
142                      "string",
143                      "object",
144                      "number",
145                      "null",
146                      "array"
147                    ],
148                    "description": "Value for default value of prop."
149                  },
150                  "id": {
151                    "type": "string",
152                    "description": "string that represents the ID of the schema"
153                  },
154                  "label": {
155                    "type": "string",
156                    "description": "title of label"
157                  },
158                  "type": {
159                    "type": "string",
160                    "description": "type of UI component(like textbox,checkbox)"
161                  }
162                }
163              },
164              "description": "Theme-level configuration details"
165            },
166            "theme": {
167              "type": "string",
168              "description": "Theme ID"
169            },
170            "value": {
171              "type": "string",
172              "description": "URL-friendly identifier given to the theme"
173            },
174            "sections": {
175              "type": "array",
176              "items": {},
177              "description": "Details of all sections included in the theme"
178            },
179            "sections_meta": {
180              "type": "array",
181              "items": {},
182              "description": "Metadata for the sections"
183            },
184            "application": {
185              "type": "string",
186              "description": "Application name"
187            }
188          }
189        }
190      }
191    }
192  }
193}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "blitzkrieg.c651defb-1349-459e-b866-ff1c786e0ac3"
5    ],
6    "name": "available_pages",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711611291092,
10    "id": "v/Vjp4mUS26IZ47rP4GM9mcwHsIHTfYj/9Z453fgJUk=",
11    "category": "application"
12  },
13  "company_id": 4835,
14  "application_id": "646f16ecacf6d0900a166cc6",
15  "contains": [
16    "theme"
17  ],
18  "payload": {
19    "theme": {
20      "_id": "647032265be8e306235280bc",
21      "path": "order-tracking/:orderId",
22      "type": "system",
23      "seo": {
24        "sitemap": {
25          "frequency": "never",
26          "priority": 0.5
27        },
28        "title": "",
29        "description": "",
30        "breadcrumbs": [],
31        "canonical_url": "",
32        "meta_tags": []
33      },
34      "props": [
35        {
36          "default": true,
37          "id": "header",
38          "label": "Header",
39          "type": "checkbox"
40        }
41      ],
42      "value": "order-tracking-details",
43      "sections": [],
44      "sections_meta": [],
45      "text": "Order Tracking Details",
46      "created_at": "2022-07-19T04:36:14.244Z",
47      "updated_at": "2024-03-28T07:34:50.985Z",
48      "theme": "647032235be8e32873528087",
49      "__v": 47,
50      "application": "646f16ecacf6d0900a166cc6",
51      "cli_version": "5.0.2"
52    }
53  }
54}

Cart price adjustment

This event will be generated where there is any action done on cart-price-adjustment

Events
application/cart-price-adjustment/create/v1
# this event is triggered when cart-price-adjustment is created
application/cart-price-adjustment/remove/v1
# this event is triggered when cart-price-adjustment is removed
application/cart-price-adjustment/update/v1
# this event is triggered when cart-price-adjustment is updated

application/cart-price-adjustment/create/v1

this event is triggered when cart-price-adjustment is created

Payload
Properties
application_id
array|string
Required
Application/sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
This contains event data like name and type of event.
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
The payload data of event.
Properties
article_level_distribution
boolean
Required
Whether the distribution is done at the article level or not.
cart_value
number
The total value of the cart to which the adjustments are applied.
cart_id
string
Required
The identifier of the cart on which the price adjustment is applied.
id
string
Required
Unique identifier for the price adjustment.
is_authenticated
boolean
Required
Indicates whether the cart user is logged in or not.
article_ids
array of object
Required
Defines the list of articles you want to apply the injection to.
Array of Properties
article_id
string
Unique identifier for the article.
code
string
Code to identify price adjustment on article.
type
string
Type of price adjustment for the article. Valid options are: - 'discount': discount applied to the article price as promotion. - 'mop': additional mode of payment for article. - 'selling_price': additional discount in selling price of an article. - 'delivery_charge': delivery charge for an article to be added.
value
number
| float
Value of price adjustment for article.
meta
object
Additional metadata for the article. It could be any key value object.
allowed_refund
boolean
Indicates if a refund is allowed at article level.
collection
object
Required
Details about the collection and refund process.
Properties
collected_by
string
Required
Who is collecting the amount.
refund_by
string
Required
Specifies who is responsible for processing refunds.
value
number
Required
The value of the adjustment applied.
message
string
Required
Message detailing the reason for the adjustment.
type
string
Required
Defines the type of adjustment (charge, discount, mop).
is_active
boolean
Indicates if the adjustment is currently active.
meta
object
Additional metadata for the adjustment.
allowed_refund
boolean
Indicates if a refund is allowed at cart level.
auto_remove
boolean
When set true then it will remove mop type price adjustment when cart value changed compared to provided in price adjustment.
created_by
string
Unique Identifier of the creator.
Payload Schema JSON
1{
2  "type": "object",
3  "description": "This event is triggered when cart price adjustment is created",
4  "required": [
5    "company_id",
6    "contains",
7    "event",
8    "payload",
9    "application_id"
10  ],
11  "properties": {
12    "application_id": {
13      "type": [
14        "array",
15        "string"
16      ],
17      "description": "Application/sales channel ID for which this event is triggered"
18    },
19    "company_id": {
20      "type": "integer",
21      "description": "company ID for which this event is triggered"
22    },
23    "contains": {
24      "type": "array",
25      "description": "This array will have all the keys present at root level of 'payload' object",
26      "items": {
27        "type": "string"
28      }
29    },
30    "event": {
31      "type": "object",
32      "description": "This contains event data like name and type of event.",
33      "required": [
34        "category",
35        "created_timestamp",
36        "id",
37        "name",
38        "trace_id",
39        "type",
40        "version"
41      ],
42      "properties": {
43        "category": {
44          "type": "string",
45          "description": "category of the event. If it is at sales channel level or company level"
46        },
47        "created_timestamp": {
48          "type": "integer",
49          "description": "event generation timestamp in epoch milliseconds"
50        },
51        "id": {
52          "type": "string",
53          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
54        },
55        "name": {
56          "type": "string",
57          "description": "Name of the event"
58        },
59        "trace_id": {
60          "type": "array",
61          "description": "internal trace_id for Fynd Platform services",
62          "items": {
63            "type": "string"
64          }
65        },
66        "type": {
67          "type": "string",
68          "description": "Type/Action of the event. e.g. create/update/delete"
69        },
70        "version": {
71          "type": "string",
72          "description": "Version of the event."
73        }
74      }
75    },
76    "payload": {
77      "type": "object",
78      "description": "The payload data of event.",
79      "required": [
80        "article_ids",
81        "article_level_distribution",
82        "cart_id",
83        "collection",
84        "id",
85        "is_authenticated",
86        "message",
87        "type",
88        "value"
89      ],
90      "properties": {
91        "article_level_distribution": {
92          "type": "boolean",
93          "description": "Whether the distribution is done at the article level or not."
94        },
95        "cart_value": {
96          "type": "number",
97          "description": "The total value of the cart to which the adjustments are applied."
98        },
99        "cart_id": {
100          "type": "string",
101          "description": "The identifier of the cart on which the price adjustment is applied."
102        },
103        "id": {
104          "type": "string",
105          "description": "Unique identifier for the price adjustment."
106        },
107        "is_authenticated": {
108          "type": "boolean",
109          "description": "Indicates whether the cart user is logged in or not."
110        },
111        "article_ids": {
112          "type": "array",
113          "description": "Defines the list of articles you want to apply the injection to.",
114          "items": {
115            "type": "object",
116            "description": "Contains article vise data like id, code and type.",
117            "properties": {
118              "article_id": {
119                "type": "string",
120                "description": "Unique identifier for the article."
121              },
122              "code": {
123                "type": "string",
124                "description": "Code to identify price adjustment on article."
125              },
126              "type": {
127                "type": "string",
128                "description": "Type of price adjustment for the article. Valid options are: - 'discount': discount applied to the article price as promotion. - 'mop': additional mode of payment for article. - 'selling_price': additional discount in selling price of an article. - 'delivery_charge': delivery charge for an article to be added."
129              },
130              "value": {
131                "type": "number",
132                "format": "float",
133                "description": "Value of price adjustment for article."
134              },
135              "meta": {
136                "type": "object",
137                "description": "Additional metadata for the article. It could be any key value object."
138              },
139              "allowed_refund": {
140                "type": "boolean",
141                "description": "Indicates if a refund is allowed at article level."
142              }
143            }
144          }
145        },
146        "collection": {
147          "type": "object",
148          "required": [
149            "collected_by",
150            "refund_by"
151          ],
152          "properties": {
153            "collected_by": {
154              "type": "string",
155              "description": "Who is collecting the amount."
156            },
157            "refund_by": {
158              "type": "string",
159              "description": "Specifies who is responsible for processing refunds."
160            }
161          },
162          "description": "Details about the collection and refund process."
163        },
164        "value": {
165          "type": "number",
166          "description": "The value of the adjustment applied."
167        },
168        "message": {
169          "type": "string",
170          "description": "Message detailing the reason for the adjustment."
171        },
172        "type": {
173          "type": "string",
174          "description": "Defines the type of adjustment (charge, discount, mop)."
175        },
176        "is_active": {
177          "type": "boolean",
178          "description": "Indicates if the adjustment is currently active."
179        },
180        "meta": {
181          "type": "object",
182          "description": "Additional metadata for the adjustment."
183        },
184        "allowed_refund": {
185          "type": "boolean",
186          "description": "Indicates if a refund is allowed at cart level."
187        },
188        "auto_remove": {
189          "type": "boolean",
190          "description": "When set true then it will remove mop type price adjustment when cart value changed compared to provided in price adjustment."
191        },
192        "created_by": {
193          "type": "string",
194          "description": "Unique Identifier of the creator."
195        }
196      }
197    }
198  }
199}
Payload Example
1{
2  "application_id": "5e048673acefbaf1e8487564",
3  "company_id": 61,
4  "contains": [
5    "article_level_distribution",
6    "type",
7    "cart_id",
8    "value",
9    "article_ids",
10    "message",
11    "id",
12    "collection",
13    "created_by",
14    "is_authenticated"
15  ],
16  "event": {
17    "category": "application",
18    "created_timestamp": 1709923681057,
19    "id": "38fCmbF/KKdYVhSZv7YVQ2vI2HgEzWKIAmfGxcyAxD4=",
20    "name": "cart-price-adjustment",
21    "trace_id": [
22      "megatron.7d6d8569-5855-4e3f-983f-1661a086031b"
23    ],
24    "type": "create",
25    "version": "1"
26  },
27  "payload": {
28    "article_ids": [
29      {
30        "article_id": "65c22508d48efa43534b2ff0",
31        "type": "discount",
32        "value": 119.98
33      }
34    ],
35    "article_level_distribution": true,
36    "cart_id": "65eb5d60653540da999a93c8",
37    "collection": {
38      "collected_by": "SELLER",
39      "refund_by": "SELLER"
40    },
41    "created_by": "f87848737e0b7b55b4295eef",
42    "id": "65eb5d613877309818f3b25e",
43    "is_authenticated": true,
44    "message": "Subscription Discount",
45    "type": "mop",
46    "value": 119.98
47  }
48}

application/cart-price-adjustment/remove/v1

this event is triggered when cart-price-adjustment is removed

Payload
Properties
application_id
array|string
Required
Application/sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
This contains event data like name and type of event.
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
The payload data of event.
Properties
id
string
Required
The unique identifier for the price adjustment, serving as a primary key.
Payload Schema JSON
1{
2  "type": "object",
3  "description": "This event is triggered when cart price adjustment is removed",
4  "required": [
5    "company_id",
6    "contains",
7    "event",
8    "payload",
9    "application_id"
10  ],
11  "properties": {
12    "application_id": {
13      "type": [
14        "array",
15        "string"
16      ],
17      "description": "Application/sales channel ID for which this event is triggered"
18    },
19    "company_id": {
20      "type": "integer",
21      "description": "company ID for which this event is triggered"
22    },
23    "contains": {
24      "type": "array",
25      "description": "This array will have all the keys present at root level of 'payload' object",
26      "items": {
27        "type": "string"
28      }
29    },
30    "event": {
31      "type": "object",
32      "description": "This contains event data like name and type of event.",
33      "required": [
34        "category",
35        "created_timestamp",
36        "id",
37        "name",
38        "trace_id",
39        "type",
40        "version"
41      ],
42      "properties": {
43        "category": {
44          "type": "string",
45          "description": "category of the event. If it is at sales channel level or company level"
46        },
47        "created_timestamp": {
48          "type": "integer",
49          "description": "event generation timestamp in epoch milliseconds"
50        },
51        "id": {
52          "type": "string",
53          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
54        },
55        "name": {
56          "type": "string",
57          "description": "Name of the event"
58        },
59        "trace_id": {
60          "type": "array",
61          "description": "internal trace_id for Fynd Platform services",
62          "items": {
63            "type": "string"
64          }
65        },
66        "type": {
67          "type": "string",
68          "description": "Type/Action of the event. e.g. create/update/delete"
69        },
70        "version": {
71          "type": "string",
72          "description": "Version of the event."
73        }
74      }
75    },
76    "payload": {
77      "type": "object",
78      "description": "The payload data of event.",
79      "required": [
80        "id"
81      ],
82      "properties": {
83        "id": {
84          "type": "string",
85          "description": "The unique identifier for the price adjustment, serving as a primary key."
86        }
87      }
88    }
89  }
90}
Payload Example
1{
2  "payload": {
3    "cart_id": "644630845625add991225b47",
4    "is_authenticated": true,
5    "article_level_distribution": true,
6    "message": "DMS CART",
7    "value": 5,
8    "collection": {
9      "collected_by": "FYND",
10      "refund_by": "FYND"
11    },
12    "meta": {},
13    "apply_expiry": "2023-06-26-12:34:00",
14    "article_ids": [
15      {
16        "code": "",
17        "article_id": "647ef550a3bba8e197b81c7d",
18        "value": 5,
19        "meta": {},
20        "type": "discount"
21      }
22    ],
23    "type": "discount",
24    "is_active": true,
25    "id": "6499383154769c889deefd28",
26    "cart_value": 100
27  },
28  "contains": [],
29  "event": {
30    "id": "testID",
31    "name": "cart-price-adjustment",
32    "type": "update",
33    "version": "1",
34    "trace_id": [
35      "6730d511bfe14cb0822f872bcf02f21e"
36    ],
37    "created_timestamp": 1686263989,
38    "category": "application"
39  },
40  "company_id": 873,
41  "application_id": "000000000000000000000001"
42}

application/cart-price-adjustment/update/v1

this event is triggered when cart-price-adjustment is updated

Payload
Properties
application_id
array|string
Required
Application/sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
This contains event data like name and type of event.
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
The payload data of event.
Properties
id
string
Required
The unique identifier for the price adjustment.
meta
object
Additional information you want to pass on article level or cart level.
type
string
Required
Defines the injection type used for charge, discount, or MOP (Mode of Payment).
value
number
Required
The amount applied on the cart.
cart_id
string
Required
The cart ID on which the price adjustment is applied.
message
string
Required
The message to show the text or detail regarding the discount, charge, or MOP, etc.
is_active
boolean
Defines if the injection is active or not.
cart_value
number
Required
Defines the amount of the cart.
collection
object
Required
Defines the amount collection details.
Properties
refund_by
string
Required
Defines who will refund the amount in case of order cancellation/return if allowed_refund is True.
collected_by
string
Required
Defines who is collecting the amount.
article_ids
array of object
Required
Defines the list of articles you want to apply the injection to.
Array of Properties
article_id
string
Unique identifier for the article.
code
string
Code to identify price adjustment on article.
type
string
Type of price adjustment for the article. Valid options are: - 'discount': discount applied to the article price as promotion. - 'mop': additional mode of payment for article. - 'selling_price': additional discount in selling price of an article. - 'delivery_charge': delivery charge for an article to be added.
value
number
| float
Value of price adjustment for article.
meta
object
Additional metadata for the article. It could be any key value object.
allowed_refund
boolean
Indicates if a refund is allowed at article level.
allowed_refund
boolean
Defines who will refund the amount in case of order cancelled/returned if refund is True.
is_authenticated
boolean
Required
Defines if the user is authorized or not.
article_level_distribution
boolean
Required
Defines if the amount is distributed at the article level or not.
Payload Schema JSON
1{
2  "type": "object",
3  "description": "This event is triggered when cart price adjustment is updated",
4  "required": [
5    "company_id",
6    "contains",
7    "event",
8    "payload",
9    "application_id"
10  ],
11  "properties": {
12    "application_id": {
13      "type": [
14        "array",
15        "string"
16      ],
17      "description": "Application/sales channel ID for which this event is triggered"
18    },
19    "company_id": {
20      "type": "integer",
21      "description": "company ID for which this event is triggered"
22    },
23    "contains": {
24      "type": "array",
25      "description": "This array will have all the keys present at root level of 'payload' object",
26      "items": {
27        "type": "string"
28      }
29    },
30    "event": {
31      "type": "object",
32      "description": "This contains event data like name and type of event.",
33      "required": [
34        "category",
35        "created_timestamp",
36        "id",
37        "name",
38        "trace_id",
39        "type",
40        "version"
41      ],
42      "properties": {
43        "category": {
44          "type": "string",
45          "description": "category of the event. If it is at sales channel level or company level"
46        },
47        "created_timestamp": {
48          "type": "integer",
49          "description": "event generation timestamp in epoch milliseconds"
50        },
51        "id": {
52          "type": "string",
53          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
54        },
55        "name": {
56          "type": "string",
57          "description": "Name of the event"
58        },
59        "trace_id": {
60          "type": "array",
61          "description": "internal trace_id for Fynd Platform services",
62          "items": {
63            "type": "string"
64          }
65        },
66        "type": {
67          "type": "string",
68          "description": "Type/Action of the event. e.g. create/update/delete"
69        },
70        "version": {
71          "type": "string",
72          "description": "Version of the event."
73        }
74      }
75    },
76    "payload": {
77      "type": "object",
78      "description": "The payload data of event.",
79      "required": [
80        "article_ids",
81        "article_level_distribution",
82        "cart_id",
83        "cart_value",
84        "collection",
85        "id",
86        "is_authenticated",
87        "message",
88        "type",
89        "value"
90      ],
91      "properties": {
92        "id": {
93          "type": "string",
94          "description": "The unique identifier for the price adjustment."
95        },
96        "meta": {
97          "type": "object",
98          "description": "Additional information you want to pass on article level or cart level."
99        },
100        "type": {
101          "type": "string",
102          "description": "Defines the injection type used for charge, discount, or MOP (Mode of Payment)."
103        },
104        "value": {
105          "type": "number",
106          "description": "The amount applied on the cart."
107        },
108        "cart_id": {
109          "type": "string",
110          "description": "The cart ID on which the price adjustment is applied."
111        },
112        "message": {
113          "type": "string",
114          "description": "The message to show the text or detail regarding the discount, charge, or MOP, etc."
115        },
116        "is_active": {
117          "type": "boolean",
118          "description": "Defines if the injection is active or not."
119        },
120        "cart_value": {
121          "type": "number",
122          "description": "Defines the amount of the cart."
123        },
124        "collection": {
125          "type": "object",
126          "required": [
127            "collected_by",
128            "refund_by"
129          ],
130          "properties": {
131            "refund_by": {
132              "type": "string",
133              "description": "Defines who will refund the amount in case of order cancellation/return if allowed_refund is True."
134            },
135            "collected_by": {
136              "type": "string",
137              "description": "Defines who is collecting the amount."
138            }
139          },
140          "description": "Defines the amount collection details."
141        },
142        "article_ids": {
143          "type": "array",
144          "items": {
145            "type": "object",
146            "description": "Contains article vise data like id, code and type.",
147            "properties": {
148              "article_id": {
149                "type": "string",
150                "description": "Unique identifier for the article."
151              },
152              "code": {
153                "type": "string",
154                "description": "Code to identify price adjustment on article."
155              },
156              "type": {
157                "type": "string",
158                "description": "Type of price adjustment for the article. Valid options are: - 'discount': discount applied to the article price as promotion. - 'mop': additional mode of payment for article. - 'selling_price': additional discount in selling price of an article. - 'delivery_charge': delivery charge for an article to be added."
159              },
160              "value": {
161                "type": "number",
162                "format": "float",
163                "description": "Value of price adjustment for article."
164              },
165              "meta": {
166                "type": "object",
167                "description": "Additional metadata for the article. It could be any key value object."
168              },
169              "allowed_refund": {
170                "type": "boolean",
171                "description": "Indicates if a refund is allowed at article level."
172              }
173            }
174          },
175          "description": "Defines the list of articles you want to apply the injection to."
176        },
177        "allowed_refund": {
178          "type": "boolean",
179          "description": "Defines who will refund the amount in case of order cancelled/returned if refund is True."
180        },
181        "is_authenticated": {
182          "type": "boolean",
183          "description": "Defines if the user is authorized or not."
184        },
185        "article_level_distribution": {
186          "type": "boolean",
187          "description": "Defines if the amount is distributed at the article level or not."
188        }
189      }
190    }
191  }
192}
Payload Example
1{
2  "payload": {
3    "cart_id": "644630845625add991225b47",
4    "is_authenticated": true,
5    "article_level_distribution": true,
6    "message": "DMS CART",
7    "value": 5,
8    "collection": {
9      "collected_by": "FYND",
10      "refund_by": "FYND"
11    },
12    "meta": {},
13    "apply_expiry": "2023-06-26-12:34:00",
14    "article_ids": [
15      {
16        "code": "",
17        "article_id": "647ef550a3bba8e197b81c7d",
18        "value": 5,
19        "meta": {},
20        "type": "discount"
21      }
22    ],
23    "type": "discount",
24    "is_active": true,
25    "id": "6499383154769c889deefd28",
26    "cart_value": 100
27  },
28  "contains": [],
29  "event": {
30    "id": "testID",
31    "name": "cart-price-adjustment",
32    "type": "update",
33    "version": "1",
34    "trace_id": [
35      "6730d511bfe14cb0822f872bcf02f21e"
36    ],
37    "created_timestamp": 1686263989,
38    "category": "application"
39  },
40  "company_id": 873,
41  "application_id": "000000000000000000000001"
42}

Cart

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

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

application/cart/create/v1

this event is triggered when cart is created

Payload
Properties
application_id
array|string
Required
Application/sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
Payload details.
Properties
cart
object
Required
Cart details.
Properties
id
string
Required
Unique identifier of the cart.
comment
string
Required
Comment associated with the cart.
gstin
string|null
Required
GSTIN (Goods and Services Tax Identification Number) associated with the cart.
message
string
Required
Message related to the cart.
success
boolean
Required
Indicates whether the operation with the cart was successful or not.
is_valid
boolean
Required
Indicates whether the cart is valid or not.
last_modified
string
Required
Timestamp indicating the last modification time of the cart.
currency
object
Required
Currency details associated with the cart.
Properties
symbol
string|null
Symbol of the currency.
code
string|null
Code of the currency.
breakup_values
object
Required
Breakup values associated with the cart.
Properties
raw
object
Raw breakup values associated with the cart.
Properties
cod_charge
number
Required
Cash on Delivery charge.
convenience_fee
number
Required
Convenience fee charge.
coupon
number
Required
Coupon discount amount.
delivery_charge
number
Required
Delivery charge.
discount
number
Required
Discount amount.
fynd_cash
number
Required
Fynd Cash amount.
gst_charges
number
Required
GST (Goods and Services Tax) charges.
mop_total
number
Required
MOP (Mode of Payment) total amount.
mrp_total
number
Required
MRP (Maximum Retail Price) total amount.
subtotal
number
Required
Subtotal amount.
total
number
Required
Total amount.
total_charge
number
Required
Total charge amount.
vog
number
Required
VOG (Value of Goods) amount.
you_saved
number
Required
Amount saved.
coupon
object
Coupon details associated with the cart.
Properties
code
null|string
Coupon code applied on cart.
uid
null|string
Required
Unique identifier of the coupon.
is_applied
boolean
Required
Indicates whether the coupon is applied or not.
message
string
Required
Message associated with the coupon.
type
string
Required
Type of the coupon.
value
number
Required
Value of the coupon.
loyalty_points
object
Loyalty points details associated with the cart.
Properties
total
number|null
Total loyalty points.
description
string|null
Description of loyalty points.
is_applied
boolean|null
Indicates whether loyalty points are applied or not.
applicable
number|null
Applicable loyalty points.
display
array of object
Display details associated with the cart.
Array of Properties
attr
string
Required
Attribute of the product.
currency_code
string
Required
Currency code.
currency_symbol
string
Required
Currency symbol.
display
string
Required
Display of the product.
key
string
Required
Key of the product.
message
array of
Required
Message associated with the product.
original
number
Required
Original value of the product.
value
number
Required
Value of the product.
items
array of object
Required
Items in the cart.
Array of Properties
article
object
Article details.
Properties
extra_meta
object
Extra metadata associated with the article.
price
object
Price details associated with the article.
Properties
converted
object
Required
Converted price details.
Properties
currency_code
string
Required
Currency code for the converted price.
currency_symbol
string
Required
Currency symbol for the converted price.
effective
number
Required
Effective price after conversion.
marked
number
Required
Marked price after conversion.
base
object
Required
Base price details.
Properties
currency_code
string
Required
Currency code for the base price.
currency_symbol
string
Required
Currency symbol for the base price.
effective
number
Required
Effective base price.
marked
number
Required
Marked base price.
quantity
integer
Quantity of the article.
seller
object
Seller details associated with the article.
Properties
uid
null|integer
Required
Unique identifier of the seller.
name
null|string
Required
Name of the seller.
size
string
Size of the article.
store
object
Store details associated with the article.
Properties
uid
null|integer
Required
Unique identifier of the store.
name
null|string
Required
Name of the store.
type
string
Type of the article.
uid
string
Unique identifier of the article.
availability
object
Availability details of the article.
Properties
available_sizes
array of object
Available sizes list.
Array of Properties
display
string
Display size.
is_available
boolean
Indicates whether the size is available or not.
value
string
Value of the size.
deliverable
boolean
Indicates whether the article is deliverable or not.
is_valid
boolean
Indicates whether the article is valid or not.
other_store_quantity
integer
Quantity available in other stores.
out_of_stock
boolean
Indicates whether the article is out of stock or not.
sizes
array of string
Sizes available for the article.
bulk_offer
object
Bulk offer details associated with the article.
coupon_message
string
Coupon message associated with the article.
delivery_promise
object|null
Delivery promise details associated with the article.
Properties
formatted
object
Formatted delivery promise timestamps.
Properties
min
string
Required
Formatted minimum delivery promise timestamp.
max
string
Required
Formatted maximum delivery promise timestamp.
iso
object
ISO formatted delivery promise timestamps.
Properties
min
string
Required
ISO formatted minimum delivery promise timestamp.
max
string
Required
ISO formatted maximum delivery promise timestamp.
timestamp
object
Delivery promise timestamps.
Properties
min
integer
Required
Minimum delivery promise timestamp.
max
integer
Required
Maximum delivery promise timestamp.
discount
string
Discount associated with the article.
identifiers
object
Identifiers associated with the article.
Properties
identifier
string
Required
Identifier associated with the article.
is_set
boolean
Indicates whether the article is a set or not.
key
string
Key associated with the article.
message
string
Message associated with the article.
moq
object
Minimum order quantity details associated with the article.
Properties
minimum
integer
Minimum order quantity.
price
object
Price details associated with the article.
Properties
converted
object
Required
Converted price details.
Properties
currency_code
string
Required
Currency code for the converted price.
currency_symbol
string
Required
Currency symbol for the converted price.
effective
number
Required
Effective price after conversion.
marked
number
Required
Marked price after conversion.
add_on
number
Required
Add-on price.
selling
number
Required
Selling price.
base
object
Required
Base price details.
Properties
currency_code
string
Required
Currency code for the base price.
currency_symbol
string
Required
Currency symbol for the base price.
effective
number
Required
Effective base price.
marked
number
Required
Marked base price.
add_on
number
Required
Add-on base price.
selling
number
Required
Selling base price.
price_per_unit
object
Price per unit details associated with the article.
Properties
converted
object
Required
Converted price per unit details.
Properties
currency_code
string
Required
Currency code for the converted price per unit.
currency_symbol
string
Required
Currency symbol for the converted price per unit.
effective
number
Required
Effective price per unit after conversion.
marked
number
Required
Marked price per unit before conversion.
base
object
Required
Base price per unit details.
Properties
currency_code
string
Required
Currency code for the base price per unit.
currency_symbol
string
Required
Currency symbol for the base price per unit.
effective
number
Required
Effective base price per unit.
marked
number
Required
Marked base price per unit.
product
object
Product details associated with the article.
Properties
_custom_json
object
Required
Custom JSON associated with the product.
uid
integer
Required
Unique identifier of the product.
type
string
Required
Type of the product.
slug
string
Required
Slug of the product.
name
string
Required
Name of the product.
item_code
string
Required
Item code of the product.
images
array of object
Required
Images of the product.
Array of Properties
url
string
URL of the image.
secure_url
string
Secure URL of the image.
aspect_ratio
string
Aspect ratio of the image.
categories
array of object
Required
Categories of the product.
Array of Properties
uid
integer
Required
Unique identifier of the category.
name
string
Required
Name of the category.
brand
object
Required
Brand details associated with the product.
Properties
uid
integer
Required
Unique identifier of the brand.
name
string
Required
Name of the brand.
attributes
object
Required
Attributes associated with the product.
quantity
integer
Quantity of the article.
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "Application/sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "cart"
78      ],
79      "properties": {
80        "cart": {
81          "type": "object",
82          "required": [
83            "id",
84            "items",
85            "success",
86            "message",
87            "last_modified",
88            "is_valid",
89            "gstin",
90            "currency",
91            "comment",
92            "breakup_values"
93          ],
94          "properties": {
95            "id": {
96              "type": "string",
97              "description": "Unique identifier of the cart."
98            },
99            "comment": {
100              "type": "string",
101              "description": "Comment associated with the cart."
102            },
103            "gstin": {
104              "type": [
105                "string",
106                "null"
107              ],
108              "description": "GSTIN (Goods and Services Tax Identification Number) associated with the cart."
109            },
110            "message": {
111              "type": "string",
112              "description": "Message related to the cart."
113            },
114            "success": {
115              "type": "boolean",
116              "description": "Indicates whether the operation with the cart was successful or not."
117            },
118            "is_valid": {
119              "type": "boolean",
120              "description": "Indicates whether the cart is valid or not."
121            },
122            "last_modified": {
123              "type": "string",
124              "description": "Timestamp indicating the last modification time of the cart."
125            },
126            "currency": {
127              "type": "object",
128              "required": [],
129              "properties": {
130                "symbol": {
131                  "type": [
132                    "string",
133                    "null"
134                  ],
135                  "description": "Symbol of the currency."
136                },
137                "code": {
138                  "type": [
139                    "string",
140                    "null"
141                  ],
142                  "description": "Code of the currency."
143                }
144              },
145              "description": "Currency details associated with the cart."
146            },
147            "breakup_values": {
148              "type": "object",
149              "required": [],
150              "properties": {
151                "raw": {
152                  "type": "object",
153                  "required": [
154                    "cod_charge",
155                    "convenience_fee",
156                    "coupon",
157                    "delivery_charge",
158                    "discount",
159                    "fynd_cash",
160                    "gst_charges",
161                    "mop_total",
162                    "mrp_total",
163                    "subtotal",
164                    "total",
165                    "total_charge",
166                    "vog",
167                    "you_saved"
168                  ],
169                  "properties": {
170                    "cod_charge": {
171                      "type": [
172                        "number"
173                      ],
174                      "description": "Cash on Delivery charge."
175                    },
176                    "convenience_fee": {
177                      "type": [
178                        "number"
179                      ],
180                      "description": "Convenience fee charge."
181                    },
182                    "coupon": {
183                      "type": [
184                        "number"
185                      ],
186                      "description": "Coupon discount amount."
187                    },
188                    "delivery_charge": {
189                      "type": [
190                        "number"
191                      ],
192                      "description": "Delivery charge."
193                    },
194                    "discount": {
195                      "type": [
196                        "number"
197                      ],
198                      "description": "Discount amount."
199                    },
200                    "fynd_cash": {
201                      "type": [
202                        "number"
203                      ],
204                      "description": "Fynd Cash amount."
205                    },
206                    "gst_charges": {
207                      "type": [
208                        "number"
209                      ],
210                      "description": "GST (Goods and Services Tax) charges."
211                    },
212                    "mop_total": {
213                      "type": [
214                        "number"
215                      ],
216                      "description": "MOP (Mode of Payment) total amount."
217                    },
218                    "mrp_total": {
219                      "type": [
220                        "number"
221                      ],
222                      "description": "MRP (Maximum Retail Price) total amount."
223                    },
224                    "subtotal": {
225                      "type": [
226                        "number"
227                      ],
228                      "description": "Subtotal amount."
229                    },
230                    "total": {
231                      "type": [
232                        "number"
233                      ],
234                      "description": "Total amount."
235                    },
236                    "total_charge": {
237                      "type": [
238                        "number"
239                      ],
240                      "description": "Total charge amount."
241                    },
242                    "vog": {
243                      "type": [
244                        "number"
245                      ],
246                      "description": "VOG (Value of Goods) amount."
247                    },
248                    "you_saved": {
249                      "type": [
250                        "number"
251                      ],
252                      "description": "Amount saved."
253                    }
254                  },
255                  "description": "Raw breakup values associated with the cart."
256                },
257                "coupon": {
258                  "type": "object",
259                  "required": [
260                    "uid",
261                    "is_applied",
262                    "message",
263                    "type",
264                    "value"
265                  ],
266                  "properties": {
267                    "code": {
268                      "type": [
269                        "null",
270                        "string"
271                      ],
272                      "description": "Coupon code applied on cart."
273                    },
274                    "uid": {
275                      "type": [
276                        "null",
277                        "string"
278                      ],
279                      "description": "Unique identifier of the coupon."
280                    },
281                    "is_applied": {
282                      "type": "boolean",
283                      "description": "Indicates whether the coupon is applied or not."
284                    },
285                    "message": {
286                      "type": "string",
287                      "description": "Message associated with the coupon."
288                    },
289                    "type": {
290                      "type": "string",
291                      "description": "Type of the coupon."
292                    },
293                    "value": {
294                      "type": [
295                        "number"
296                      ],
297                      "description": "Value of the coupon."
298                    }
299                  },
300                  "description": "Coupon details associated with the cart."
301                },
302                "loyalty_points": {
303                  "type": "object",
304                  "properties": {
305                    "total": {
306                      "type": [
307                        "number",
308                        "null"
309                      ],
310                      "description": "Total loyalty points."
311                    },
312                    "description": {
313                      "type": [
314                        "string",
315                        "null"
316                      ],
317                      "description": "Description of loyalty points."
318                    },
319                    "is_applied": {
320                      "type": [
321                        "boolean",
322                        "null"
323                      ],
324                      "description": "Indicates whether loyalty points are applied or not."
325                    },
326                    "applicable": {
327                      "type": [
328                        "number",
329                        "null"
330                      ],
331                      "description": "Applicable loyalty points."
332                    }
333                  },
334                  "description": "Loyalty points details associated with the cart."
335                },
336                "display": {
337                  "type": "array",
338                  "items": {
339                    "type": "object",
340                    "required": [
341                      "attr",
342                      "currency_code",
343                      "currency_symbol",
344                      "display",
345                      "key",
346                      "message",
347                      "original",
348                      "value"
349                    ],
350                    "properties": {
351                      "attr": {
352                        "type": "string",
353                        "description": "Attribute of the product."
354                      },
355                      "currency_code": {
356                        "type": "string",
357                        "description": "Currency code."
358                      },
359                      "currency_symbol": {
360                        "type": "string",
361                        "description": "Currency symbol."
362                      },
363                      "display": {
364                        "type": "string",
365                        "description": "Display of the product."
366                      },
367                      "key": {
368                        "type": "string",
369                        "description": "Key of the product."
370                      },
371                      "message": {
372                        "type": "array",
373                        "description": "Message associated with the product."
374                      },
375                      "original": {
376                        "type": [
377                          "number"
378                        ],
379                        "description": "Original value of the product."
380                      },
381                      "value": {
382                        "type": [
383                          "number"
384                        ],
385                        "description": "Value of the product."
386                      }
387                    },
388                    "description": "Display details of the product."
389                  },
390                  "description": "Display details associated with the cart."
391                }
392              },
393              "description": "Breakup values associated with the cart."
394            },
395            "items": {
396              "type": "array",
397              "items": {
398                "type": "object",
399                "required": [],
400                "properties": {
401                  "article": {
402                    "type": "object",
403                    "required": [],
404                    "properties": {
405                      "extra_meta": {
406                        "type": "object",
407                        "required": [],
408                        "description": "Extra metadata associated with the article."
409                      },
410                      "price": {
411                        "type": "object",
412                        "required": [
413                          "converted",
414                          "base"
415                        ],
416                        "properties": {
417                          "converted": {
418                            "type": "object",
419                            "required": [
420                              "currency_code",
421                              "currency_symbol",
422                              "effective",
423                              "marked"
424                            ],
425                            "properties": {
426                              "currency_code": {
427                                "type": "string",
428                                "description": "Currency code for the converted price."
429                              },
430                              "currency_symbol": {
431                                "type": "string",
432                                "description": "Currency symbol for the converted price."
433                              },
434                              "effective": {
435                                "type": [
436                                  "number"
437                                ],
438                                "description": "Effective price after conversion."
439                              },
440                              "marked": {
441                                "type": [
442                                  "number"
443                                ],
444                                "description": "Marked price after conversion."
445                              }
446                            },
447                            "description": "Converted price details."
448                          },
449                          "base": {
450                            "type": "object",
451                            "required": [
452                              "currency_code",
453                              "currency_symbol",
454                              "effective",
455                              "marked"
456                            ],
457                            "properties": {
458                              "currency_code": {
459                                "type": "string",
460                                "description": "Currency code for the base price."
461                              },
462                              "currency_symbol": {
463                                "type": "string",
464                                "description": "Currency symbol for the base price."
465                              },
466                              "effective": {
467                                "type": [
468                                  "number"
469                                ],
470                                "description": "Effective base price."
471                              },
472                              "marked": {
473                                "type": [
474                                  "number"
475                                ],
476                                "description": "Marked base price."
477                              }
478                            },
479                            "description": "Base price details."
480                          }
481                        },
482                        "description": "Price details associated with the article."
483                      },
484                      "quantity": {
485                        "type": "integer",
486                        "description": "Quantity of the article."
487                      },
488                      "seller": {
489                        "type": "object",
490                        "required": [
491                          "uid",
492                          "name"
493                        ],
494                        "properties": {
495                          "uid": {
496                            "type": [
497                              "null",
498                              "integer"
499                            ],
500                            "description": "Unique identifier of the seller."
501                          },
502                          "name": {
503                            "type": [
504                              "null",
505                              "string"
506                            ],
507                            "description": "Name of the seller."
508                          }
509                        },
510                        "description": "Seller details associated with the article."
511                      },
512                      "size": {
513                        "type": "string",
514                        "description": "Size of the article."
515                      },
516                      "store": {
517                        "type": "object",
518                        "required": [
519                          "uid",
520                          "name"
521                        ],
522                        "properties": {
523                          "uid": {
524                            "type": [
525                              "null",
526                              "integer"
527                            ],
528                            "description": "Unique identifier of the store."
529                          },
530                          "name": {
531                            "type": [
532                              "null",
533                              "string"
534                            ],
535                            "description": "Name of the store."
536                          }
537                        },
538                        "description": "Store details associated with the article."
539                      },
540                      "type": {
541                        "type": "string",
542                        "description": "Type of the article."
543                      },
544                      "uid": {
545                        "type": "string",
546                        "description": "Unique identifier of the article."
547                      }
548                    },
549                    "description": "Article details."
550                  },
551                  "availability": {
552                    "type": "object",
553                    "required": [],
554                    "properties": {
555                      "available_sizes": {
556                        "type": "array",
557                        "items": {
558                          "type": "object",
559                          "required": [],
560                          "properties": {
561                            "display": {
562                              "type": "string",
563                              "description": "Display size."
564                            },
565                            "is_available": {
566                              "type": "boolean",
567                              "description": "Indicates whether the size is available or not."
568                            },
569                            "value": {
570                              "type": "string",
571                              "description": "Value of the size."
572                            }
573                          },
574                          "description": "Available size details."
575                        },
576                        "description": "Available sizes list."
577                      },
578                      "deliverable": {
579                        "type": "boolean",
580                        "description": "Indicates whether the article is deliverable or not."
581                      },
582                      "is_valid": {
583                        "type": "boolean",
584                        "description": "Indicates whether the article is valid or not."
585                      },
586                      "other_store_quantity": {
587                        "type": "integer",
588                        "description": "Quantity available in other stores."
589                      },
590                      "out_of_stock": {
591                        "type": "boolean",
592                        "description": "Indicates whether the article is out of stock or not."
593                      },
594                      "sizes": {
595                        "type": "array",
596                        "items": {
597                          "type": "string",
598                          "description": "Available sizes."
599                        },
600                        "description": "Sizes available for the article."
601                      }
602                    },
603                    "description": "Availability details of the article."
604                  },
605                  "bulk_offer": {
606                    "type": "object",
607                    "required": [],
608                    "description": "Bulk offer details associated with the article."
609                  },
610                  "coupon_message": {
611                    "type": "string",
612                    "description": "Coupon message associated with the article."
613                  },
614                  "delivery_promise": {
615                    "type": [
616                      "object",
617                      "null"
618                    ],
619                    "properties": {
620                      "formatted": {
621                        "type": "object",
622                        "required": [
623                          "min",
624                          "max"
625                        ],
626                        "properties": {
627                          "min": {
628                            "type": "string",
629                            "description": "Formatted minimum delivery promise timestamp."
630                          },
631                          "max": {
632                            "type": "string",
633                            "description": "Formatted maximum delivery promise timestamp."
634                          }
635                        },
636                        "description": "Formatted delivery promise timestamps."
637                      },
638                      "iso": {
639                        "type": "object",
640                        "required": [
641                          "min",
642                          "max"
643                        ],
644                        "properties": {
645                          "min": {
646                            "type": "string",
647                            "description": "ISO formatted minimum delivery promise timestamp."
648                          },
649                          "max": {
650                            "type": "string",
651                            "description": "ISO formatted maximum delivery promise timestamp."
652                          }
653                        },
654                        "description": "ISO formatted delivery promise timestamps."
655                      },
656                      "timestamp": {
657                        "type": "object",
658                        "required": [
659                          "min",
660                          "max"
661                        ],
662                        "properties": {
663                          "min": {
664                            "type": "integer",
665                            "description": "Minimum delivery promise timestamp."
666                          },
667                          "max": {
668                            "type": "integer",
669                            "description": "Maximum delivery promise timestamp."
670                          }
671                        },
672                        "description": "Delivery promise timestamps."
673                      }
674                    },
675                    "description": "Delivery promise details associated with the article."
676                  },
677                  "discount": {
678                    "type": "string",
679                    "description": "Discount associated with the article."
680                  },
681                  "identifiers": {
682                    "type": "object",
683                    "required": [
684                      "identifier"
685                    ],
686                    "properties": {
687                      "identifier": {
688                        "type": "string",
689                        "description": "Identifier associated with the article."
690                      }
691                    },
692                    "description": "Identifiers associated with the article."
693                  },
694                  "is_set": {
695                    "type": "boolean",
696                    "description": "Indicates whether the article is a set or not."
697                  },
698                  "key": {
699                    "type": "string",
700                    "description": "Key associated with the article."
701                  },
702                  "message": {
703                    "type": "string",
704                    "description": "Message associated with the article."
705                  },
706                  "moq": {
707                    "type": "object",
708                    "properties": {
709                      "minimum": {
710                        "type": "integer",
711                        "description": "Minimum order quantity."
712                      }
713                    },
714                    "description": "Minimum order quantity details associated with the article."
715                  },
716                  "price": {
717                    "type": "object",
718                    "required": [
719                      "converted",
720                      "base"
721                    ],
722                    "properties": {
723                      "converted": {
724                        "type": "object",
725                        "required": [
726                          "currency_code",
727                          "currency_symbol",
728                          "effective",
729                          "marked",
730                          "add_on",
731                          "selling"
732                        ],
733                        "properties": {
734                          "currency_code": {
735                            "type": "string",
736                            "description": "Currency code for the converted price."
737                          },
738                          "currency_symbol": {
739                            "type": "string",
740                            "description": "Currency symbol for the converted price."
741                          },
742                          "effective": {
743                            "type": [
744                              "number"
745                            ],
746                            "description": "Effective price after conversion."
747                          },
748                          "marked": {
749                            "type": [
750                              "number"
751                            ],
752                            "description": "Marked price after conversion."
753                          },
754                          "add_on": {
755                            "type": [
756                              "number"
757                            ],
758                            "description": "Add-on price."
759                          },
760                          "selling": {
761                            "type": [
762                              "number"
763                            ],
764                            "description": "Selling price."
765                          }
766                        },
767                        "description": "Converted price details."
768                      },
769                      "base": {
770                        "type": "object",
771                        "required": [
772                          "currency_code",
773                          "currency_symbol",
774                          "effective",
775                          "marked",
776                          "add_on",
777                          "selling"
778                        ],
779                        "properties": {
780                          "currency_code": {
781                            "type": "string",
782                            "description": "Currency code for the base price."
783                          },
784                          "currency_symbol": {
785                            "type": "string",
786                            "description": "Currency symbol for the base price."
787                          },
788                          "effective": {
789                            "type": [
790                              "number"
791                            ],
792                            "description": "Effective base price."
793                          },
794                          "marked": {
795                            "type": [
796                              "number"
797                            ],
798                            "description": "Marked base price."
799                          },
800                          "add_on": {
801                            "type": [
802                              "number"
803                            ],
804                            "description": "Add-on base price."
805                          },
806                          "selling": {
807                            "type": [
808                              "number"
809                            ],
810                            "description": "Selling base price."
811                          }
812                        },
813                        "description": "Base price details."
814                      }
815                    },
816                    "description": "Price details associated with the article."
817                  },
818                  "price_per_unit": {
819                    "type": "object",
820                    "required": [
821                      "converted",
822                      "base"
823                    ],
824                    "properties": {
825                      "converted": {
826                        "type": "object",
827                        "required": [
828                          "currency_code",
829                          "currency_symbol",
830                          "effective",
831                          "marked"
832                        ],
833                        "properties": {
834                          "currency_code": {
835                            "type": "string",
836                            "description": "Currency code for the converted price per unit."
837                          },
838                          "currency_symbol": {
839                            "type": "string",
840                            "description": "Currency symbol for the converted price per unit."
841                          },
842                          "effective": {
843                            "type": [
844                              "number"
845                            ],
846                            "description": "Effective price per unit after conversion."
847                          },
848                          "marked": {
849                            "type": [
850                              "number"
851                            ],
852                            "description": "Marked price per unit before conversion."
853                          }
854                        },
855                        "description": "Converted price per unit details."
856                      },
857                      "base": {
858                        "type": "object",
859                        "required": [
860                          "currency_code",
861                          "currency_symbol",
862                          "effective",
863                          "marked"
864                        ],
865                        "properties": {
866                          "currency_code": {
867                            "type": "string",
868                            "description": "Currency code for the base price per unit."
869                          },
870                          "currency_symbol": {
871                            "type": "string",
872                            "description": "Currency symbol for the base price per unit."
873                          },
874                          "effective": {
875                            "type": [
876                              "number"
877                            ],
878                            "description": "Effective base price per unit."
879                          },
880                          "marked": {
881                            "type": [
882                              "number"
883                            ],
884                            "description": "Marked base price per unit."
885                          }
886                        },
887                        "description": "Base price per unit details."
888                      }
889                    },
890                    "description": "Price per unit details associated with the article."
891                  },
892                  "product": {
893                    "type": "object",
894                    "required": [
895                      "uid",
896                      "type",
897                      "slug",
898                      "name",
899                      "item_code",
900                      "images",
901                      "categories",
902                      "brand",
903                      "attributes",
904                      "_custom_json"
905                    ],
906                    "properties": {
907                      "_custom_json": {
908                        "type": "object",
909                        "required": [],
910                        "description": "Custom JSON associated with the product."
911                      },
912                      "uid": {
913                        "type": "integer",
914                        "description": "Unique identifier of the product."
915                      },
916                      "type": {
917                        "type": "string",
918                        "description": "Type of the product."
919                      },
920                      "slug": {
921                        "type": "string",
922                        "description": "Slug of the product."
923                      },
924                      "name": {
925                        "type": "string",
926                        "description": "Name of the product."
927                      },
928                      "item_code": {
929                        "type": "string",
930                        "description": "Item code of the product."
931                      },
932                      "images": {
933                        "type": "array",
934                        "items": {
935                          "type": "object",
936                          "required": [],
937                          "properties": {
938                            "url": {
939                              "type": "string",
940                              "description": "URL of the image."
941                            },
942                            "secure_url": {
943                              "type": "string",
944                              "description": "Secure URL of the image."
945                            },
946                            "aspect_ratio": {
947                              "type": "string",
948                              "description": "Aspect ratio of the image."
949                            }
950                          },
951                          "description": "Image details associated with the product."
952                        },
953                        "description": "Images of the product."
954                      },
955                      "categories": {
956                        "type": "array",
957                        "items": {
958                          "type": "object",
959                          "required": [
960                            "uid",
961                            "name"
962                          ],
963                          "properties": {
964                            "uid": {
965                              "type": "integer",
966                              "description": "Unique identifier of the category."
967                            },
968                            "name": {
969                              "type": "string",
970                              "description": "Name of the category."
971                            }
972                          },
973                          "description": "Category details associated with the product."
974                        },
975                        "description": "Categories of the product."
976                      },
977                      "brand": {
978                        "type": "object",
979                        "required": [
980                          "uid",
981                          "name"
982                        ],
983                        "properties": {
984                          "uid": {
985                            "type": "integer",
986                            "description": "Unique identifier of the brand."
987                          },
988                          "name": {
989                            "type": "string",
990                            "description": "Name of the brand."
991                          }
992                        },
993                        "description": "Brand details associated with the product."
994                      },
995                      "attributes": {
996                        "type": "object",
997                        "required": [],
998                        "additionalProperties": true,
999                        "description": "Attributes associated with the product."
1000                      }
1001                    },
1002                    "description": "Product details associated with the article."
1003                  },
1004                  "quantity": {
1005                    "type": "integer",
1006                    "description": "Quantity of the article."
1007                  }
1008                },
1009                "description": "Item details."
1010              },
1011              "description": "Items in the cart."
1012            }
1013          },
1014          "description": "Cart details."
1015        }
1016      },
1017      "description": "Payload details."
1018    }
1019  }
1020}
Payload Example
1{
2  "application_id": "5e048673acefbaf1e8487564",
3  "company_id": 61,
4  "contains": [
5    "cart"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1711553532990,
10    "id": "9BG6eQ4zAXe/SAGqDop0JpM9L69hf3EfDiwR6ThGs0w=",
11    "name": "cart",
12    "trace_id": [
13      "megatron.6618fd18-8e13-47fc-9f0b-f7a523256dd2"
14    ],
15    "type": "create",
16    "version": "1"
17  },
18  "payload": {
19    "cart": {
20      "breakup_values": {
21        "coupon": {
22          "code": "",
23          "is_applied": false,
24          "message": "Sorry! Invalid coupon",
25          "type": "cash",
26          "uid": null,
27          "value": 0
28        },
29        "display": [
30          {
31            "attr": "mrp_total",
32            "currency_code": "INR",
33            "currency_symbol": "₹",
34            "display": "Total MRP",
35            "key": "mrp_total",
36            "message": [],
37            "original": 100000,
38            "value": 100000
39          },
40          {
41            "attr": "discount",
42            "currency_code": "INR",
43            "currency_symbol": "₹",
44            "display": "Discount",
45            "key": "discount",
46            "message": [],
47            "original": -49000,
48            "value": -49000
49          },
50          {
51            "attr": "subtotal",
52            "currency_code": "INR",
53            "currency_symbol": "₹",
54            "display": "Subtotal",
55            "key": "subtotal",
56            "message": [],
57            "original": 51000,
58            "value": 51000
59          },
60          {
61            "attr": "total",
62            "currency_code": "INR",
63            "currency_symbol": "₹",
64            "display": "Total",
65            "key": "total",
66            "message": [],
67            "original": 51000,
68            "value": 51000
69          }
70        ],
71        "loyalty_points": {
72          "applicable": 0,
73          "description": "Your cashback, reward points, and refund amount get credited to Fynd Cash which can be redeemed while placing an order.",
74          "is_applied": false,
75          "total": 0
76        },
77        "raw": {
78          "cod_charge": 0,
79          "convenience_fee": 0,
80          "coupon": 0,
81          "delivery_charge": 0,
82          "discount": -49000,
83          "fynd_cash": 0,
84          "gst_charges": 2428.57,
85          "mop_total": 0,
86          "mrp_total": 100000,
87          "subtotal": 51000,
88          "total": 51000,
89          "total_charge": 0,
90          "vog": 48571.43,
91          "you_saved": 0
92        }
93      },
94      "comment": "",
95      "currency": {
96        "code": "INR",
97        "symbol": "₹"
98      },
99      "gstin": null,
100      "id": "66043bfc2672210c3f06a751",
101      "is_valid": true,
102      "items": [
103        {
104          "article": {
105            "extra_meta": {},
106            "price": {
107              "base": {
108                "currency_code": "INR",
109                "currency_symbol": "₹",
110                "effective": 51000,
111                "marked": 100000
112              },
113              "converted": {
114                "currency_code": "INR",
115                "currency_symbol": "₹",
116                "effective": 51000,
117                "marked": 100000
118              }
119            },
120            "quantity": 100000,
121            "seller": {
122              "name": "FUCHSIA VINE DESIGNS PRIVATE LIMITED",
123              "uid": 61
124            },
125            "size": "OS",
126            "store": {
127              "name": "Serviceability-Mumbai-HS-DC",
128              "uid": 15411
129            },
130            "type": "article",
131            "uid": "66043b1a2d266371f7af51d6"
132          },
133          "availability": {
134            "available_sizes": [
135              {
136                "display": "OS",
137                "is_available": true,
138                "value": "OS"
139              }
140            ],
141            "deliverable": true,
142            "is_valid": true,
143            "other_store_quantity": 1,
144            "out_of_stock": false,
145            "sizes": [
146              "OS"
147            ]
148          },
149          "bulk_offer": {},
150          "coupon_message": "",
151          "delivery_promise": {
152            "formatted": {
153              "max": "Mon, 22 Apr",
154              "min": "Sun, 21 Apr"
155            },
156            "iso": {
157              "max": "2024-04-22T15:32:12Z",
158              "min": "2024-04-21T19:32:12Z"
159            },
160            "timestamp": {
161              "max": 1713799932,
162              "min": 1713727932
163            }
164          },
165          "discount": "49% OFF",
166          "identifiers": {
167            "identifier": "qsHUV5EMQHyY62CGbK9Iw"
168          },
169          "is_set": false,
170          "key": "10198730_OS",
171          "message": "",
172          "moq": {
173            "minimum": 1
174          },
175          "price": {
176            "base": {
177              "add_on": 51000,
178              "currency_code": "INR",
179              "currency_symbol": "₹",
180              "effective": 51000,
181              "marked": 100000,
182              "selling": 51000
183            },
184            "converted": {
185              "add_on": 51000,
186              "currency_code": "INR",
187              "currency_symbol": "₹",
188              "effective": 51000,
189              "marked": 100000,
190              "selling": 51000
191            }
192          },
193          "price_per_unit": {
194            "base": {
195              "currency_code": "INR",
196              "currency_symbol": "₹",
197              "effective": 51000,
198              "marked": 100000
199            },
200            "converted": {
201              "currency_code": "INR",
202              "currency_symbol": "₹",
203              "effective": 51000,
204              "marked": 100000
205            }
206          },
207          "product": {
208            "_custom_json": {},
209            "attributes": {
210              "brand_name": "Guess Global",
211              "essential": "Yes",
212              "gender": [
213                "Girls"
214              ],
215              "marketer-address": "dcdscv",
216              "marketer-name": "sdvsdv",
217              "name": "Test DP EWAY BILL",
218              "net-quantity": "1 N",
219              "primary_color": "Red",
220              "primary_color_hex": "D0021B"
221            },
222            "brand": {
223              "name": "Guess Global",
224              "uid": 7894
225            },
226            "categories": [
227              {
228                "name": "Baby Bath Nets",
229                "uid": 2845
230              }
231            ],
232            "images": [
233              {
234                "aspect_ratio": "16:25",
235                "secure_url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/knk_NJWO7-cn54690625.jpg",
236                "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/knk_NJWO7-cn54690625.jpg"
237              }
238            ],
239            "item_code": "SDCKNKJNJSDV",
240            "name": "Test DP EWAY BILL",
241            "slug": "test-dp-eway-bill-10198730",
242            "type": "product",
243            "uid": 10198730
244          },
245          "quantity": 1
246        }
247      ],
248      "last_modified": "Wed, 27 Mar 2024 15:32:12 GMT",
249      "message": "",
250      "success": true
251    }
252  }
253}

application/cart/update/v1

this event is triggered when cart is updated

Payload
Properties
application_id
array|string
Required
Application/sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
cart
object
Required
Properties
id
string
Required
Unique ID of the cart.
comment
string
Required
Comment associated with the cart.
gstin
string|null
Required
GSTIN associated with the cart.
message
string
Required
Message associated with the cart.
success
boolean
Required
Indicates whether the cart operation was successful or not.
is_valid
boolean
Required
Indicates whether the cart is valid or not.
last_modified
string
Required
Date and time when the cart was last modified.
currency
object
Required
Currency details associated with the cart.
Properties
symbol
string|null
Currency symbol associated with the cart.
code
string|null
Currency code associated with the cart.
breakup_values
object
Required
Properties
raw
object
Raw values associated with the cart.
Properties
cod_charge
number
Required
COD charge associated with the cart.
convenience_fee
number
Required
Convenience fee associated with the cart.
coupon
number
Required
Coupon associated with the cart.
delivery_charge
number
Required
Delivery charge associated with the cart.
discount
number
Required
Discount associated with the cart.
fynd_cash
number
Required
Fynd cash associated with the cart.
gst_charges
number
Required
GST charges associated with the cart.
mop_total
number
Required
MOP total associated with the cart.
mrp_total
number
Required
MRP total associated with the cart.
subtotal
number
Required
Subtotal associated with the cart.
total
number
Required
Total amount associated with the cart.
total_charge
number
Required
Total charge associated with the cart.
vog
number
Required
VOG associated with the cart.
you_saved
number
Required
Amount saved in the cart.
coupon
object
Coupon details associated with the cart.
Properties
code
null|string
Coupon code applied on cart.
uid
null|integer
Required
Unique identifier of the coupon.
is_applied
boolean
Required
Indicates whether the coupon is applied or not.
message
string
Required
Message associated with the coupon.
type
string
Required
Type of the coupon.
value
number
Required
Value of the coupon.
loyalty_points
object
Loyalty points associated with the cart.
Properties
total
number|null
Total loyalty points associated with the cart.
description
string|null
Description of loyalty points.
is_applied
boolean|null
Indicates whether loyalty points are applied or not.
applicable
number|null
Applicable loyalty points.
display
array of object
Array of Properties
attr
string
Required
Attribute associated with the display item.
currency_code
string
Required
Currency code associated with the display item.
currency_symbol
string
Required
Currency symbol associated with the display item.
display
string
Required
Display value.
key
string
Required
Key associated with the display item.
message
array of
Required
Message associated with the display item.
original
number
Required
Original value.
value
number
Required
items
array of object
Required
Array of Properties
article
object
Properties
extra_meta
object
price
object
Properties
converted
object
Required
Properties
currency_code
string
Required
currency_symbol
string
Required
effective
number
Required
marked
number
Required
base
object
Required
Properties
currency_code
string
Required
currency_symbol
string
Required
effective
number
Required
marked
number
Required
quantity
integer
seller
object
Properties
uid
null|integer
Required
name
null|string
Required
size
string
store
object
Properties
uid
null|integer
Required
name
null|string
Required
type
string
uid
string
availability
object
Properties
available_sizes
array of object
Array of Properties
display
string
is_available
boolean
value
string
deliverable
boolean
is_valid
boolean
other_store_quantity
integer
out_of_stock
boolean
sizes
array of string
bulk_offer
object
coupon_message
string
delivery_promise
object|null
Properties
formatted
object
Properties
min
string
Required
max
string
Required
iso
object
Properties
min
string
Required
max
string
Required
timestamp
object
Properties
min
integer
Required
max
integer
Required
discount
string
identifiers
object
Properties
identifier
string
Required
is_set
boolean
key
string
message
string
moq
object
Properties
minimum
integer
maximum
integer
increment_unit
integer
price
object
Properties
converted
object
Required
Properties
currency_code
string
Required
currency_symbol
string
Required
effective
number
Required
marked
number
Required
add_on
number
Required
selling
number
Required
base
object
Required
Properties
currency_code
string
Required
currency_symbol
string
Required
effective
number
Required
marked
number
Required
add_on
number
Required
selling
number
Required
price_per_unit
object
Properties
converted
object
Required
Properties
currency_code
string
Required
currency_symbol
string
Required
effective
number
Required
marked
number
Required
base
object
Required
Properties
currency_code
string
Required
currency_symbol
string
Required
effective
number
Required
marked
number
Required
product
object
Properties
_custom_json
object
Required
uid
integer
Required
type
string
Required
slug
string
Required
name
string
Required
item_code
string
Required
images
array of object
Required
Array of Properties
url
string
secure_url
string
aspect_ratio
string
categories
array of object
Required
Array of Properties
uid
integer
Required
name
string
Required
brand
object
Required
Properties
uid
integer
Required
name
string
Required
attributes
object
Required
quantity
integer
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "Application/sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "cart"
78      ],
79      "properties": {
80        "cart": {
81          "type": "object",
82          "required": [
83            "id",
84            "items",
85            "success",
86            "message",
87            "last_modified",
88            "is_valid",
89            "gstin",
90            "currency",
91            "comment",
92            "breakup_values"
93          ],
94          "properties": {
95            "id": {
96              "type": "string",
97              "description": "Unique ID of the cart."
98            },
99            "comment": {
100              "type": "string",
101              "description": "Comment associated with the cart."
102            },
103            "gstin": {
104              "type": [
105                "string",
106                "null"
107              ],
108              "description": "GSTIN associated with the cart."
109            },
110            "message": {
111              "type": "string",
112              "description": "Message associated with the cart."
113            },
114            "success": {
115              "type": "boolean",
116              "description": "Indicates whether the cart operation was successful or not."
117            },
118            "is_valid": {
119              "type": "boolean",
120              "description": "Indicates whether the cart is valid or not."
121            },
122            "last_modified": {
123              "type": "string",
124              "description": "Date and time when the cart was last modified."
125            },
126            "currency": {
127              "type": "object",
128              "required": [],
129              "properties": {
130                "symbol": {
131                  "type": [
132                    "string",
133                    "null"
134                  ],
135                  "description": "Currency symbol associated with the cart."
136                },
137                "code": {
138                  "type": [
139                    "string",
140                    "null"
141                  ],
142                  "description": "Currency code associated with the cart."
143                }
144              },
145              "description": "Currency details associated with the cart."
146            },
147            "breakup_values": {
148              "type": "object",
149              "required": [],
150              "properties": {
151                "raw": {
152                  "type": "object",
153                  "required": [
154                    "cod_charge",
155                    "convenience_fee",
156                    "coupon",
157                    "delivery_charge",
158                    "discount",
159                    "fynd_cash",
160                    "gst_charges",
161                    "mop_total",
162                    "mrp_total",
163                    "subtotal",
164                    "total",
165                    "total_charge",
166                    "vog",
167                    "you_saved"
168                  ],
169                  "properties": {
170                    "cod_charge": {
171                      "type": [
172                        "number"
173                      ],
174                      "description": "COD charge associated with the cart."
175                    },
176                    "convenience_fee": {
177                      "type": [
178                        "number"
179                      ],
180                      "description": "Convenience fee associated with the cart."
181                    },
182                    "coupon": {
183                      "type": [
184                        "number"
185                      ],
186                      "description": "Coupon associated with the cart."
187                    },
188                    "delivery_charge": {
189                      "type": [
190                        "number"
191                      ],
192                      "description": "Delivery charge associated with the cart."
193                    },
194                    "discount": {
195                      "type": [
196                        "number"
197                      ],
198                      "description": "Discount associated with the cart."
199                    },
200                    "fynd_cash": {
201                      "type": [
202                        "number"
203                      ],
204                      "description": "Fynd cash associated with the cart."
205                    },
206                    "gst_charges": {
207                      "type": [
208                        "number"
209                      ],
210                      "description": "GST charges associated with the cart."
211                    },
212                    "mop_total": {
213                      "type": [
214                        "number"
215                      ],
216                      "description": "MOP total associated with the cart."
217                    },
218                    "mrp_total": {
219                      "type": [
220                        "number"
221                      ],
222                      "description": "MRP total associated with the cart."
223                    },
224                    "subtotal": {
225                      "type": [
226                        "number"
227                      ],
228                      "description": "Subtotal associated with the cart."
229                    },
230                    "total": {
231                      "type": [
232                        "number"
233                      ],
234                      "description": "Total amount associated with the cart."
235                    },
236                    "total_charge": {
237                      "type": [
238                        "number"
239                      ],
240                      "description": "Total charge associated with the cart."
241                    },
242                    "vog": {
243                      "type": [
244                        "number"
245                      ],
246                      "description": "VOG associated with the cart."
247                    },
248                    "you_saved": {
249                      "type": [
250                        "number"
251                      ],
252                      "description": "Amount saved in the cart."
253                    }
254                  },
255                  "description": "Raw values associated with the cart."
256                },
257                "coupon": {
258                  "type": "object",
259                  "required": [
260                    "uid",
261                    "is_applied",
262                    "message",
263                    "type",
264                    "value"
265                  ],
266                  "properties": {
267                    "code": {
268                      "type": [
269                        "null",
270                        "string"
271                      ],
272                      "description": "Coupon code applied on cart."
273                    },
274                    "uid": {
275                      "type": [
276                        "null",
277                        "integer"
278                      ],
279                      "description": "Unique identifier of the coupon."
280                    },
281                    "is_applied": {
282                      "type": "boolean",
283                      "description": "Indicates whether the coupon is applied or not."
284                    },
285                    "message": {
286                      "type": "string",
287                      "description": "Message associated with the coupon."
288                    },
289                    "type": {
290                      "type": "string",
291                      "description": "Type of the coupon."
292                    },
293                    "value": {
294                      "type": [
295                        "number"
296                      ],
297                      "description": "Value of the coupon."
298                    }
299                  },
300                  "description": "Coupon details associated with the cart."
301                },
302                "loyalty_points": {
303                  "type": "object",
304                  "properties": {
305                    "total": {
306                      "type": [
307                        "number",
308                        "null"
309                      ],
310                      "description": "Total loyalty points associated with the cart."
311                    },
312                    "description": {
313                      "type": [
314                        "string",
315                        "null"
316                      ],
317                      "description": "Description of loyalty points."
318                    },
319                    "is_applied": {
320                      "type": [
321                        "boolean",
322                        "null"
323                      ],
324                      "description": "Indicates whether loyalty points are applied or not."
325                    },
326                    "applicable": {
327                      "type": [
328                        "number",
329                        "null"
330                      ],
331                      "description": "Applicable loyalty points."
332                    }
333                  },
334                  "description": "Loyalty points associated with the cart."
335                },
336                "display": {
337                  "type": "array",
338                  "items": {
339                    "type": "object",
340                    "required": [
341                      "attr",
342                      "currency_code",
343                      "currency_symbol",
344                      "display",
345                      "key",
346                      "message",
347                      "original",
348                      "value"
349                    ],
350                    "properties": {
351                      "attr": {
352                        "type": "string",
353                        "description": "Attribute associated with the display item."
354                      },
355                      "currency_code": {
356                        "type": "string",
357                        "description": "Currency code associated with the display item."
358                      },
359                      "currency_symbol": {
360                        "type": "string",
361                        "description": "Currency symbol associated with the display item."
362                      },
363                      "display": {
364                        "type": "string",
365                        "description": "Display value."
366                      },
367                      "key": {
368                        "type": "string",
369                        "description": "Key associated with the display item."
370                      },
371                      "message": {
372                        "type": "array",
373                        "description": "Message associated with the display item."
374                      },
375                      "original": {
376                        "type": [
377                          "number"
378                        ],
379                        "description": "Original value."
380                      },
381                      "value": {
382                        "type": [
383                          "number"
384                        ]
385                      }
386                    }
387                  }
388                }
389              }
390            },
391            "items": {
392              "type": "array",
393              "items": {
394                "type": "object",
395                "required": [],
396                "properties": {
397                  "article": {
398                    "type": "object",
399                    "required": [],
400                    "properties": {
401                      "extra_meta": {
402                        "type": "object",
403                        "required": []
404                      },
405                      "price": {
406                        "type": "object",
407                        "required": [
408                          "converted",
409                          "base"
410                        ],
411                        "properties": {
412                          "converted": {
413                            "type": "object",
414                            "required": [
415                              "currency_code",
416                              "currency_symbol",
417                              "effective",
418                              "marked"
419                            ],
420                            "properties": {
421                              "currency_code": {
422                                "type": "string"
423                              },
424                              "currency_symbol": {
425                                "type": "string"
426                              },
427                              "effective": {
428                                "type": [
429                                  "number"
430                                ]
431                              },
432                              "marked": {
433                                "type": [
434                                  "number"
435                                ]
436                              }
437                            }
438                          },
439                          "base": {
440                            "type": "object",
441                            "required": [
442                              "currency_code",
443                              "currency_symbol",
444                              "effective",
445                              "marked"
446                            ],
447                            "properties": {
448                              "currency_code": {
449                                "type": "string"
450                              },
451                              "currency_symbol": {
452                                "type": "string"
453                              },
454                              "effective": {
455                                "type": [
456                                  "number"
457                                ]
458                              },
459                              "marked": {
460                                "type": [
461                                  "number"
462                                ]
463                              }
464                            }
465                          }
466                        }
467                      },
468                      "quantity": {
469                        "type": "integer"
470                      },
471                      "seller": {
472                        "type": "object",
473                        "required": [
474                          "uid",
475                          "name"
476                        ],
477                        "properties": {
478                          "uid": {
479                            "type": [
480                              "null",
481                              "integer"
482                            ]
483                          },
484                          "name": {
485                            "type": [
486                              "null",
487                              "string"
488                            ]
489                          }
490                        }
491                      },
492                      "size": {
493                        "type": "string"
494                      },
495                      "store": {
496                        "type": "object",
497                        "required": [
498                          "uid",
499                          "name"
500                        ],
501                        "properties": {
502                          "uid": {
503                            "type": [
504                              "null",
505                              "integer"
506                            ]
507                          },
508                          "name": {
509                            "type": [
510                              "null",
511                              "string"
512                            ]
513                          }
514                        }
515                      },
516                      "type": {
517                        "type": "string"
518                      },
519                      "uid": {
520                        "type": "string"
521                      }
522                    }
523                  },
524                  "availability": {
525                    "type": "object",
526                    "required": [],
527                    "properties": {
528                      "available_sizes": {
529                        "type": "array",
530                        "items": {
531                          "type": "object",
532                          "required": [],
533                          "properties": {
534                            "display": {
535                              "type": "string"
536                            },
537                            "is_available": {
538                              "type": "boolean"
539                            },
540                            "value": {
541                              "type": "string"
542                            }
543                          }
544                        }
545                      },
546                      "deliverable": {
547                        "type": "boolean"
548                      },
549                      "is_valid": {
550                        "type": "boolean"
551                      },
552                      "other_store_quantity": {
553                        "type": "integer"
554                      },
555                      "out_of_stock": {
556                        "type": "boolean"
557                      },
558                      "sizes": {
559                        "type": "array",
560                        "items": {
561                          "type": "string"
562                        }
563                      }
564                    }
565                  },
566                  "bulk_offer": {
567                    "type": "object",
568                    "required": []
569                  },
570                  "coupon_message": {
571                    "type": "string"
572                  },
573                  "delivery_promise": {
574                    "type": [
575                      "object",
576                      "null"
577                    ],
578                    "properties": {
579                      "formatted": {
580                        "type": "object",
581                        "required": [
582                          "min",
583                          "max"
584                        ],
585                        "properties": {
586                          "min": {
587                            "type": "string"
588                          },
589                          "max": {
590                            "type": "string"
591                          }
592                        }
593                      },
594                      "iso": {
595                        "type": "object",
596                        "required": [
597                          "min",
598                          "max"
599                        ],
600                        "properties": {
601                          "min": {
602                            "type": "string"
603                          },
604                          "max": {
605                            "type": "string"
606                          }
607                        }
608                      },
609                      "timestamp": {
610                        "type": "object",
611                        "required": [
612                          "min",
613                          "max"
614                        ],
615                        "properties": {
616                          "min": {
617                            "type": "integer"
618                          },
619                          "max": {
620                            "type": "integer"
621                          }
622                        }
623                      }
624                    }
625                  },
626                  "discount": {
627                    "type": "string"
628                  },
629                  "identifiers": {
630                    "type": "object",
631                    "required": [
632                      "identifier"
633                    ],
634                    "properties": {
635                      "identifier": {
636                        "type": "string"
637                      }
638                    }
639                  },
640                  "is_set": {
641                    "type": "boolean"
642                  },
643                  "key": {
644                    "type": "string"
645                  },
646                  "message": {
647                    "type": "string"
648                  },
649                  "moq": {
650                    "type": "object",
651                    "properties": {
652                      "minimum": {
653                        "type": "integer"
654                      },
655                      "maximum": {
656                        "type": "integer"
657                      },
658                      "increment_unit": {
659                        "type": "integer"
660                      }
661                    }
662                  },
663                  "price": {
664                    "type": "object",
665                    "required": [
666                      "converted",
667                      "base"
668                    ],
669                    "properties": {
670                      "converted": {
671                        "type": "object",
672                        "required": [
673                          "currency_code",
674                          "currency_symbol",
675                          "effective",
676                          "marked",
677                          "add_on",
678                          "selling"
679                        ],
680                        "properties": {
681                          "currency_code": {
682                            "type": "string"
683                          },
684                          "currency_symbol": {
685                            "type": "string"
686                          },
687                          "effective": {
688                            "type": [
689                              "number"
690                            ]
691                          },
692                          "marked": {
693                            "type": [
694                              "number"
695                            ]
696                          },
697                          "add_on": {
698                            "type": [
699                              "number"
700                            ]
701                          },
702                          "selling": {
703                            "type": [
704                              "number"
705                            ]
706                          }
707                        }
708                      },
709                      "base": {
710                        "type": "object",
711                        "required": [
712                          "currency_code",
713                          "currency_symbol",
714                          "effective",
715                          "marked",
716                          "add_on",
717                          "selling"
718                        ],
719                        "properties": {
720                          "currency_code": {
721                            "type": "string"
722                          },
723                          "currency_symbol": {
724                            "type": "string"
725                          },
726                          "effective": {
727                            "type": [
728                              "number"
729                            ]
730                          },
731                          "marked": {
732                            "type": [
733                              "number"
734                            ]
735                          },
736                          "add_on": {
737                            "type": [
738                              "number"
739                            ]
740                          },
741                          "selling": {
742                            "type": [
743                              "number"
744                            ]
745                          }
746                        }
747                      }
748                    }
749                  },
750                  "price_per_unit": {
751                    "type": "object",
752                    "required": [
753                      "converted",
754                      "base"
755                    ],
756                    "properties": {
757                      "converted": {
758                        "type": "object",
759                        "required": [
760                          "currency_code",
761                          "currency_symbol",
762                          "effective",
763                          "marked"
764                        ],
765                        "properties": {
766                          "currency_code": {
767                            "type": "string"
768                          },
769                          "currency_symbol": {
770                            "type": "string"
771                          },
772                          "effective": {
773                            "type": [
774                              "number"
775                            ]
776                          },
777                          "marked": {
778                            "type": [
779                              "number"
780                            ]
781                          }
782                        }
783                      },
784                      "base": {
785                        "type": "object",
786                        "required": [
787                          "currency_code",
788                          "currency_symbol",
789                          "effective",
790                          "marked"
791                        ],
792                        "properties": {
793                          "currency_code": {
794                            "type": "string"
795                          },
796                          "currency_symbol": {
797                            "type": "string"
798                          },
799                          "effective": {
800                            "type": [
801                              "number"
802                            ]
803                          },
804                          "marked": {
805                            "type": [
806                              "number"
807                            ]
808                          }
809                        }
810                      }
811                    }
812                  },
813                  "product": {
814                    "type": "object",
815                    "required": [
816                      "uid",
817                      "type",
818                      "slug",
819                      "name",
820                      "item_code",
821                      "images",
822                      "categories",
823                      "brand",
824                      "attributes",
825                      "_custom_json"
826                    ],
827                    "properties": {
828                      "_custom_json": {
829                        "type": "object",
830                        "additionalProperties": true,
831                        "required": []
832                      },
833                      "uid": {
834                        "type": "integer"
835                      },
836                      "type": {
837                        "type": "string"
838                      },
839                      "slug": {
840                        "type": "string"
841                      },
842                      "name": {
843                        "type": "string"
844                      },
845                      "item_code": {
846                        "type": "string"
847                      },
848                      "images": {
849                        "type": "array",
850                        "items": {
851                          "type": "object",
852                          "required": [],
853                          "properties": {
854                            "url": {
855                              "type": "string"
856                            },
857                            "secure_url": {
858                              "type": "string"
859                            },
860                            "aspect_ratio": {
861                              "type": "string"
862                            }
863                          }
864                        }
865                      },
866                      "categories": {
867                        "type": "array",
868                        "items": {
869                          "type": "object",
870                          "required": [
871                            "uid",
872                            "name"
873                          ],
874                          "properties": {
875                            "uid": {
876                              "type": "integer"
877                            },
878                            "name": {
879                              "type": "string"
880                            }
881                          }
882                        }
883                      },
884                      "brand": {
885                        "type": "object",
886                        "required": [
887                          "uid",
888                          "name"
889                        ],
890                        "properties": {
891                          "uid": {
892                            "type": "integer"
893                          },
894                          "name": {
895                            "type": "string"
896                          }
897                        }
898                      },
899                      "attributes": {
900                        "type": "object",
901                        "additionalProperties": true,
902                        "required": []
903                      }
904                    }
905                  },
906                  "quantity": {
907                    "type": "integer"
908                  }
909                }
910              }
911            }
912          }
913        }
914      }
915    }
916  }
917}
Payload Example
1{
2  "application_id": "6523fa5f41f4eb4c10a1d869",
3  "company_id": 5842,
4  "contains": [
5    "cart"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1712143356504,
10    "id": "/4T+BrIIL7L0QQ2GFdH3eSeg966q3BPKGTvI4Quig6E=",
11    "name": "cart",
12    "trace_id": [
13      "megatron.65a224d1-b379-47ae-9480-ac5b421cb56f"
14    ],
15    "type": "update",
16    "version": "1"
17  },
18  "payload": {
19    "cart": {
20      "breakup_values": {
21        "coupon": {
22          "code": "",
23          "is_applied": false,
24          "message": "",
25          "type": "cash",
26          "uid": null,
27          "value": 0
28        },
29        "display": [],
30        "loyalty_points": {
31          "applicable": null,
32          "description": null,
33          "is_applied": null,
34          "total": null
35        },
36        "raw": {
37          "cod_charge": 0,
38          "convenience_fee": 0,
39          "coupon": 0,
40          "delivery_charge": 0,
41          "discount": 0,
42          "fynd_cash": 0,
43          "gst_charges": 0,
44          "mop_total": 0,
45          "mrp_total": 0,
46          "subtotal": 0,
47          "total": 0,
48          "total_charge": 0,
49          "vog": 0,
50          "you_saved": 0
51        }
52      },
53      "comment": "",
54      "currency": {
55        "code": "INR",
56        "symbol": "₹"
57      },
58      "gstin": null,
59      "id": "65cef8fc2bff52f3d41fdc76",
60      "is_valid": false,
61      "items": [],
62      "last_modified": "Wed, 03 Apr 2024 11:22:36 GMT",
63      "message": "No items in cart",
64      "success": false
65    }
66  }
67}

Collection

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

Events
application/collection/create/v2
# this event is triggered when collection is created
application/collection/delete/v2
# this event is triggered when collection is deleted
application/collection/update/v2
# this event is triggered when collection is updated

application/collection/create/v2

this event is triggered when collection is created

Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
collection
object
Required
Collection Data is stored in this object
Properties
seo
object
SEO details for the collection, with a title and description.
Properties
title
string
The title for SEO of the collection.
description
string
The description for SEO of the collection.
cron
object
logo
object
Logo image for the collection.
Properties
url
string
The URL of the image for the collection's logo.
aspect_ratio
string
The aspect ratio of the image for the collection's logo.
meta
object
Additional metadata for the collection.
name
string
Name of the collection.
slug
string
Unique identifier for the collection.
tags
array of string
List of tags associated with the collection.
type
string
Type of the collection, e.g. 'editorial' or 'product'.
badge
object
Badge for the collection, with a color and text.
Properties
text
string
The text of the badge for the collection.
color
string
The color of the badge for the collection.
query
array of object
Filter queries for the collection.
Array of Properties
op
string
Required
Enum
value
array of string,number
Required
attribute
string
Required
action
object
Action associated with the collection.
Properties
page
object
Page associated with the action of the collection.
Properties
type
string
Type of page associated with the action of the collection.
query
object
Query associated with the page action of the collection.
type
string
Type of action associated with the collection.
app_id
string
ID of the app the collection belongs to.
banners
object
Banner images for the collection, with a portrait and landscape version.
Properties
portrait
object
Required
The portrait image of the collection banner.
Properties
url
string
The URL of the portrait image of the collection banner.
aspect_ratio
string
The aspect ratio of the portrait image of the collection banner.
landscape
object
Required
The landscape image of the collection banner.
Properties
url
string
The URL of the landscape image of the collection banner.
aspect_ratio
string
The aspect ratio of the landscape image of the collection banner.
sort_on
string
The default sort order for the collection, e.g. 'popular'.
priority
integer
Priority of the collection, used for sorting.
_schedule
object
Schedule for the collection.
Properties
end
string
The end time of the job for the collection.
cron
string
The cron expression for the schedule of the collection.
start
string
The start time of the job for the collection.
duration
integer
The duration of the job in seconds for the collection.
next_schedule
array of object
The next schedule for the job of the collection.
Array of Properties
end
string|null
start
string
is_active
boolean
Whether the collection is currently active.
allow_sort
boolean
Whether sorting is allowed for the collection.
is_visible
boolean
Whether the collection is visible or not.
description
string
Description of the collection.
_custom_json
object
Custom JSON data for the collection.
allow_facets
boolean
Whether facets are allowed for the collection.
_locale_language
object
Locale language for the collection.
visible_facets_keys
array of string
List of keys for visible facets in the collection.
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "collection"
78      ],
79      "properties": {
80        "collection": {
81          "type": "object",
82          "properties": {
83            "seo": {
84              "type": "object",
85              "description": "SEO details for the collection, with a title and description.",
86              "properties": {
87                "title": {
88                  "type": "string",
89                  "description": "The title for SEO of the collection."
90                },
91                "description": {
92                  "type": "string",
93                  "description": "The description for SEO of the collection."
94                }
95              }
96            },
97            "cron": {
98              "type": "object",
99              "description": ""
100            },
101            "logo": {
102              "type": "object",
103              "properties": {
104                "url": {
105                  "type": "string",
106                  "description": "The URL of the image for the collection's logo."
107                },
108                "aspect_ratio": {
109                  "type": "string",
110                  "description": "The aspect ratio of the image for the collection's logo."
111                }
112              },
113              "description": "Logo image for the collection."
114            },
115            "meta": {
116              "type": "object",
117              "description": "Additional metadata for the collection."
118            },
119            "name": {
120              "type": "string",
121              "description": "Name of the collection."
122            },
123            "slug": {
124              "type": "string",
125              "description": "Unique identifier for the collection."
126            },
127            "tags": {
128              "type": "array",
129              "items": {
130                "type": "string"
131              },
132              "description": "List of tags associated with the collection."
133            },
134            "type": {
135              "type": "string",
136              "description": "Type of the collection, e.g. 'editorial' or 'product'."
137            },
138            "badge": {
139              "type": "object",
140              "properties": {
141                "text": {
142                  "type": "string",
143                  "description": "The text of the badge for the collection."
144                },
145                "color": {
146                  "type": "string",
147                  "description": "The color of the badge for the collection."
148                }
149              },
150              "description": "Badge for the collection, with a color and text."
151            },
152            "query": {
153              "type": "array",
154              "items": {
155                "type": "object",
156                "required": [
157                  "attribute",
158                  "op",
159                  "value"
160                ],
161                "properties": {
162                  "op": {
163                    "enum": [
164                      "in",
165                      "nin",
166                      "gt",
167                      "gte",
168                      "lt",
169                      "lte",
170                      "btw"
171                    ],
172                    "type": "string"
173                  },
174                  "value": {
175                    "type": "array",
176                    "items": {
177                      "type": [
178                        "string",
179                        "number"
180                      ]
181                    }
182                  },
183                  "attribute": {
184                    "type": "string"
185                  }
186                }
187              },
188              "description": "Filter queries for the collection."
189            },
190            "action": {
191              "type": "object",
192              "properties": {
193                "page": {
194                  "type": "object",
195                  "properties": {
196                    "type": {
197                      "type": "string",
198                      "description": "Type of page associated with the action of the collection."
199                    },
200                    "query": {
201                      "type": "object",
202                      "description": "Query associated with the page action of the collection."
203                    }
204                  },
205                  "description": "Page associated with the action of the collection."
206                },
207                "type": {
208                  "type": "string",
209                  "description": "Type of action associated with the collection."
210                }
211              },
212              "description": "Action associated with the collection."
213            },
214            "app_id": {
215              "type": "string",
216              "description": "ID of the app the collection belongs to."
217            },
218            "banners": {
219              "type": "object",
220              "required": [
221                "landscape",
222                "portrait"
223              ],
224              "properties": {
225                "portrait": {
226                  "type": "object",
227                  "properties": {
228                    "url": {
229                      "type": "string",
230                      "description": "The URL of the portrait image of the collection banner."
231                    },
232                    "aspect_ratio": {
233                      "type": "string",
234                      "description": "The aspect ratio of the portrait image of the collection banner."
235                    }
236                  },
237                  "description": "The portrait image of the collection banner."
238                },
239                "landscape": {
240                  "type": "object",
241                  "properties": {
242                    "url": {
243                      "type": "string",
244                      "description": "The URL of the landscape image of the collection banner."
245                    },
246                    "aspect_ratio": {
247                      "type": "string",
248                      "description": "The aspect ratio of the landscape image of the collection banner."
249                    }
250                  },
251                  "description": "The landscape image of the collection banner."
252                }
253              },
254              "description": "Banner images for the collection, with a portrait and landscape version."
255            },
256            "sort_on": {
257              "type": "string",
258              "description": "The default sort order for the collection, e.g. 'popular'."
259            },
260            "priority": {
261              "type": "integer",
262              "description": "Priority of the collection, used for sorting."
263            },
264            "_schedule": {
265              "type": "object",
266              "properties": {
267                "end": {
268                  "type": "string",
269                  "description": "The end time of the job for the collection."
270                },
271                "cron": {
272                  "type": "string",
273                  "description": "The cron expression for the schedule of the collection."
274                },
275                "start": {
276                  "type": "string",
277                  "description": "The start time of the job for the collection."
278                },
279                "duration": {
280                  "type": "integer",
281                  "description": "The duration of the job in seconds for the collection."
282                },
283                "next_schedule": {
284                  "type": "array",
285                  "items": {
286                    "type": "object",
287                    "properties": {
288                      "end": {
289                        "type": [
290                          "string",
291                          "null"
292                        ]
293                      },
294                      "start": {
295                        "type": "string"
296                      }
297                    }
298                  },
299                  "description": "The next schedule for the job of the collection."
300                }
301              },
302              "description": "Schedule for the collection."
303            },
304            "is_active": {
305              "type": "boolean",
306              "description": "Whether the collection is currently active."
307            },
308            "allow_sort": {
309              "type": "boolean",
310              "description": "Whether sorting is allowed for the collection."
311            },
312            "is_visible": {
313              "type": "boolean",
314              "description": "Whether the collection is visible or not."
315            },
316            "description": {
317              "type": "string",
318              "description": "Description of the collection."
319            },
320            "_custom_json": {
321              "type": "object",
322              "description": "Custom JSON data for the collection."
323            },
324            "allow_facets": {
325              "type": "boolean",
326              "description": "Whether facets are allowed for the collection."
327            },
328            "_locale_language": {
329              "type": "object",
330              "description": "Locale language for the collection."
331            },
332            "visible_facets_keys": {
333              "type": "array",
334              "items": {
335                "type": "string"
336              },
337              "description": "List of keys for visible facets in the collection."
338            }
339          },
340          "description": "Collection Data is stored in this object"
341        }
342      }
343    }
344  }
345}
Payload Example
1{
2  "application_id": "6523fa5f41f4eb4c10a1d869",
3  "company_id": 5842,
4  "contains": [
5    "collection"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1708644940476,
10    "id": "gFx0LWac2FBTIAmnrwlX05p0cDVbAc02TU46sTOepIQ=",
11    "name": "collection",
12    "trace_id": [
13      "silverbolt.16bfae2e-d1db-11ee-ae64-b66edc95121c"
14    ],
15    "type": "create",
16    "version": "2"
17  },
18  "payload": {
19    "collection": {
20      "_custom_json": {},
21      "_locale_language": {},
22      "_schedule": {
23        "start": "2024-02-22T23:35:33.878Z"
24      },
25      "action": {
26        "page": {
27          "query": {
28            "collection": [
29              "popular-everywhere"
30            ]
31          },
32          "type": "collection"
33        },
34        "type": "page"
35      },
36      "allow_facets": true,
37      "allow_sort": true,
38      "app_id": "6523fa5f41f4eb4c10a1d869",
39      "badge": {
40        "color": "#ffffff",
41        "text": ""
42      },
43      "banners": {
44        "landscape": {
45          "type": "image",
46          "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"
47        },
48        "portrait": {
49          "type": "image",
50          "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"
51        }
52      },
53      "description": "",
54      "is_active": true,
55      "is_visible": false,
56      "logo": {
57        "type": "image",
58        "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"
59      },
60      "meta": {},
61      "name": "Popular on Google",
62      "priority": 9999,
63      "published": true,
64      "query": [],
65      "seo": {
66        "breadcrumbs": [
67          {}
68        ],
69        "description": "",
70        "meta_tags": [],
71        "sitemap": {
72          "frequency": "never",
73          "priority": 0.5
74        },
75        "title": "Popular on Google"
76      },
77      "slug": "popular-everywhere",
78      "sort_on": "depth_desc",
79      "tags": [],
80      "type": "items",
81      "uid": "65d7da4c3ad8b4f55d9547e7",
82      "visible_facets_keys": []
83    }
84  }
85}

application/collection/delete/v2

this event is triggered when collection is deleted

Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
collection
object
Required
Collection Data is stored in this object
Properties
id
string
Required
ID of the collection.
app_id
string
Required
ID of the app the collection belongs to.
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "collection"
78      ],
79      "properties": {
80        "collection": {
81          "type": "object",
82          "required": [
83            "id",
84            "app_id"
85          ],
86          "properties": {
87            "id": {
88              "type": "string",
89              "description": "ID of the collection."
90            },
91            "app_id": {
92              "type": "string",
93              "description": "ID of the app the collection belongs to."
94            }
95          },
96          "description": "Collection Data is stored in this object"
97        }
98      }
99    }
100  }
101}
Payload Example
1{
2  "application_id": "5d63686df2a4f7806b76bb32",
3  "company_id": 61,
4  "contains": [
5    "collection"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1712150505804,
10    "id": "X5g4+7nnniqZFu8z7goRW8V1JkJX35f6pOxbsEQTSmI=",
11    "name": "collection",
12    "trace_id": [
13      "silverbolt.1e828ddc-f1bd-11ee-8193-26f8b25d5ea6"
14    ],
15    "type": "delete",
16    "version": "2"
17  },
18  "payload": {
19    "collection": {
20      "app_id": "5d63686df2a4f7806b76bb32",
21      "id": "660d565cf796d12bd720a7ae"
22    }
23  }
24}

application/collection/update/v2

this event is triggered when collection is updated

Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
collection
object
Required
Collection Data is stored in this object
Properties
slug
string
Unique identifier for the collection.
meta
object
Additional metadata for the collection.
_custom_json
object
Custom JSON data for the collection.
_locale_language
object
Locale language for the collection.
seo
object
SEO details for the collection, with a title and description.
Properties
title
string
The title for SEO of the collection.
description
string
The description for SEO of the collection.
app_id
string
ID of the app the collection belongs to.
sort_on
string
The default sort order for the collection, e.g. 'popular'.
is_visible
boolean
Whether the collection is visible or not.
_schedule
object
Schedule for the collection.
Properties
cron
string
The cron expression for the schedule of the collection.
next_schedule
array of object
The next schedule for the job of the collection.
Array of Properties
start
string
end
string|null
duration
integer
The duration of the job in seconds for the collection.
start
string
The start time of the job for the collection.
end
string
The end time of the job for the collection.
priority
integer
Priority of the collection, used for sorting.
visible_facets_keys
array of string
List of keys for visible facets in the collection.
badge
object
Badge for the collection, with a color and text.
Properties
color
string
The color of the badge for the collection.
text
string
The text of the badge for the collection.
banners
object
Banner images for the collection, with a portrait and landscape version.
Properties
landscape
object
Required
The landscape image of the collection banner.
Properties
aspect_ratio
string
The aspect ratio of the landscape image of the collection banner.
url
string
The URL of the landscape image of the collection banner.
portrait
object
Required
The portrait image of the collection banner.
Properties
aspect_ratio
string
The aspect ratio of the portrait image of the collection banner.
url
string
The URL of the portrait image of the collection banner.
type
string
Type of the collection, e.g. 'editorial' or 'product'.
is_active
boolean
Whether the collection is currently active.
cron
object
allow_sort
boolean
Whether sorting is allowed for the collection.
name
string
Name of the collection.
tags
array of string
List of tags associated with the collection.
allow_facets
boolean
Whether facets are allowed for the collection.
description
string
Description of the collection.
query
array of object
Filter queries for the collection.
Array of Properties
value
array of string,number
Required
attribute
string
Required
op
string
Required
Enum
logo
object
Logo image for the collection.
Properties
aspect_ratio
string
The aspect ratio of the image for the collection's logo.
url
string
The URL of the image for the collection's logo.
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "collection"
78      ],
79      "properties": {
80        "collection": {
81          "type": "object",
82          "properties": {
83            "slug": {
84              "type": "string",
85              "description": "Unique identifier for the collection."
86            },
87            "meta": {
88              "type": "object",
89              "description": "Additional metadata for the collection."
90            },
91            "_custom_json": {
92              "type": "object",
93              "description": "Custom JSON data for the collection."
94            },
95            "_locale_language": {
96              "type": "object",
97              "description": "Locale language for the collection."
98            },
99            "seo": {
100              "type": "object",
101              "properties": {
102                "title": {
103                  "type": "string",
104                  "description": "The title for SEO of the collection."
105                },
106                "description": {
107                  "type": "string",
108                  "description": "The description for SEO of the collection."
109                }
110              },
111              "description": "SEO details for the collection, with a title and description."
112            },
113            "app_id": {
114              "type": "string",
115              "description": "ID of the app the collection belongs to."
116            },
117            "sort_on": {
118              "type": "string",
119              "description": "The default sort order for the collection, e.g. 'popular'."
120            },
121            "is_visible": {
122              "type": "boolean",
123              "description": "Whether the collection is visible or not."
124            },
125            "_schedule": {
126              "type": "object",
127              "required": [],
128              "properties": {
129                "cron": {
130                  "type": "string",
131                  "description": "The cron expression for the schedule of the collection."
132                },
133                "next_schedule": {
134                  "type": "array",
135                  "items": {
136                    "type": "object",
137                    "properties": {
138                      "start": {
139                        "type": "string"
140                      },
141                      "end": {
142                        "type": [
143                          "string",
144                          "null"
145                        ]
146                      }
147                    }
148                  },
149                  "description": "The next schedule for the job of the collection."
150                },
151                "duration": {
152                  "type": "integer",
153                  "description": "The duration of the job in seconds for the collection."
154                },
155                "start": {
156                  "type": "string",
157                  "description": "The start time of the job for the collection."
158                },
159                "end": {
160                  "type": "string",
161                  "description": "The end time of the job for the collection."
162                }
163              },
164              "description": "Schedule for the collection."
165            },
166            "priority": {
167              "type": "integer",
168              "description": "Priority of the collection, used for sorting."
169            },
170            "visible_facets_keys": {
171              "type": "array",
172              "items": {
173                "type": "string"
174              },
175              "description": "List of keys for visible facets in the collection."
176            },
177            "badge": {
178              "type": "object",
179              "required": [],
180              "properties": {
181                "color": {
182                  "type": "string",
183                  "description": "The color of the badge for the collection."
184                },
185                "text": {
186                  "type": "string",
187                  "description": "The text of the badge for the collection."
188                }
189              },
190              "description": "Badge for the collection, with a color and text."
191            },
192            "banners": {
193              "type": "object",
194              "required": [
195                "landscape",
196                "portrait"
197              ],
198              "properties": {
199                "landscape": {
200                  "type": "object",
201                  "properties": {
202                    "aspect_ratio": {
203                      "type": "string",
204                      "description": "The aspect ratio of the landscape image of the collection banner."
205                    },
206                    "url": {
207                      "type": "string",
208                      "description": "The URL of the landscape image of the collection banner."
209                    }
210                  },
211                  "description": "The landscape image of the collection banner."
212                },
213                "portrait": {
214                  "type": "object",
215                  "properties": {
216                    "aspect_ratio": {
217                      "type": "string",
218                      "description": "The aspect ratio of the portrait image of the collection banner."
219                    },
220                    "url": {
221                      "type": "string",
222                      "description": "The URL of the portrait image of the collection banner."
223                    }
224                  },
225                  "description": "The portrait image of the collection banner."
226                }
227              },
228              "description": "Banner images for the collection, with a portrait and landscape version."
229            },
230            "type": {
231              "type": "string",
232              "description": "Type of the collection, e.g. 'editorial' or 'product'."
233            },
234            "is_active": {
235              "type": "boolean",
236              "description": "Whether the collection is currently active."
237            },
238            "cron": {
239              "type": "object",
240              "description": ""
241            },
242            "allow_sort": {
243              "type": "boolean",
244              "description": "Whether sorting is allowed for the collection."
245            },
246            "name": {
247              "type": "string",
248              "description": "Name of the collection."
249            },
250            "tags": {
251              "type": "array",
252              "items": {
253                "type": "string"
254              },
255              "description": "List of tags associated with the collection."
256            },
257            "allow_facets": {
258              "type": "boolean",
259              "description": "Whether facets are allowed for the collection."
260            },
261            "description": {
262              "type": "string",
263              "description": "Description of the collection."
264            },
265            "query": {
266              "type": "array",
267              "items": {
268                "type": "object",
269                "properties": {
270                  "value": {
271                    "type": "array",
272                    "items": {
273                      "type": [
274                        "string",
275                        "number"
276                      ]
277                    }
278                  },
279                  "attribute": {
280                    "type": "string"
281                  },
282                  "op": {
283                    "type": "string",
284                    "enum": [
285                      "in",
286                      "nin",
287                      "gt",
288                      "gte",
289                      "lt",
290                      "lte",
291                      "btw"
292                    ]
293                  }
294                },
295                "required": [
296                  "attribute",
297                  "op",
298                  "value"
299                ]
300              },
301              "description": "Filter queries for the collection."
302            },
303            "logo": {
304              "type": "object",
305              "properties": {
306                "aspect_ratio": {
307                  "type": "string",
308                  "description": "The aspect ratio of the image for the collection's logo."
309                },
310                "url": {
311                  "type": "string",
312                  "description": "The URL of the image for the collection's logo."
313                }
314              },
315              "description": "Logo image for the collection."
316            }
317          },
318          "description": "Collection Data is stored in this object"
319        }
320      }
321    }
322  }
323}
Payload Example
1{
2  "application_id": "65004d091d693d03a2d75948",
3  "company_id": 4204,
4  "contains": [
5    "collection"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1709553888371,
10    "id": "zYKMq0Ns4qHGfl/QauHdYTuyGRx3mHW+A/1WwKivntc=",
11    "name": "collection",
12    "trace_id": [
13      "silverbolt.65e9a274-da1f-11ee-8d18-a6bef371a5fd"
14    ],
15    "type": "update",
16    "version": "2"
17  },
18  "payload": {
19    "collection": {
20      "_custom_json": {},
21      "_locale_language": {},
22      "_schedule": {
23        "end": "9998-01-30T23:59:00",
24        "next_schedule": [
25          {
26            "end": "9998-01-30T23:59:00",
27            "start": "2023-10-03T23:40:10.464000"
28          }
29        ],
30        "start": "2023-10-03T23:40:10.464000"
31      },
32      "allow_facets": true,
33      "allow_sort": true,
34      "app_id": "65004d091d693d03a2d75948",
35      "badge": {
36        "color": "#ffffff",
37        "text": ""
38      },
39      "banners": {
40        "landscape": {
41          "type": "image",
42          "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"
43        },
44        "portrait": {
45          "type": "image",
46          "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"
47        }
48      },
49      "description": "",
50      "is_active": true,
51      "is_visible": true,
52      "logo": {
53        "type": "image",
54        "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"
55      },
56      "meta": {},
57      "name": "Occasions",
58      "priority": 97,
59      "published": true,
60      "query": [
61        {
62          "attribute": "custom-attribute-5",
63          "op": "in",
64          "value": [
65            "Brunches",
66            "Destination Wedding",
67            "Evening Enchantments",
68            "Everyday Luxe",
69            "Festive Glamour",
70            "Print Parade",
71            "Resort Rendezvous",
72            "Signature Classics"
73          ]
74        }
75      ],
76      "seo": {
77        "breadcrumbs": [
78          {}
79        ],
80        "description": "Nothing but the best for you. Handpicked from an ethereal collection of designer-wear to suit your exact taste.",
81        "meta_tags": [],
82        "sitemap": {
83          "frequency": "never",
84          "priority": 0.5
85        },
86        "title": "Dress for the Occassion | Gulabo by Abu Sandeep"
87      },
88      "slug": "occasions",
89      "sort_on": "popular",
90      "tags": [],
91      "type": "query",
92      "uid": "651ca80077451e1b22a144c2",
93      "visible_facets_keys": []
94    }
95  }
96}

Configuration

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

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

application/configuration/create/v1

this event is triggered when configuration is created

Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
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
The payload containing various configuration settings.
Properties
app
string
Required
The app associated with the payload.
business
string
Required
The business associated with the payload.
inventory
object
The inventory settings.
Properties
company_id
integer
The ID of the company associated with the inventory.
out_of_stock
boolean
Indicates whether items are out of stock.
franchise_enabled
boolean
Indicates whether franchise operations are enabled.
brand
object
The brand settings.
Properties
criteria
string
Required
The criteria for selecting brands.
brands
array of integer
An array of brand IDs.
store
object
The store settings.
Properties
criteria
string
Required
The criteria for selecting stores.
rules
array of object
An array of rules.
Array of Properties
companies
array of integer
An array of company IDs.
brands
array of integer
An array of brand IDs.
stores
array of integer
An array of store IDs.
image
array of string
An array of image URLs.
only_verified_products
boolean
Indicates whether only verified products are included.
category
object
The category settings.
Properties
criteria
string
The criteria for selecting categories.
categories
array of integer
An array of category IDs.
exclude_category
array of integer
An array of category IDs to be excluded.
price
object
The price range settings.
Properties
min
integer
Required
The minimum value of the price range.
max
integer
Required
The maximum value of the price range.
discount
object
The discount settings.
Properties
min
integer
Required
The minimum value of the discount range.
max
integer
Required
The maximum value of the discount range.
company_store
array of integer
An array of company store IDs.
search
object
Configuration settings for search functionality within the application.
Properties
fst_identification
object
Configuration settings for search query interpretation using the GPT model to deliver more relevant results within the application.
Properties
enabled
boolean
Indicates whether search query interpretation is enabled for the application.
Default Value : false
query_suggestions
object
Configuration settings for query suggestions powered by the GPT model using the current live catalog within the application.
Properties
enabled
boolean
Indicates whether to enable or disable query suggestions powered by the GPT model using the current live catalog within the application.
Default Value : false
max_limit
integer
Specifies the maximum number of query suggestions that can be returned.
authentication
object
The authentication settings.
Properties
required
boolean
Indicates whether authentication is required.
provider
string
The authentication provider.
article_assignment
object
The article assignment settings.
Properties
post_order_reassignment
boolean
Indicates whether post-order reassignment is enabled.
enforced_stores
array of integer
An array of enforced store IDs.
rules
object
The rules for article assignment.
Properties
store_priority
object
The priority settings for stores.
Properties
enabled
boolean
Indicates whether store priority is enabled.
storetype_order
array of string
An array of store types in order of priority.
reward_points
object
The reward points settings.
Properties
credit
object
The credit settings.
Properties
enabled
boolean
Indicates whether credit is enabled.
debit
object
The debit settings.
Properties
enabled
boolean
Indicates whether debit is enabled.
auto_apply
boolean
Indicates whether reward points are auto-applied.
strategy_channel
string
The strategy channel for reward points.
cart
object
The cart settings.
Properties
delivery_charges
object
The delivery charges settings.
Properties
enabled
boolean
Indicates whether delivery charges are enabled.
charges
array of object
An array of charge objects.
Array of Properties
threshold
integer
The threshold value.
charges
integer
The charge value.
international_delivery_charges
object
The international delivery charges settings.
Properties
enabled
boolean
Indicates whether international delivery charges are enabled.
charges
array of object
An array of charge arrays.
Array of Properties
threshold
integer
The threshold value.
charges
integer
The charge value.
pan_card
object
The PAN card settings.
Properties
enabled
boolean
Indicates whether PAN card is enabled.
cod_threshold_amount
integer
The COD threshold amount.
online_threshold_amount
integer
The online threshold amount.
enabled
boolean
Indicates whether the cart is enabled.
max_cart_items
integer
The maximum number of items allowed in the cart.
min_cart_value
integer
The minimum cart value allowed.
bulk_coupons
boolean
Indicates whether bulk coupons are enabled.
revenue_engine_coupon
boolean
Indicates whether revenue engine coupon is enabled.
empty_cart
boolean
Indicates whether empty cart is enabled.
payment
object
The payment settings.
Properties
mode_of_payment
string
Required
The mode of payment.
source
string
Required
The payment source.
enabled
boolean
Indicates whether the payment method is enabled.
callback_url
object
The callback URL settings.
Properties
app
string
The callback URL for the app.
web
string
The callback URL for the web.
cod_amount_limit
integer
The COD amount limit.
cod_charges
integer
The COD charges.
anonymous_cod
boolean
Indicates whether anonymous COD is enabled.
user_cod_limit
integer
The user COD limit.
methods
object
The payment methods settings.
Properties
pl
object
The PL payment method settings.
Properties
enabled
boolean
Indicates whether the PL payment method is enabled.
card
object
The card payment method settings.
Properties
enabled
boolean
Indicates whether the card payment method is enabled.
nb
object
The NB payment method settings.
Properties
enabled
boolean
Indicates whether the NB payment method is enabled.
wl
object
The WL payment method settings.
Properties
enabled
boolean
Indicates whether the WL payment method is enabled.
ps
object
The PS payment method settings.
Properties
enabled
boolean
Indicates whether the PS payment method is enabled.
upi
object
The UPI payment method settings.
Properties
enabled
boolean
Indicates whether the UPI payment method is enabled.
qr
object
The QR payment method settings.
Properties
enabled
boolean
Indicates whether the QR payment method is enabled.
cod
object
The COD payment method settings.
Properties
enabled
boolean
Indicates whether the COD payment method is enabled.
pp
object
The PP payment method settings.
Properties
enabled
boolean
Indicates whether the PP payment method is enabled.
jp
object
The JP payment method settings.
Properties
enabled
boolean
Indicates whether the JP payment method is enabled.
pac
object
The PAC payment method settings.
Properties
enabled
boolean
Indicates whether the PAC payment method is enabled.
fc
object
The FC payment method settings.
Properties
enabled
boolean
Indicates whether the FC payment method is enabled.
jiopp
object
The JIOPP payment method settings.
Properties
enabled
boolean
Indicates whether the JIOPP payment method is enabled.
stripepg
object
The StripePG payment method settings.
Properties
enabled
boolean
Indicates whether the StripePG payment method is enabled.
juspaypg
object
The JuspayPG payment method settings.
Properties
enabled
boolean
Indicates whether the JuspayPG payment method is enabled.
payubizpg
object
The PayubizPG payment method settings.
Properties
enabled
boolean
Indicates whether the PayubizPG payment method is enabled.
payumoneypg
object
The PayumoneyPG payment method settings.
Properties
enabled
boolean
Indicates whether the PayumoneyPG payment method is enabled.
rupifipg
object
The RupifiPG payment method settings.
Properties
enabled
boolean
Indicates whether the RupifiPG payment method is enabled.
simpl
object
The Simpl payment method settings.
Properties
enabled
boolean
Indicates whether the Simpl payment method is enabled.
payment_selection_lock
object
The payment selection lock settings.
Properties
enabled
boolean
Indicates whether payment selection lock is enabled.
default_options
string
The default payment options.
payment_identifier
string
The payment identifier.
order
object
The order settings.
Properties
enabled
boolean
Indicates whether orders are enabled.
force_reassignment
boolean
Indicates whether force reassignment is enabled.
message
string
The order message.
comms_enabled
boolean
Indicates whether communications are enabled.
communication
object
The communication settings.
Properties
email
object
The email settings.
Properties
enabled
boolean
Indicates whether email communication is enabled.
sms
object
The SMS settings.
Properties
enabled
boolean
Indicates whether SMS communication is enabled.
voice
object
The voice settings.
Properties
enabled
boolean
Indicates whether voice communication is enabled.
platforms
array of string
An array of platform types.
logistics
object
The logistics settings.
Properties
logistics_by_seller
boolean
Indicates whether logistics are managed by the seller.
serviceability_check
boolean
Indicates whether serviceability check is enabled.
same_day_delivery
boolean
Indicates whether same day delivery is enabled.
dp_assignment
boolean
Indicates whether DP assignment is enabled.
pii_masking
object
The PII masking settings.
Properties
enabled
boolean
Indicates whether PII masking is enabled.
tags
array of string
An array of tags.
_id
string
Required
The ID of the payload.
modified_by
string
The user who last modified the payload.
created_at
string
The creation date of the payload.
modified_at
string
The last modification date of the payload.
__v
integer
The version number of the payload.
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "description": "The payload containing various configuration settings.",
77      "properties": {
78        "app": {
79          "type": "string",
80          "description": "The app associated with the payload."
81        },
82        "business": {
83          "type": "string",
84          "description": "The business associated with the payload."
85        },
86        "inventory": {
87          "type": "object",
88          "description": "The inventory settings.",
89          "properties": {
90            "company_id": {
91              "type": "integer",
92              "description": "The ID of the company associated with the inventory."
93            },
94            "out_of_stock": {
95              "type": "boolean",
96              "description": "Indicates whether items are out of stock."
97            },
98            "franchise_enabled": {
99              "type": "boolean",
100              "description": "Indicates whether franchise operations are enabled."
101            },
102            "brand": {
103              "type": "object",
104              "description": "The brand settings.",
105              "properties": {
106                "criteria": {
107                  "type": "string",
108                  "description": "The criteria for selecting brands."
109                },
110                "brands": {
111                  "type": "array",
112                  "description": "An array of brand IDs.",
113                  "items": {
114                    "type": "integer",
115                    "description": "The ID of a brand."
116                  }
117                }
118              },
119              "required": [
120                "criteria"
121              ]
122            },
123            "store": {
124              "type": "object",
125              "description": "The store settings.",
126              "properties": {
127                "criteria": {
128                  "type": "string",
129                  "description": "The criteria for selecting stores."
130                },
131                "rules": {
132                  "type": "array",
133                  "description": "An array of rules.",
134                  "items": {
135                    "type": "object",
136                    "description": "A rule object.",
137                    "properties": {
138                      "companies": {
139                        "type": "array",
140                        "description": "An array of company IDs.",
141                        "items": {
142                          "type": "integer",
143                          "description": "The ID of a company."
144                        }
145                      },
146                      "brands": {
147                        "type": "array",
148                        "description": "An array of brand IDs.",
149                        "items": {
150                          "type": "integer",
151                          "description": "The ID of a brand."
152                        }
153                      }
154                    }
155                  }
156                },
157                "stores": {
158                  "type": "array",
159                  "description": "An array of store IDs.",
160                  "items": {
161                    "type": "integer",
162                    "description": "The ID of a store."
163                  }
164                }
165              },
166              "required": [
167                "criteria"
168              ]
169            },
170            "image": {
171              "type": "array",
172              "description": "An array of image URLs.",
173              "items": {
174                "type": "string",
175                "description": "The URL of an image."
176              }
177            },
178            "only_verified_products": {
179              "type": "boolean",
180              "description": "Indicates whether only verified products are included."
181            },
182            "category": {
183              "type": "object",
184              "description": "The category settings.",
185              "properties": {
186                "criteria": {
187                  "type": "string",
188                  "description": "The criteria for selecting categories."
189                },
190                "categories": {
191                  "description": "An array of category IDs.",
192                  "type": "array",
193                  "items": {
194                    "type": "integer",
195                    "description": "The ID of a category."
196                  }
197                }
198              }
199            },
200            "exclude_category": {
201              "description": "An array of category IDs to be excluded.",
202              "type": "array",
203              "items": {
204                "type": "integer",
205                "description": "The ID of a category."
206              }
207            },
208            "price": {
209              "type": "object",
210              "description": "The price range settings.",
211              "properties": {
212                "min": {
213                  "type": "integer",
214                  "description": "The minimum value of the price range."
215                },
216                "max": {
217                  "type": "integer",
218                  "description": "The maximum value of the price range."
219                }
220              },
221              "required": [
222                "min",
223                "max"
224              ]
225            },
226            "discount": {
227              "type": "object",
228              "description": "The discount settings.",
229              "properties": {
230                "min": {
231                  "type": "integer",
232                  "description": "The minimum value of the discount range."
233                },
234                "max": {
235                  "type": "integer",
236                  "description": "The maximum value of the discount range."
237                }
238              },
239              "required": [
240                "min",
241                "max"
242              ]
243            },
244            "company_store": {
245              "type": "array",
246              "description": "An array of company store IDs.",
247              "items": {
248                "type": "integer",
249                "description": "The ID of a company store."
250              }
251            }
252          }
253        },
254        "search": {
255          "type": "object",
256          "description": "Configuration settings for search functionality within the application.",
257          "properties": {
258            "fst_identification": {
259              "type": "object",
260              "description": "Configuration settings for search query interpretation using the GPT model to deliver more relevant results within the application.",
261              "properties": {
262                "enabled": {
263                  "type": "boolean",
264                  "default": false,
265                  "description": "Indicates whether search query interpretation is enabled for the application."
266                }
267              }
268            },
269            "query_suggestions": {
270              "type": "object",
271              "description": "Configuration settings for query suggestions powered by the GPT model using the current live catalog within the application.",
272              "properties": {
273                "enabled": {
274                  "type": "boolean",
275                  "default": false,
276                  "description": "Indicates whether to enable or disable query suggestions powered by the GPT model using the current live catalog within the application."
277                },
278                "max_limit": {
279                  "type": "integer",
280                  "description": "Specifies the maximum number of query suggestions that can be returned."
281                }
282              }
283            }
284          }
285        },
286        "authentication": {
287          "type": "object",
288          "description": "The authentication settings.",
289          "properties": {
290            "required": {
291              "type": "boolean",
292              "description": "Indicates whether authentication is required."
293            },
294            "provider": {
295              "type": "string",
296              "description": "The authentication provider."
297            }
298          }
299        },
300        "article_assignment": {
301          "type": "object",
302          "description": "The article assignment settings.",
303          "properties": {
304            "post_order_reassignment": {
305              "type": "boolean",
306              "description": "Indicates whether post-order reassignment is enabled."
307            },
308            "enforced_stores": {
309              "type": "array",
310              "description": "An array of enforced store IDs.",
311              "items": {
312                "type": "integer",
313                "description": "The ID of an enforced store."
314              }
315            },
316            "rules": {
317              "type": "object",
318              "description": "The rules for article assignment.",
319              "properties": {
320                "store_priority": {
321                  "type": "object",
322                  "description": "The priority settings for stores.",
323                  "properties": {
324                    "enabled": {
325                      "type": "boolean",
326                      "description": "Indicates whether store priority is enabled."
327                    },
328                    "storetype_order": {
329                      "type": "array",
330                      "description": "An array of store types in order of priority.",
331                      "items": {
332                        "type": "string",
333                        "description": "The type of a store."
334                      }
335                    }
336                  }
337                }
338              }
339            }
340          }
341        },
342        "reward_points": {
343          "type": "object",
344          "description": "The reward points settings.",
345          "properties": {
346            "credit": {
347              "type": "object",
348              "description": "The credit settings.",
349              "properties": {
350                "enabled": {
351                  "type": "boolean",
352                  "description": "Indicates whether credit is enabled."
353                }
354              }
355            },
356            "debit": {
357              "type": "object",
358              "description": "The debit settings.",
359              "properties": {
360                "enabled": {
361                  "type": "boolean",
362                  "description": "Indicates whether debit is enabled."
363                },
364                "auto_apply": {
365                  "type": "boolean",
366                  "description": "Indicates whether reward points are auto-applied."
367                },
368                "strategy_channel": {
369                  "type": "string",
370                  "description": "The strategy channel for reward points."
371                }
372              }
373            }
374          }
375        },
376        "cart": {
377          "type": "object",
378          "description": "The cart settings.",
379          "properties": {
380            "delivery_charges": {
381              "type": "object",
382              "description": "The delivery charges settings.",
383              "properties": {
384                "enabled": {
385                  "type": "boolean",
386                  "description": "Indicates whether delivery charges are enabled."
387                },
388                "charges": {
389                  "type": "array",
390                  "description": "An array of charge objects.",
391                  "items": {
392                    "type": "object",
393                    "description": "A charge object.",
394                    "properties": {
395                      "threshold": {
396                        "type": "integer",
397                        "description": "The threshold value."
398                      },
399                      "charges": {
400                        "type": "integer",
401                        "description": "The charge value."
402                      }
403                    }
404                  }
405                }
406              }
407            },
408            "international_delivery_charges": {
409              "type": "object",
410              "description"